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