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.\" $FreeBSD$ 27.\" 28.Dd April 12, 2020 29.Dt BSDCONFIG 8 30.Os 31.Sh NAME 32.Nm bsdconfig 33.Nd system configuration utility 34.Sh SYNOPSIS 35.Nm 36.Op Fl h 37.Nm 38.Ar command 39.Op Fl h 40.Nm 41.Op OPTIONS 42.Op command Op OPTIONS 43.Sh DESCRIPTION 44.Nm 45is used to set up many system configuration settings, both for new systems, as 46well as changing configuration settings of existing systems. 47.Pp 48.Nm 49optionally takes a command as an argument. 50If invoked with no arguments, it will bring up an interactive menu listing the 51available modules. 52.Pp 53The following options are available: 54.Bl -tag -width indent+ 55.It Fl d 56Provide lots of debugging info on standard-out when running. 57.It Fl D Ar file 58Send debugging info to file. 59If file begins with a plus-sign debug info is sent to both standard-out and 60file (minus the leading plus). 61.It Fl f Ar file 62Load 63.Ar file 64as script and then exit. 65If multiple occurrences, program will only exit after last occurrence. 66If 67.Ar file 68is a single dash 69.Pq Sq Fl , 70.Nm 71reads from standard input. 72.It Fl h 73Print usage statement and exit. 74.It Fl S 75Secure X11 mode 76.Pq implies Fl X . 77As root, always prompt-for and validate 78.Xr sudo 8 79username/password before starting. 80.It Fl X 81Use 82.Xr Xdialog 1 83in place of 84.Xr dialog 1 . 85.El 86.Sh COMMANDS 87The following commands 88.Pq sorted alphabetically 89are currently included in the base 90.Nm 91program, with more to be added soon. 92Other commands can be added, as detailed below in the 93.Cm ADDING COMMANDS 94section, and once added, will appear in the master menu as well as in the 95.Cm -h 96listing. 97.Bl -tag -width ".Cm syscons_screenmap" 98.It Cm console 99Utilities to customize the behavior of the system console. 100.It Cm defaultrouter 101Shortcut to the Default Router/Gateway menu under networking. 102.It Cm diskmgmt 103Manage disk partitions and/or labels. 104Executes 105.Xr sade 8 . 106.It Cm docsinstall 107Executes the 108.Cm bsdinstall docsinstall 109sub-utility to allow installation/re-installation of the FreeBSD Documentation 110set(s). 111.It Cm dot 112Generate a graphviz 113.Xr dot 1 114language file 115.Pq printed on stdout 116visualizing the 117.Nm 118menu, include, and shortcut structure relationships. 119See 120.Dq bsdconfig dot -h 121for more details. 122.It Cm groupadd 123Shortcut to the Add Groups menu under groupmgmt. 124.It Cm groupdel 125Shortcut to the Delete Groups menu under groupmgmt. 126.It Cm groupedit 127Shortcut to the Edit/View Groups menu under groupmgmt. 128.It Cm groupmgmt 129Utilities to Add/Change/View/Delete Group Accounts. 130.It Cm hostname 131Shortcut to the Hostname/Domain menu under networking. 132.It Cm kern_securelevel 133Shortcut to the kern.securelevel menu under security. 134.It Cm mouse 135Utilities for configuring, exploring, and enabling console mouse support. 136.It Cm mouse_disable 137Shortcut to the Disable menu under mouse. 138.It Cm mouse_enable 139Shortcut to the Enable menu under mouse. 140.It Cm mouse_flags 141Shortcut to the Flags menu under mouse. 142.It Cm mouse_port 143Shortcut to the Port menu under mouse. 144.It Cm mouse_type 145Shortcut to the Type menu under mouse. 146.It Cm nameservers 147Shortcut to the DNS Nameservers menu under networking. 148.It Cm netdev 149Shortcut to the Network Interfaces menu under networking. 150.It Cm networking 151Utilities to set/change Hostname/Domain, Network Interfaces, Wireless 152Network, Default Router/Gateway, and DNS Nameservers. 153.It Cm packages 154Browse, install, uninstall, or re-install packaged software. 155.It Cm password 156Set the system administrator 157.Pq root 158password. 159.It Cm security 160Configure various system security settings. 161.It Cm startup 162Configure various aspects of system startup. 163.It Cm startup_misc 164Shortcut to the Miscellaneous Startup Services menu under startup. 165.It Cm startup_rcadd 166Shortcut to the Add New menu under the View/Edit Startup Configuration menu 167(startup_rcconf) of startup. 168.It Cm startup_rcconf 169Shortcut to the View/Edit Startup Configuration menu under startup. 170.It Cm startup_rcdelete 171Shortcut to the Delete menu under the View/Edit Startup Configuration menu 172(startup_rcconf) of startup. 173.It Cm startup_rcvar 174Shortcut to the Toggle Startup Services menu under startup. 175.\" use neutral name, e.g. console_keymap instead of syscons_keymap? 176.\" font (encoding) selection not applicable to vt(4)! 177.It Cm syscons_font 178Shortcut to the Font menu under console. 179.\" .It Cm console_keymap 180.\" Shortcut to the Keymap menu under console. 181.It Cm syscons_keymap 182Shortcut to the Keymap menu under console. 183.\" .It Cm vt_repeat 184.\" Shortcut to the Repeat menu under console. 185.It Cm syscons_repeat 186Shortcut to the Repeat menu under console. 187.\" .It Cm vt_saver 188.\" Shortcut to the Saver menu under console. 189.It Cm syscons_saver 190Shortcut to the Saver menu under console. 191.\" screenmap (encoding) selection not applicable to vt(4)! 192.It Cm syscons_screenmap 193Shortcut to the Screenmap menu under console. 194.\" .It Cm vt_syscons_ttys 195.\" Shortcut to the Ttys menu under console. 196.It Cm syscons_ttys 197Shortcut to the Ttys menu under console. 198.It Cm timezone 199Set the regional timezone of the local machine. 200.It Cm ttys 201Edit the 202.Xr ttys 5 203database with your favorite editor. 204.It Cm useradd 205Shortcut to the Add Users menu under usermgmt. 206.It Cm userdel 207Shortcut to the Delete Users menu under usermgmt. 208.It Cm useredit 209Shortcut to the Edit/View Users menu under usermgmt. 210.It Cm usermgmt 211Utilities to Add/Edit/View/Delete User Accounts. 212.It Cm wireless 213Shortcut to the Wireless Networks menu under networking. 214.El 215.Sh INTERNATIONALIZATION 216i18n features are built into 217.Nm 218and language-specific translation files will be added as they become available. 219In the absence of language-specific translation files, the default 220.Pq en_US.ISO8859-1 221files will be used. 222.Sh ADDING COMMANDS 223To be documented later. 224Document menu_selection="command|*" syntax of INDEX files. 225.Sh ENVIRONMENT VARIABLES 226The following environment variables affect the execution of 227.Nm : 228.Bl -tag -width ".Ev LC_ALL" 229.It Ev LANG 230If LANG is set, messages and index information will be read from files named 231messages.$LANG and INDEX.$LANG and fall back to files named messages and INDEX 232if messages.$LANG and INDEX.$LANG do not exist. 233LANG takes precedence over LC_ALL. 234.It Ev LC_ALL 235If LC_ALL is set, messages and index information will be read from files named 236messages.$LC_ALL and INDEX.$LC_ALL and fall back to files named messages and 237INDEX if messages.$LC_ALL and INDEX.$LC_ALL do not exist. 238.El 239.Sh FILES 240/usr/share/examples/bsdconfig/bsdconfigrc can be copied to $HOME/.bsdconfigrc 241and customized as needed. 242.Sh EXIT STATUS 243.Ex -std 244.Sh SEE ALSO 245.Xr bsdinstall 8 246.Sh HISTORY 247.Nm 248first appeared in 249.Fx 9.2 . 250.Sh AUTHORS 251.An Ron McDowell 252.An Devin Teske Aq Mt dteske@FreeBSD.org 253.Sh BUGS 254The docsinstall and diskmgmt modules call bsdinstall. 255Bugs found in these modules should be considered those of bsdinstall, not 256.Nm . 257