1.\" $NetBSD: usermgmt.conf.5,v 1.8 2016/02/09 14:14:02 wiz Exp $ 2.\" 3.\" Copyright (c) 2002 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This document is derived from works contributed to The NetBSD Foundation 7.\" by Grant Beattie. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. The name of the author may not be used to endorse or promote products 18.\" derived from this software without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd February 9, 2016 33.Dt USERMGMT.CONF 5 34.Os 35.\" turn off hyphenation 36.hym 999 37.Sh NAME 38.Nm usermgmt.conf 39.Nd user management tools configuration file 40.Sh SYNOPSIS 41.Nm usermgmt.conf 42.Sh DESCRIPTION 43The 44.Nm usermgmt.conf 45file defines the default values used by the user management tools, 46.Xr useradd 8 47and friends. 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 current password expires. 70This can be used to implement password aging. 71Both the 72.Ar expire 73and 74.Ar inactive 75fields should be entered in the form 76.Dq month day year , 77where month is the month name (the first three characters are 78sufficient), day is the day of the month, and year is the year. 79Time in seconds since the epoch (UTC) is also valid. 80A value of 0 can be used to disable this feature. 81.It Ic group 82sets the default primary group for new users. 83If this is 84.Ql =uid , 85then a uid and gid will be picked which are both unique 86and the same, and a line will be added to 87.Pa /etc/group 88to describe the new group. 89It has the format: 90.br 91.Bd -ragged -offset indent -compact 92.Ic group 93.Ar gid | name | Li =uid 94.Ed 95.It Ic homeperm 96sets the default permissions of the newly created home directory if 97.Fl m 98is given to 99.Xr useradd 8 . 100The permission is specified as an octal number, with or without a leading zero. 101.It Ic inactive 102sets the default time at which new accounts expire. 103A value of 0 can be used to disable this feature. 104Also see the 105.Ar expire 106field. 107.It Ic password 108specifies an already-encrypted default password. 109.It Ic preserve 110If this value is one of 111.Ql true , 112.Ql yes , 113or a non-zero number, then the user login information will be 114preserved when removing a user with 115.Xr userdel 8 . 116.It Ic range 117specifies the uid boundaries for new users. 118If unspecified, the default is 119.Dq 1000..60000 . 120It has the format: 121.Bd -unfilled -offset indent -compact 122.Ic range Ar starting-uid Ns Li .. Ns Ar ending-uid 123.Ed 124.It Ic gid_range 125specifies the gid boundaries for new groups. 126If unspecified, the default is 127.Dq 1000..60000 . 128It has the format: 129.Bd -unfilled -offset indent -compact 130.Ic gid_range Ar starting-gid Ns Li .. Ns Ar ending-gid 131.Ed 132.It Ic shell 133sets the default login shell for new users. 134.It Ic skel_dir 135sets the default skeleton directory in which to find files 136with which to populate the new user's home directory. 137.El 138.Ss SYNTAX 139The 140.Nm 141file uses a simple syntax format. 142Each line must contain one option. 143That option must be in the front of the line (no spaces). 144Any number of white spaces such as ' ' and '\et' may follow. 145The line ends with a list of options from each. 146.Sh FILES 147.Bl -tag -width /etc/usermgmt.conf -compact 148.It Pa /etc/usermgmt.conf 149.It Pa /etc/skel/* 150.It Pa /etc/login.conf 151.El 152.Sh EXAMPLES 153.Bd -unfilled -offset indent -compact 154group wheel 155base_dir /home/ 156skel_dir /etc/skel 157shell /bin/sh 158inactive 0 159.Ed 160.Sh SEE ALSO 161.Xr login.conf 5 , 162.Xr passwd 5 , 163.Xr user 8 , 164.Xr useradd 8 , 165.Xr userdel 8 , 166.Xr usermod 8 167.Sh HISTORY 168The 169.Nm 170configuration file first appeared in 171.Nx 1.5 . 172