usr.sbin/bsdconfig/bsdconfig.8

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