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.
33 .Nd system configuration utility
42 .Op command Op OPTIONS
45 is used to set up many system configuration settings, both for new systems, as
46 well as changing configuration settings of existing systems.
49 optionally takes a command as an argument.
50 If invoked with no arguments, it will bring up an interactive menu listing the
53 The following options are available:
54 .Bl -tag -width indent+
56 Provide lots of debugging info on standard-out when running.
58 Send debugging info to file.
59 If file begins with a plus-sign debug info is sent to both standard-out and
60 file (minus the leading plus).
64 as script and then exit.
65 If multiple occurrences, program will only exit after last occurrence.
71 reads from standard input.
73 Print usage statement and exit.
77 As root, always prompt-for and validate
79 username/password before starting.
87 The following commands
88 .Pq sorted alphabetically
89 are currently included in the base
91 program, with more to be added soon.
92 Other commands can be added, as detailed below in the
94 section, and once added, will appear in the master menu as well as in the
97 .Bl -tag -width ".Cm syscons_screenmap"
99 Utilities to customize the behavior of the system console.
101 Shortcut to the Default Router/Gateway menu under networking.
103 Manage disk partitions and/or labels.
108 .Cm bsdinstall docsinstall
109 sub-utility to allow installation/re-installation of the FreeBSD Documentation
115 .Pq printed on stdout
118 menu, include, and shortcut structure relationships.
123 Shortcut to the Add Groups menu under groupmgmt.
125 Shortcut to the Delete Groups menu under groupmgmt.
127 Shortcut to the Edit/View Groups menu under groupmgmt.
129 Utilities to Add/Change/View/Delete Group Accounts.
131 Shortcut to the Hostname/Domain menu under networking.
132 .It Cm kern_securelevel
133 Shortcut to the kern.securelevel menu under security.
135 Utilities for configuring, exploring, and enabling console mouse support.
137 Shortcut to the Disable menu under mouse.
139 Shortcut to the Enable menu under mouse.
141 Shortcut to the Flags menu under mouse.
143 Shortcut to the Port menu under mouse.
145 Shortcut to the Type menu under mouse.
147 Shortcut to the DNS Nameservers menu under networking.
149 Shortcut to the Network Interfaces menu under networking.
151 Utilities to set/change Hostname/Domain, Network Interfaces, Default
152 Router/Gateway, and DNS Nameservers.
154 Browse, install, uninstall, or re-install packaged software.
156 Set the system administrator
160 Configure various system security settings.
162 Configure various aspects of system startup.
164 Shortcut to the Miscellaneous Startup Services menu under startup.
166 Shortcut to the Add New menu under the View/Edit Startup Configuration menu
167 (startup_rcconf) of startup.
168 .It Cm startup_rcconf
169 Shortcut to the View/Edit Startup Configuration menu under startup.
170 .It Cm startup_rcdelete
171 Shortcut to the Delete menu under the View/Edit Startup Configuration menu
172 (startup_rcconf) of startup.
174 Shortcut 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)!
178 Shortcut to the Font menu under console.
179 .\" .It Cm console_keymap
180 .\" Shortcut to the Keymap menu under console.
181 .It Cm syscons_keymap
182 Shortcut to the Keymap menu under console.
184 .\" Shortcut to the Repeat menu under console.
185 .It Cm syscons_repeat
186 Shortcut to the Repeat menu under console.
188 .\" Shortcut to the Saver menu under console.
190 Shortcut to the Saver menu under console.
191 .\" screenmap (encoding) selection not applicable to vt(4)!
192 .It Cm syscons_screenmap
193 Shortcut to the Screenmap menu under console.
194 .\" .It Cm vt_syscons_ttys
195 .\" Shortcut to the Ttys menu under console.
197 Shortcut to the Ttys menu under console.
199 Set the regional timezone of the local machine.
203 database with your favorite editor.
205 Shortcut to the Add Users menu under usermgmt.
207 Shortcut to the Delete Users menu under usermgmt.
209 Shortcut to the Edit/View Users menu under usermgmt.
211 Utilities to Add/Edit/View/Delete User Accounts.
213 .Sh INTERNATIONALIZATION
214 i18n features are built into
216 and language-specific translation files will be added as they become available.
217 In the absence of language-specific translation files, the default
221 To be documented later.
222 Document menu_selection="command|*" syntax of INDEX files.
223 .Sh ENVIRONMENT VARIABLES
224 The following environment variables affect the execution of
226 .Bl -tag -width ".Ev LC_ALL"
228 If LANG is set, messages and index information will be read from files named
229 messages.$LANG and INDEX.$LANG and fall back to files named messages and INDEX
230 if messages.$LANG and INDEX.$LANG do not exist.
231 LANG takes precedence over LC_ALL.
233 If LC_ALL is set, messages and index information will be read from files named
234 messages.$LC_ALL and INDEX.$LC_ALL and fall back to files named messages and
235 INDEX if messages.$LC_ALL and INDEX.$LC_ALL do not exist.
238 /usr/share/examples/bsdconfig/bsdconfigrc can be copied to $HOME/.bsdconfigrc
239 and customized as needed.
250 .An Devin Teske Aq dteske@FreeBSD.org
252 The docsinstall and diskmgmt modules call bsdinstall.
253 Bugs found in these modules should be considered those of bsdinstall, not