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