xref: /openbsd-src/usr.sbin/user/usermgmt.conf.5 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\" $OpenBSD: usermgmt.conf.5,v 1.13 2016/08/16 11:33:07 tb 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 $Mdocdate: August 16 2016 $
34.Dt USERMGMT.CONF 5
35.Os
36.Sh NAME
37.Nm usermgmt.conf
38.Nd user management tools configuration file
39.Sh DESCRIPTION
40The
41.Nm usermgmt.conf
42file defines the default values used by the user management tools,
43.Xr user 8 .
44.Pp
45Options in this file can be set by manually editing
46.Pa /etc/usermgmt.conf
47or using the
48.Fl D
49option to
50.Xr useradd 8 .
51.Bl -tag -width preserveX
52.It Ic base_dir
53Sets the base directory name, in which new users' home directories
54are created when using the
55.Fl m
56option to
57.Xr useradd 8 .
58.It Ic class
59Sets the default login class for new users.
60See
61.Xr login.conf 5
62for more information on user login classes.
63.It Ic expire
64Sets the default time at which the new accounts expire.
65Both the
66.Ar expire
67and
68.Ar inactive
69fields should be entered in the form
70.Dq month day year ,
71where month is the month name (the first three characters are
72sufficient), day is the day of the month, and year is the year.
73Time in seconds since the Epoch (UTC) is also valid.
74A value of 0 can be used to disable this feature.
75.It Ic group
76Sets the default primary group for new users.
77If this is
78.Ql =uid ,
79then a UID and GID will be picked which are both unique
80and the same, and a line added to
81.Pa /etc/group
82to describe the new group.
83It has the format:
84.Bd -ragged -offset indent
85.Ic group
86.Ar gid | name | Li =uid
87.Ed
88.It Ic inactive
89Sets the default time at which the passwords of new accounts expire.
90A value of 0 can be used to disable this feature.
91Also see the
92.Ar expire
93field.
94.It Ic password
95Specifies a default password encrypted with
96.Xr encrypt 1 .
97.It Ic preserve
98If this value is one of
99.Ql true ,
100.Ql yes ,
101or a non-zero number, then the user login information will be
102preserved when removing a user with
103.Xr userdel 8 .
104.It Ic range
105Specifies the UID boundaries for new users.
106If unspecified, the default is
107.Dq 1000..60000 .
108It has the format:
109.Bd -unfilled -offset indent
110.Ic range Ar starting-uid Ns Li .. Ns Ar ending-uid
111.Ed
112.It Ic shell
113Sets the default login shell for new users.
114.It Ic skel_dir
115Sets the default skeleton directory in which to find files
116with which to populate the new user's home directory.
117.El
118.Sh FILES
119.Bl -tag -width /etc/usermgmt.conf -compact
120.It Pa /etc/usermgmt.conf
121.It Pa /etc/skel/*
122.It Pa /etc/login.conf
123.El
124.Sh SEE ALSO
125.Xr login.conf 5 ,
126.Xr passwd 5 ,
127.Xr user 8 ,
128.Xr useradd 8 ,
129.Xr userdel 8 ,
130.Xr usermod 8
131.Sh STANDARDS
132Other implementations of the
133.Xr user 8
134utilities use the
135.Ar inactive-time
136parameter to refer to the maximum number of days allowed between logins (this
137is used to lock "stale" accounts that have not been used for a period of time).
138However, on
139.Ox
140systems this parameter refers instead to the password change time.
141This is due to differences in the
142.Xr passwd 5
143database compared to other operating systems.
144.Sh HISTORY
145The
146.Nm
147configuration file first appeared in
148.Ox 2.7 .
149