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