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