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