xref: /openbsd/usr.sbin/user/usermgmt.conf.5 (revision 44e41a3b)
1.\" $OpenBSD: usermgmt.conf.5,v 1.3 2004/06/04 18:04:21 otto Exp $
2.\" $NetBSD: usermgmt.conf.5,v 1.3 2002/10/02 13:49:11 grant Exp $
3.\"
4.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
5.\" All rights reserved.
6.\"
7.\" This document is derived from works contributed to The NetBSD Foundation
8.\" by Grant Beattie.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. The name of the author may not be used to endorse or promote products
19.\"    derived from this software without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.Dd May 28, 2002
34.Dt USERMGMT.CONF 5
35.Os
36.\" turn off hyphenation
37.hym 999
38.Sh NAME
39.Nm usermgmt.conf
40.Nd user management tools configuration file
41.Sh SYNOPSIS
42.Nm usermgmt.conf
43.Sh DESCRIPTION
44The
45.Nm usermgmt.conf
46file defines the default values used by the user management tools,
47.Xr user 8 .
48.Pp
49Options in this file can be set by manually editing
50.Pa /etc/usermgmt.conf
51or using the
52.Fl D
53option to
54.Xr useradd 8 .
55.Pp
56.Bl -tag -width preserveX
57.It Ic base_dir
58sets the base directory name, in which new users' home directories
59are created when using the
60.Fl m
61option to
62.Xr useradd 8 .
63.It Ic class
64sets the default login class for new users.
65See
66.Xr login.conf 5
67for more information on user login classes.
68.It Ic expire
69sets the default time at which the new accounts expire.
70Both the
71.Ar expire
72and
73.Ar inactive
74fields should be entered in the form
75.Dq month day year ,
76where month is the month name (the first three characters are
77sufficient), day is the day of the month, and year is the year.
78Time in seconds since the epoch (UTC) is also valid.
79A value of 0 can be used to disable this feature.
80.It Ic group
81sets the default primary group for new users.
82If this is
83.Ql =uid ,
84then a UID and GID will be picked which are both unique
85and the same, and a line added to
86.Pa /etc/group
87to describe the new group.
88It has the format:
89.Pp
90.Bd -ragged -offset indent -compact
91.Ic group
92.Ar gid | name | Li =uid
93.Ed
94.It Ic inactive
95sets the default time at which the passwords of new accounts expire.
96A value of 0 can be used to disable this feature.
97Also see the
98.Ar expire
99field.
100.It Ic password
101specifies an already-encrypted default password.
102.It Ic preserve
103If this value is one of
104.Ql true ,
105.Ql yes ,
106or a non-zero number, then the user login information will be
107preserved when removing a user with
108.Xr userdel 8 .
109.It Ic range
110specifies the UID boundaries for new users.
111If unspecified, the default is
112.Dq 1000..60000 .
113It has the format:
114.Bd -unfilled -offset indent -compact
115.Ic range Ar starting-uid Ns Li .. Ns Ar ending-uid
116.Ed
117.It Ic shell
118sets the default login shell for new users.
119.It Ic skel_dir
120sets the default skeleton directory in which to find files
121with which to populate the new user's home directory.
122.El
123.Sh FILES
124.Bl -tag -width /etc/usermgmt.conf -compact
125.It Pa /etc/usermgmt.conf
126.It Pa /etc/skel/*
127.It Pa /etc/login.conf
128.El
129.Sh SEE ALSO
130.Xr login.conf 5 ,
131.Xr passwd 5 ,
132.Xr user 8 ,
133.Xr useradd 8 ,
134.Xr userdel 8 ,
135.Xr usermod 8
136.Sh HISTORY
137The
138.Nm
139configuration file first appeared in
140.Ox 2.7 .
141