1 .\" Copyright (c) 2012 Ron McDowell
2 .\" Copyright (c) 2012-2013 Devin Teske
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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.
67 .Nd system configuration utility
76 .Op command Op OPTIONS
79 is used to set up many system configuration settings, both for new systems, as
80 well as changing configuration settings of existing systems.
83 takes a command as an argument.
84 If invoked with no arguments, it will bring up a master menu listing the
87 The following options are available:
88 .Bl -tag -width indent+
92 as script and then exit.
93 If multiple occurrences, program will only exit after last occurrence.
99 reads from standard input.
101 Print usage statement and exit.
105 As root, always prompt-for and validate
107 username/password before starting.
115 The following commands
116 .Pq sorted alphabetically
117 are currently included in the base
119 program, with more to be added soon.
120 Other commands can be added, as detailed below in the
122 section, and once added, will appear in the master menu as well as in the
125 .Bl -tag -width ".Cm syscons_screenmap"
127 Utilities to customize the behavior of the system console.
129 Shortcut to the Default Router/Gateway menu under networking.
131 Manage disk partitions and/or labels.
136 .Cm bsdinstall docsinstall
137 sub-utility to allow installation/re-installation of the FreeBSD Documentation
143 .Pq printed on stdout
146 menu, include, and shortcut structure relationships.
151 Shortcut to the Add Groups menu under groupmgmt.
153 Shortcut to the Delete Groups menu under groupmgmt.
155 Shortcut to the Edit/View Groups menu under groupmgmt.
157 Utilities to Add/Change/View/Delete Group Accounts.
159 Shortcut to the Hostname/Domain menu under networking.
161 Utilities for configuring, exploring, and enabling console mouse support.
163 Shortcut to the Disable menu under mouse.
165 Shortcut to the Enable menu under mouse.
167 Shortcut to the Flags menu under mouse.
169 Shortcut to the Port menu under mouse.
171 Shortcut to the Type menu under mouse.
173 Shortcut to the DNS Nameservers menu under networking.
175 Shortcut to the Network Interfaces menu under networking.
177 Utilities to set/change Hostname/Domain, Network Interfaces, Default
178 Router/Gateway, and DNS Nameservers.
180 Set the system administrator
184 Configure various system security settings.
186 Shortcut to the Font menu under console.
187 .It Cm syscons_keymap
188 Shortcut to the Keymap menu under console.
189 .It Cm syscons_repeat
190 Shortcut to the Repeat menu under console.
192 Shortcut to the Saver menu under console.
193 .It Cm syscons_screenmap
194 Shortcut to the Screenmap menu under console.
196 Shortcut to the Ttys menu under console.
198 Set the regional timezone of the local machine.
200 Shortcut to the Add Users menu under usermgmt.
202 Shortcut to the Delete Users menu under usermgmt.
204 Shortcut to the Edit/View Users menu under usermgmt.
206 Utilities to Add/Edit/View/Delete User Accounts.
208 .Sh INTERNATIONALIZATION
209 i18n features are built into
211 and language-specific translation files will be added as they become available.
212 In the absence of language-specific translation files, the default
216 To be documented later.
217 Document menu_selection="command|*" syntax of INDEX files.
218 .Sh ENVIRONMENT VARIABLES
219 The following environment variables affect the execution of
221 .Bl -tag -width ".Ev LC_ALL"
223 If LANG is set, messages and index information will be read from files named
224 messages.$LANG and INDEX.$LANG and fall back to files named messages and INDEX if
225 messages.$LANG and INDEX.$LANG do not exist.
226 LANG takes precedence over LC_ALL.
228 If LC_ALL is set, messages and index information will be read from files named
229 messages.$LC_ALL and INDEX.$LC_ALL and fall back to files named messages and INDEX if
230 messages.$LC_ALL and INDEX.$LC_ALL do not exist.
233 /usr/share/examples/bsdconfig/bsdconfigrc can be copied to $HOME/.bsdconfigrc and
234 customized as needed.
245 .An Devin Teske Aq dteske@FreeBSD.org
247 The docsinstall and diskmgmt modules call bsdinstall.
248 Bugs found in these modules should be considered those of bsdinstall, not