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