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 83takes a command as an argument. 84If invoked with no arguments, it will bring up a master menu listing the 85available commands. 86.Pp 87The following options are available: 88.Bl -tag -width indent+ 89.It Fl f Ar file 90Load 91.Ar file 92as script and then exit. 93If multiple occurrences, program will only exit after last occurrence. 94If 95.Ar file 96is a single dash 97.Pq Sq Fl , 98.Nm 99reads from standard input. 100.It Fl h 101Print usage statement and exit. 102.It Fl S 103Secure X11 mode 104.Pq implies Fl X . 105As root, always prompt-for and validate 106.Xr sudo 8 107username/password before starting. 108.It Fl X 109Use 110.Xr Xdialog 1 111in place of 112.Xr dialog 1 . 113.El 114.Sh COMMANDS 115The following commands 116.Pq sorted alphabetically 117are currently included in the base 118.Nm 119program, with more to be added soon. 120Other commands can be added, as detailed below in the 121.Cm ADDING COMMANDS 122section, and once added, will appear in the master menu as well as in the 123.Cm -h 124listing. 125.Bl -tag -width ".Cm syscons_screenmap" 126.It Cm console 127Utilities to customize the behavior of the system console. 128.It Cm defaultrouter 129Shortcut to the Default Router/Gateway menu under networking. 130.It Cm diskmgmt 131Manage disk partitions and/or labels. 132Executes 133.Xr sade 8 . 134.It Cm docsinstall 135Executes the 136.Cm bsdinstall docsinstall 137sub-utility to allow installation/re-installation of the FreeBSD Documentation 138set(s). 139.It Cm dot 140Generate a graphviz 141.Xr dot 1 142language file 143.Pq printed on stdout 144visualizing the 145.Nm 146menu, include, and shortcut structure relationships. 147See 148.Dq bsdconfig dot -h 149for more details. 150.It Cm groupadd 151Shortcut to the Add Groups menu under groupmgmt. 152.It Cm groupdel 153Shortcut to the Delete Groups menu under groupmgmt. 154.It Cm groupedit 155Shortcut to the Edit/View Groups menu under groupmgmt. 156.It Cm groupmgmt 157Utilities to Add/Change/View/Delete Group Accounts. 158.It Cm hostname 159Shortcut to the Hostname/Domain menu under networking. 160.It Cm mouse 161Utilities for configuring, exploring, and enabling console mouse support. 162.It Cm mouse_disable 163Shortcut to the Disable menu under mouse. 164.It Cm mouse_enable 165Shortcut to the Enable menu under mouse. 166.It Cm mouse_flags 167Shortcut to the Flags menu under mouse. 168.It Cm mouse_port 169Shortcut to the Port menu under mouse. 170.It Cm mouse_type 171Shortcut to the Type menu under mouse. 172.It Cm nameservers 173Shortcut to the DNS Nameservers menu under networking. 174.It Cm netdev 175Shortcut to the Network Interfaces menu under networking. 176.It Cm networking 177Utilities to set/change Hostname/Domain, Network Interfaces, Default 178Router/Gateway, and DNS Nameservers. 179.It Cm password 180Set the system administrator 181.Pq root 182password. 183.It Cm security 184Configure various system security settings. 185.It Cm syscons_font 186Shortcut to the Font menu under console. 187.It Cm syscons_keymap 188Shortcut to the Keymap menu under console. 189.It Cm syscons_repeat 190Shortcut to the Repeat menu under console. 191.It Cm syscons_saver 192Shortcut to the Saver menu under console. 193.It Cm syscons_screenmap 194Shortcut to the Screenmap menu under console. 195.It Cm syscons_ttys 196Shortcut to the Ttys menu under console. 197.It Cm timezone 198Set the regional timezone of the local machine. 199.It Cm useradd 200Shortcut to the Add Users menu under usermgmt. 201.It Cm userdel 202Shortcut to the Delete Users menu under usermgmt. 203.It Cm useredit 204Shortcut to the Edit/View Users menu under usermgmt. 205.It Cm usermgmt 206Utilities to Add/Edit/View/Delete User Accounts. 207.El 208.Sh INTERNATIONALIZATION 209i18n features are built into 210.Nm 211and language-specific translation files will be added as they become available. 212In the absence of language-specific translation files, the default 213.Pq en_US.ISO8859-1 214files will be used. 215.Sh ADDING COMMANDS 216To be documented later. 217Document menu_selection="command|*" syntax of INDEX files. 218.Sh ENVIRONMENT VARIABLES 219The following environment variables affect the execution of 220.Nm : 221.Bl -tag -width ".Ev LC_ALL" 222.It Ev LANG 223If LANG is set, messages and index information will be read from files named 224messages.$LANG and INDEX.$LANG and fall back to files named messages and INDEX if 225messages.$LANG and INDEX.$LANG do not exist. 226LANG takes precedence over LC_ALL. 227.It Ev LC_ALL 228If LC_ALL is set, messages and index information will be read from files named 229messages.$LC_ALL and INDEX.$LC_ALL and fall back to files named messages and INDEX if 230messages.$LC_ALL and INDEX.$LC_ALL do not exist. 231.El 232.Sh FILES 233/usr/share/examples/bsdconfig/bsdconfigrc can be copied to $HOME/.bsdconfigrc and 234customized as needed. 235.Sh EXIT STATUS 236.Ex -std 237.Sh SEE ALSO 238.Xr bsdinstall 8 239.Sh HISTORY 240.Nm 241first appeared in 242.Fx 10.0 . 243.Sh AUTHORS 244.An Ron McDowell 245.An Devin Teske Aq dteske@FreeBSD.org 246.Sh BUGS 247The docsinstall and diskmgmt modules call bsdinstall. 248Bugs found in these modules should be considered those of bsdinstall, not 249.Nm . 250