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