xref: /openbsd/usr.sbin/user/user.8 (revision 9b7c3dbb)
1.\" $OpenBSD: user.8,v 1.22 2015/09/12 15:14:11 schwarze Exp $
2.\" $NetBSD: user.8,v 1.9 2001/06/05 11:31:21 wiz Exp $
3.\"
4.\" Copyright (c) 1999 Alistair G. Crooks.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by Alistair G. Crooks.
17.\" 4. The name of the author may not be used to endorse or promote
18.\"    products derived from this software without specific prior written
19.\"    permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
22.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
25.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\"
34.Dd $Mdocdate: September 12 2015 $
35.Dt USER 8
36.Os
37.Sh NAME
38.Nm user
39.Nd manage user login information on the system
40.Sh SYNOPSIS
41.Nm user
42.Cm add
43.Fl D
44.Op Fl b Ar base-directory
45.Op Fl e Ar expiry-time
46.Op Fl f Ar inactive-time
47.Op Fl g Ar gid | name | Cm =uid
48.Op Fl k Ar skel-directory
49.Op Fl L Ar login-class
50.Op Fl r Ar low Ns .. Ns Ar high
51.Op Fl s Ar shell
52.Nm user
53.Cm add
54.Op Fl mov
55.Op Fl b Ar base-directory
56.Op Fl c Ar comment
57.Op Fl d Ar home-directory
58.Op Fl e Ar expiry-time
59.Op Fl f Ar inactive-time
60.Op Fl G Ar secondary-group Ns Op , Ns Ar group , Ns ...
61.Op Fl g Ar gid | name | Cm =uid
62.Op Fl k Ar skel-directory
63.Op Fl L Ar login-class
64.Op Fl p Ar password
65.Op Fl r Ar low Ns .. Ns Ar high
66.Op Fl s Ar shell
67.Op Fl u Ar uid
68.Ar user
69.Nm user
70.Cm del
71.Fl D
72.Op Fl p Ar preserve-value
73.Nm user
74.Cm del
75.Op Fl prv
76.Ar user
77.Nm user
78.Cm info
79.Op Fl e
80.Ar user
81.Nm user
82.Cm mod
83.Op Fl mov
84.Op Fl c Ar comment
85.Op Fl d Ar home-directory
86.Op Fl e Ar expiry-time
87.Op Fl f Ar inactive-time
88.Op Fl G Ar secondary-group Ns Op , Ns Ar group , Ns ...
89.Op Fl g Ar gid | name | Cm =uid
90.Op Fl L Ar login-class
91.Op Fl l Ar new-login
92.Op Fl p Ar password
93.Op Fl s Ar shell
94.Op Fl u Ar uid
95.Ar user
96.Sh DESCRIPTION
97The
98.Nm
99utility acts as a frontend to the
100.Xr useradd 8 ,
101.Xr usermod 8 ,
102.Xr userinfo 8 ,
103and
104.Xr userdel 8
105commands.
106.Pp
107For a full explanation of the options, please see the relevant manual page.
108.Sh FILES
109.Bl -tag -width /etc/usermgmt.conf -compact
110.It Pa /etc/skel/.[A-z]*
111Skeleton files for new user
112.It Pa /etc/usermgmt.conf
113Configuration file for
114.Nm user ,
115.Xr group 8
116and those backend commands
117.El
118.Sh EXIT STATUS
119.Ex -std user
120.Sh SEE ALSO
121.Xr chpass 1 ,
122.Xr group 5 ,
123.Xr passwd 5 ,
124.Xr usermgmt.conf 5 ,
125.Xr useradd 8 ,
126.Xr userdel 8 ,
127.Xr userinfo 8 ,
128.Xr usermod 8
129.Sh STANDARDS
130Other implementations of the
131.Nm user
132utilities use the
133.Ar inactive-time
134parameter to refer to the maximum number of days allowed between logins (this
135is used to lock "stale" accounts that have not been used for a period of time).
136However, on
137.Ox
138systems this parameter refers instead to the password change time.
139This is due to differences in the
140.Xr passwd 5
141database compared to other operating systems.
142.Sh HISTORY
143The
144.Nm
145utility first appeared in
146.Ox 2.7 .
147.Sh AUTHORS
148The
149.Nm
150utility was written by
151.An Alistair G. Crooks Aq Mt agc@NetBSD.org .
152