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