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