usr.sbin/adduser/adduser.conf.5

   1 .\"
   2 .\" Copyright (c) 2004 Tom Rhodes
   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 AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd April 12, 2007
  27 .Dt ADDUSER.CONF 5
  28 .Os
  29 .Sh NAME
  30 .Nm adduser.conf
  31 .Nd
  32 .Xr adduser 8
  33 configuration file
  34 .Sh DESCRIPTION
  35 The
  36 .Pa /etc/adduser.conf
  37 file is automatically generated by the
  38 .Xr adduser 8
  39 utility when invoked with the
  40 .Fl C
  41 command-line option.
  42 It is not meant to be edited by hand.
  43 .Pp
  44 The
  45 .Pa /etc/adduser.conf
  46 file is used to pre-set certain configuration options for
  47 the
  48 .Xr adduser 8
  49 utility.
  50 When
  51 .Xr adduser 8
  52 is invoked, it will check to see if this file exists, and
  53 if so, the configuration will be used or offered as the
  54 default settings.
  55 The
  56 .Nm
  57 file offers three types of configuration:
  58 .Bl -bullet
  59 .It
  60 Default settings offered by
  61 .Xr adduser 8 .
  62 These options are specified in the configuration file and offered
  63 as the default during every invocation of the
  64 .Xr adduser 8
  65 utility.
  66 .It
  67 Configuration options which can be set in
  68 .Nm ,
  69 but overridden by passing a flag to
  70 .Xr adduser 8 .
  71 .It
  72 Configuration supported by
  73 .Xr adduser 8
  74 but not offered by a flag or during initial invocation.
  75 .El
  76 .Pp
  77 In the first case, these options can be set in
  78 .Nm
  79 but will still be offered when
  80 .Xr adduser 8
  81 is invoked.
  82 In the second case,
  83 .Xr adduser 8
  84 will read the configuration data unless a flag
  85 has been passed to override it.
  86 For example, the
  87 .Va defaultshell
  88 option.
  89 In the third case, the configuration will be utilized, but the
  90 user will never be prompted to modify the default setting by
  91 either a flag or an
  92 .Xr adduser 8
  93 prompt.
  94 For example, the
  95 .Va upwexpire
  96 setting.
  97 .Pp
  98 The following configuration options can be set in
  99 .Nm :
 100 .Bl -tag -width ".Va defaultgroups" -offset indent
 101 .It Va defaultLgroup
 102 The default group new users will be added to.
 103 .It Va defaultclass
 104 The default class to place users in as described in
 105 .Xr login.conf 5 .
 106 .It Va defaultgroups
 107 This option is used to specify what other groups the new account
 108 should be added to.
 109 .It Va passwdtype
 110 May be one of
 111 .Cm no , none , random ,
 112 or
 113 .Cm yes ,
 114 as described in
 115 .Xr adduser 8 .
 116 As such, the text is not duplicated here and may be
 117 read in
 118 .Xr adduser 8 .
 119 .It Va homeprefix
 120 The default home directory prefix, usually
 121 .Pa /home .
 122 .It Va defaultshell
 123 The user's default shell which may be any of the shells listed in
 124 .Xr shells 5 .
 125 .It Va udotdir
 126 Defines the location of the default shell and environment
 127 configuration files.
 128 .It Va msgfile
 129 Location of the default new user message file.
 130 This message will be sent to all new users if specified
 131 here or at the
 132 .Xr adduser 8
 133 prompt.
 134 .It Va disableflag
 135 The default message enclosed in brackets for the
 136 lock account prompt.
 137 .It Va upwexpire
 138 The default password expiration time.
 139 Format of the date is either a
 140 .Ux
 141 time in decimal, or a date in
 142 .Sm off
 143 .Ar dd No - Ar mmm No - Ar yy Op Ar yy
 144 .Sm on
 145 format, where
 146 .Ar dd
 147 is the day,
 148 .Ar mmm
 149 is the month in either numeric or
 150 alphabetic format, and
 151 .Ar yy Ns Op Ar yy
 152 is either a two or four digit year.
 153 This option also accepts a relative date in the form of
 154 .Sm off
 155 .Ar n Op Ar m h d w o y
 156 .Sm on
 157 where
 158 .Ar n
 159 is a decimal, octal (leading 0) or hexadecimal (leading 0x) digit
 160 followed by the number of Minutes, Hours, Days, Weeks, Months or
 161 Years from the current date at
 162 which the expiration time is to be set.
 163 .It Va uexpire
 164 The default account expire time.
 165 The format is similar to the
 166 .Va upwexpire
 167 option.
 168 .It Va ugecos
 169 The default information to be held in the GECOS field of
 170 .Pa /etc/master.passwd .
 171 .It Va uidstart
 172 The default user ID setting.
 173 This must be a number above 1000 and fewer than 65534.
 174 .It Va Zflag
 175 Do not attempt to create ZFS home dataset.
 176 .El
 177 .Sh EXAMPLES
 178 The following is an example
 179 .Nm
 180 file created with the
 181 .Fl C
 182 .Xr adduser 8
 183 flag and modified.
 184 .Bd -literal -offset indent
 185 # Configuration file for adduser(8).
 186 # NOTE: only *some* variables are saved.
 187 # Last Modified on Fri Mar 30 14:04:05 EST 2004.
 188
 189 defaultLgroup=
 190 defaultclass=
 191 defaultgroups=
 192 passwdtype=yes
 193 homeprefix=/home
 194 defaultshell=/bin/csh
 195 udotdir=/usr/share/skel
 196 msgfile=/etc/adduser.msg
 197 disableflag=
 198 upwexpire=91d # Expire passwords 91 days after creation.
 199 .Ed
 200 .Sh SEE ALSO
 201 .Xr group 5 ,
 202 .Xr passwd 5 ,
 203 .Xr adduser 8 ,
 204 .Xr pw 8 ,
 205 .Xr rmuser 8
 206 .Sh HISTORY
 207 The
 208 .Nm
 209 manual page first appeared in
 210 .Fx 5.3 .
 211 .Sh AUTHORS
 212 This manual page was written by
 213 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org .
 214 .Sh BUGS
 215 The internal variables documented here may change without notice.
 216 Do not rely on them.
 217 To modify this file invoke
 218 .Xr adduser 8
 219 with the
 220 .Fl C
 221 option instead.