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.7 2010/05/13 12:07:55 uqs Exp $
  27 .\"
  28 .Dd April 12, 2007
  29 .Dt ADDUSER.CONF 5
  30 .Os
  31 .Sh NAME
  32 .Nm adduser.conf
  33 .Nd
  34 .Xr adduser 8
  35 configuration file
  36 .Sh DESCRIPTION
  37 The
  38 .Pa /etc/adduser.conf
  39 file is automatically generated by the
  40 .Xr adduser 8
  41 utility when invoked with the
  42 .Fl C
  43 command-line option.
  44 It is not meant to be edited by hand.
  45 .Pp
  46 The
  47 .Pa /etc/adduser.conf
  48 file is used to pre-set certain configuration options for
  49 the
  50 .Xr adduser 8
  51 utility.
  52 When
  53 .Xr adduser 8
  54 is invoked, it will check to see if this file exists, and
  55 if so, the configuration will be used or offered as the
  56 default settings.
  57 The
  58 .Nm
  59 file offers three types of configuration:
  60 .Bl -bullet
  61 .It
  62 Default settings offered by
  63 .Xr adduser 8 .
  64 These options are specified in the configuration file and offered
  65 as the default during every invocation of the
  66 .Xr adduser 8
  67 utility.
  68 .It
  69 Configuration options which can be set in
  70 .Nm ,
  71 but overridden by passing a flag to
  72 .Xr adduser 8 .
  73 .It
  74 Configuration supported by
  75 .Xr adduser 8
  76 but not offered by a flag or during initial invocation.
  77 .El
  78 .Pp
  79 In the first case, these options can be set in
  80 .Nm
  81 but will still be offered when
  82 .Xr adduser 8
  83 is invoked.
  84 In the second case,
  85 .Xr adduser 8
  86 will read the configuration data unless a flag
  87 has been passed to override it.
  88 For example, the
  89 .Va defaultshell
  90 option.
  91 In the third case, the configuration will be utilized, but the
  92 user will never be prompted to modify the default setting by
  93 either a flag or an
  94 .Xr adduser 8
  95 prompt.
  96 For example, the
  97 .Va upwexpire
  98 setting.
  99 .Pp
 100 The following configuration options can be set in
 101 .Nm :
 102 .Bl -tag -width ".Va defaultgroups" -offset indent
 103 .It Va defaultLgroup
 104 The default group new users will be added to.
 105 .It Va defaultclass
 106 The default class to place users in as described in
 107 .Xr login.conf 5 .
 108 .It Va defaultgroups
 109 This option is used to specify what other groups the new account
 110 should be added to.
 111 .It Va passwdtype
 112 May be one of
 113 .Cm no , none , random ,
 114 or
 115 .Cm yes ,
 116 as described in
 117 .Xr adduser 8 .
 118 As such, the text is not duplicated here and may be
 119 read in
 120 .Xr adduser 8 .
 121 .It Va homeprefix
 122 The default home directory prefix, usually
 123 .Pa /home .
 124 .It Va defaultshell
 125 The user's default shell which may be any of the shells listed in
 126 .Xr shells 5 .
 127 .It Va udotdir
 128 Defines the location of the default shell and environment
 129 configuration files.
 130 .It Va msgfile
 131 Location of the default new user message file.
 132 This message will be sent to all new users if specified
 133 here or at the
 134 .Xr adduser 8
 135 prompt.
 136 .It Va disableflag
 137 The default message enclosed in brackets for the
 138 lock account prompt.
 139 .It Va upwexpire
 140 The default password expiration time.
 141 Format of the date is either a
 142 .Ux
 143 time in decimal, or a date in
 144 .Sm off
 145 .Ar dd No - Ar mmm No - Ar yy Op Ar yy
 146 .Sm on
 147 format, where
 148 .Ar dd
 149 is the day,
 150 .Ar mmm
 151 is the month in either numeric or
 152 alphabetic format, and
 153 .Ar yy Ns Op Ar yy
 154 is either a two or four digit year.
 155 This option also accepts a relative date in the form of
 156 .Sm off
 157 .Ar n Op Ar m h d w o y
 158 .Sm on
 159 where
 160 .Ar n
 161 is a decimal, octal (leading 0) or hexadecimal (leading 0x) digit
 162 followed by the number of Minutes, Hours, Days, Weeks, Months or
 163 Years from the current date at
 164 which the expiration time is to be set.
 165 .It Va uexpire
 166 The default account expire time.
 167 The format is similar to the
 168 .Va upwexpire
 169 option.
 170 .It Va ugecos
 171 The default information to be held in the GECOS field of
 172 .Pa /etc/master.passwd .
 173 .It Va uidstart
 174 The default user ID setting.
 175 This must be a number above 1000 and fewer than 65534.
 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.