.\"
.\" $FreeBSD$
.\"
-.Dd March 30, 2004
+.Dd April 12, 2007
.Dt ADDUSER.CONF 5
.Os
.Sh NAME
.Nm adduser.conf
-.Nd configuration file for the adduser utility
+.Nd
+.Xr adduser 8
+configuration file
.Sh DESCRIPTION
The
.Pa /etc/adduser.conf
+file is automatically generated by the
+.Xr adduser 8
+utility when invoked with the
+.Fl C
+command-line option.
+It is not meant to be edited by hand.
+.Pp
+The
+.Pa /etc/adduser.conf
file is used to pre-set certain configuration options for
the
.Xr adduser 8
utility.
When
.Xr adduser 8
-is invoked, it will check to see if this file exists and
-if so the configuration will be used or offered as the
+is invoked, it will check to see if this file exists, and
+if so, the configuration will be used or offered as the
default settings.
The
.Nm
will read the configuration data unless a flag
has been passed to override it.
For example, the
-.Dq shell
+.Va defaultshell
option.
In the third case, the configuration will be utilized, but the
user will never be prompted to modify the default setting by
.Xr adduser 8
prompt.
For example, the
-.Dq upwexpire
+.Va upwexpire
setting.
.Pp
The following configuration options can be set in
.Nm :
-.Pp
-.Bl -tag -width "defaultgroups" -offset indent -compact
-.It defaultLgroup
+.Bl -tag -width ".Va defaultgroups" -offset indent
+.It Va defaultLgroup
The default group new users will be added to.
-.Pp
-.It defaultclass
+.It Va defaultclass
The default class to place users in as described in
.Xr login.conf 5 .
-.Pp
-.It defaultgroups
+.It Va defaultgroups
This option is used to specify what other groups the new account
should be added to.
-.Pp
-.It passwdtype
+.It Va passwdtype
May be one of
-.Cm no , Cm none , Cm random ,
+.Cm no , none , random ,
or
-.Cm yes
+.Cm yes ,
as described in
.Xr adduser 8 .
As such, the text is not duplicated here and may be
read in
.Xr adduser 8 .
-.Pp
-.It homeprefix
+.It Va homeprefix
The default home directory prefix, usually
.Pa /home .
-.Pp
-.It defaultshell
-The users default shell which may be any of the shells listed in
-.Pa /etc/shells .
-.Pp
-.It udotdir
+.It Va defaultshell
+The user's default shell which may be any of the shells listed in
+.Xr shells 5 .
+.It Va udotdir
Defines the location of the default shell and environment
configuration files.
-.Pp
-.It msgfile
+.It Va msgfile
Location of the default new user message file.
This message will be sent to all new users if specified
here or at the
.Xr adduser 8
prompt.
-.Pp
-.It disableflag
+.It Va disableflag
The default message enclosed in brackets for the
lock account prompt.
-.Pp
-.It upwexpire
+.It Va upwexpire
The default password expiration time.
Format of the date is either a
.Ux
time in decimal, or a date in
.Sm off
-.Ql dd-mmm-yy Bq yy
+.Ar dd No - Ar mmm No - Ar yy Op Ar yy
.Sm on
-format, where dd is the day, mmm is the month in either numeric or
-alphabetic format and year is either a two or four digit year.
+format, where
+.Ar dd
+is the day,
+.Ar mmm
+is the month in either numeric or
+alphabetic format, and
+.Ar yy Ns Op Ar yy
+is either a two or four digit year.
This option also accepts a relative date in the form of
.Sm off
-.Sy n Bq mhdwoy
+.Ar n Op Ar m h d w o y
.Sm on
where
-.Sy n
-is a decimal, octal (leading 0) or hexadecimal (leading 0x) digit followed by the
-number of Minutes, Hours, Days, Weeks, Months or Years from the current date at
+.Ar n
+is a decimal, octal (leading 0) or hexadecimal (leading 0x) digit
+followed by the number of Minutes, Hours, Days, Weeks, Months or
+Years from the current date at
which the expiration time is to be set.
-.Pp
-.It uexpire
+.It Va uexpire
The default account expire time.
-The format is similar to the upwexpire option.
-.Pp
-.It ugecos
-The default information to be held in the gecos field of
+The format is similar to the
+.Va upwexpire
+option.
+.It Va ugecos
+The default information to be held in the GECOS field of
.Pa /etc/master.passwd .
-.Pp
-.It uuid
+.It Va uidstart
The default user ID setting.
This must be a number above 1000 and fewer than 65534.
.El
.Fl C
.Xr adduser 8
flag and modified.
-.Bd -literal
+.Bd -literal -offset indent
# Configuration file for adduser(8).
# NOTE: only *some* variables are saved.
# Last Modified on Fri Mar 30 14:04:05 EST 2004.
The
.Nm
manual page first appeared in
-.Fx 4.10 .
+.Fx 5.3 .
.Sh AUTHORS
This manual page was written by
-.An Tom Rhodes Aq trhodes@FreeBSD.org
+.An Tom Rhodes Aq trhodes@FreeBSD.org .
+.Sh BUGS
+The internal variables documented here may change without notice.
+Do not rely on them.
+To modify this file invoke
+.Xr adduser 8
+with the
+.Fl C
+option instead.
git.ckatri.com / pw-darwin.git / blobdiff