1.\" Copyright (c) 2012 Ron McDowell 2.\" Copyright (c) 2012-2013 Devin Teske 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 16.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 17.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 18.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 19.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 20.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 22.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 23.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 24.\" POSSIBILITY OF SUCH DAMAGE. 25.\" 26.\" docsinstall 27.\" password 28.\" diskmgmt 29.\" usermgmt 30.\" useradd 31.\" useredit 32.\" userdel 33.\" groupmgmt 34.\" groupadd 35.\" groupedit 36.\" groupdel 37.\" console 38.\" syscons_font 39.\" syscons_keymap 40.\" syscons_repeat 41.\" syscons_saver 42.\" syscons_screenmap 43.\" syscons_ttys 44.\" timezone 45.\" mouse 46.\" mouse_enable 47.\" mouse_type 48.\" mouse_port 49.\" mouse_flags 50.\" mouse_disable 51.\" networking 52.\" defaultrouter 53.\" hostname 54.\" nameservers 55.\" netdev 56.\" security 57.\" ttys 58.\" [dot] 59.\" 60.\" $FreeBSD$ 61.\" 62.Dd Jun 5, 2013 63.Dt BSDCONFIG 8 64.Os 65.Sh NAME 66.Nm bsdconfig 67.Nd system configuration utility 68.Sh SYNOPSIS 69.Nm 70.Op Fl h 71.Nm 72.Ar command 73.Op Fl h 74.Nm 75.Op OPTIONS 76.Op command Op OPTIONS 77.Sh DESCRIPTION 78.Nm 79is used to set up many system configuration settings, both for new systems, as 80well as changing configuration settings of existing systems. 81.Pp 82.Nm 83optionally takes a command as an argument. 84If invoked with no arguments, it will bring up an interactive menu listing the 85available modules. 86.Pp 87The following options are available: 88.Bl -tag -width indent+ 89.It Fl d 90Provide lots of debugging info on standard-out when running. 91.It Fl D Ar file 92Send debugging info to file. 93If file begins with a plus-sign debug info is sent to both standard-out and 94file (minus the leading plus). 95.It Fl f Ar file 96Load 97.Ar file 98as script and then exit. 99If multiple occurrences, program will only exit after last occurrence. 100If 101.Ar file 102is a single dash 103.Pq Sq Fl , 104.Nm 105reads from standard input. 106.It Fl h 107Print usage statement and exit. 108.It Fl S 109Secure X11 mode 110.Pq implies Fl X . 111As root, always prompt-for and validate 112.Xr sudo 8 113username/password before starting. 114.It Fl X 115Use 116.Xr Xdialog 1 117in place of 118.Xr dialog 1 . 119.El 120.Sh COMMANDS 121The following commands 122.Pq sorted alphabetically 123are currently included in the base 124.Nm 125program, with more to be added soon. 126Other commands can be added, as detailed below in the 127.Cm ADDING COMMANDS 128section, and once added, will appear in the master menu as well as in the 129.Cm -h 130listing. 131.Bl -tag -width ".Cm syscons_screenmap" 132.It Cm console 133Utilities to customize the behavior of the system console. 134.It Cm defaultrouter 135Shortcut to the Default Router/Gateway menu under networking. 136.It Cm diskmgmt 137Manage disk partitions and/or labels. 138Executes 139.Xr sade 8 . 140.It Cm docsinstall 141Executes the 142.Cm bsdinstall docsinstall 143sub-utility to allow installation/re-installation of the FreeBSD Documentation 144set(s). 145.It Cm dot 146Generate a graphviz 147.Xr dot 1 148language file 149.Pq printed on stdout 150visualizing the 151.Nm 152menu, include, and shortcut structure relationships. 153See 154.Dq bsdconfig dot -h 155for more details. 156.It Cm groupadd 157Shortcut to the Add Groups menu under groupmgmt. 158.It Cm groupdel 159Shortcut to the Delete Groups menu under groupmgmt. 160.It Cm groupedit 161Shortcut to the Edit/View Groups menu under groupmgmt. 162.It Cm groupmgmt 163Utilities to Add/Change/View/Delete Group Accounts. 164.It Cm hostname 165Shortcut to the Hostname/Domain menu under networking. 166.It Cm mouse 167Utilities for configuring, exploring, and enabling console mouse support. 168.It Cm mouse_disable 169Shortcut to the Disable menu under mouse. 170.It Cm mouse_enable 171Shortcut to the Enable menu under mouse. 172.It Cm mouse_flags 173Shortcut to the Flags menu under mouse. 174.It Cm mouse_port 175Shortcut to the Port menu under mouse. 176.It Cm mouse_type 177Shortcut to the Type menu under mouse. 178.It Cm nameservers 179Shortcut to the DNS Nameservers menu under networking. 180.It Cm netdev 181Shortcut to the Network Interfaces menu under networking. 182.It Cm networking 183Utilities to set/change Hostname/Domain, Network Interfaces, Default 184Router/Gateway, and DNS Nameservers. 185.It Cm password 186Set the system administrator 187.Pq root 188password. 189.It Cm security 190Configure various system security settings. 191.It Cm syscons_font 192Shortcut to the Font menu under console. 193.It Cm syscons_keymap 194Shortcut to the Keymap menu under console. 195.It Cm syscons_repeat 196Shortcut to the Repeat menu under console. 197.It Cm syscons_saver 198Shortcut to the Saver menu under console. 199.It Cm syscons_screenmap 200Shortcut to the Screenmap menu under console. 201.It Cm syscons_ttys 202Shortcut to the Ttys menu under console. 203.It Cm timezone 204Set the regional timezone of the local machine. 205.It Cm useradd 206Shortcut to the Add Users menu under usermgmt. 207.It Cm userdel 208Shortcut to the Delete Users menu under usermgmt. 209.It Cm useredit 210Shortcut to the Edit/View Users menu under usermgmt. 211.It Cm usermgmt 212Utilities to Add/Edit/View/Delete User Accounts. 213.El 214.Sh INTERNATIONALIZATION 215i18n features are built into 216.Nm 217and language-specific translation files will be added as they become available. 218In the absence of language-specific translation files, the default 219.Pq en_US.ISO8859-1 220files will be used. 221.Sh ADDING COMMANDS 222To be documented later. 223Document menu_selection="command|*" syntax of INDEX files. 224.Sh ENVIRONMENT VARIABLES 225The following environment variables affect the execution of 226.Nm : 227.Bl -tag -width ".Ev LC_ALL" 228.It Ev LANG 229If LANG is set, messages and index information will be read from files named 230messages.$LANG and INDEX.$LANG and fall back to files named messages and INDEX if 231messages.$LANG and INDEX.$LANG do not exist. 232LANG takes precedence over LC_ALL. 233.It Ev LC_ALL 234If LC_ALL is set, messages and index information will be read from files named 235messages.$LC_ALL and INDEX.$LC_ALL and fall back to files named messages and INDEX if 236messages.$LC_ALL and INDEX.$LC_ALL do not exist. 237.El 238.Sh FILES 239/usr/share/examples/bsdconfig/bsdconfigrc can be copied to $HOME/.bsdconfigrc and 240customized as needed. 241.Sh EXIT STATUS 242.Ex -std 243.Sh SEE ALSO 244.Xr bsdinstall 8 245.Sh HISTORY 246.Nm 247first appeared in 248.Fx 9.2 . 249.Sh AUTHORS 250.An Ron McDowell 251.An Devin Teske Aq dteske@FreeBSD.org 252.Sh BUGS 253The docsinstall and diskmgmt modules call bsdinstall. 254Bugs found in these modules should be considered those of bsdinstall, not 255.Nm . 256