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