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