usr.sbin/user/usermgmt.conf.5

   1 .\" $NetBSD: usermgmt.conf.5,v 1.6 2009/12/31 19:59:31 mlelstv 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 December 31, 2009
  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
  43 The
  44 .Nm usermgmt.conf
  45 file defines the default values used by the user management tools,
  46 .Xr useradd 8
  47 and friends.
  48 .Pp
  49 Options in this file can be set by manually editing
  50 .Pa /etc/usermgmt.conf
  51 or using the
  52 .Fl D
  53 option to
  54 .Xr useradd 8 .
  55 .Pp
  56 .Bl -tag -width preserveX
  57 .It Ic base_dir
  58 sets the base directory name, in which new users' home directories
  59 are created when using the
  60 .Fl m
  61 option to
  62 .Xr useradd 8 .
  63 .It Ic class
  64 sets the default login class for new users.
  65 See
  66 .Xr login.conf 5
  67 for more information on user login classes.
  68 .It Ic expire
  69 sets the default time at which the current password expires.
  70 This can be used to implement password aging.
  71 Both the
  72 .Ar expire
  73 and
  74 .Ar inactive
  75 fields should be entered in the form
  76 .Dq month day year ,
  77 where month is the month name (the first three characters are
  78 sufficient), day is the day of the month, and year is the year.
  79 Time in seconds since the epoch (UTC) is also valid.
  80 A value of 0 can be used to disable this feature.
  81 .It Ic group
  82 sets the default primary group for new users.
  83 If this is
  84 .Ql =uid ,
  85 then a uid and gid will be picked which are both unique
  86 and the same, and a line will be added to
  87 .Pa /etc/group
  88 to describe the new group.
  89 It 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
  96 sets the default permissions of the newly created home directory if
  97 .Fl m
  98 is given to
  99 .Xr useradd 8 .
 100 The permission is specified as an octal number, with or without a leading zero.
 101 .It Ic inactive
 102 sets the default time at which new accounts expire.
 103 A value of 0 can be used to disable this feature.
 104 Also see the
 105 .Ar expire
 106 field.
 107 .It Ic password
 108 specifies an already-encrypted default password.
 109 .It Ic preserve
 110 If this value is one of
 111 .Ql true ,
 112 .Ql yes ,
 113 or a non-zero number, then the user login information will be
 114 preserved when removing a user with
 115 .Xr userdel 8 .
 116 .It Ic range
 117 specifies the uid boundaries for new users.
 118 If unspecified, the default is
 119 .Dq 1000..60000 .
 120 It 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
 125 specifies the gid boundaries for new groups.
 126 If unspecified, the default is
 127 .Dq 1000..60000 .
 128 It 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
 133 sets the default login shell for new users.
 134 .It Ic skel_dir
 135 sets the default skeleton directory in which to find files
 136 with which to populate the new user's home directory.
 137 .El
 138 .Sh FILES
 139 .Bl -tag -width /etc/usermgmt.conf -compact
 140 .It Pa /etc/usermgmt.conf
 141 .It Pa /etc/skel/*
 142 .It Pa /etc/login.conf
 143 .El
 144 .Sh SEE ALSO
 145 .Xr login.conf 5 ,
 146 .Xr passwd 5 ,
 147 .Xr user 8 ,
 148 .Xr useradd 8 ,
 149 .Xr userdel 8 ,
 150 .Xr usermod 8
 151 .Sh HISTORY
 152 The
 153 .Nm
 154 configuration file first appeared in
 155 .Nx 1.5 .