xref: /openbsd-src/usr.sbin/user/user.8 (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1.\" $OpenBSD: user.8,v 1.20 2011/07/18 23:01:10 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: July 18 2011 $
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.Bk -words
43.Cm add
44.Fl D
45.Op Fl b Ar base-directory
46.Op Fl e Ar expiry-time
47.Op Fl f Ar inactive-time
48.Op Fl g Ar gid | name | Li =uid
49.Op Fl k Ar skel-directory
50.Op Fl L Ar login-class
51.Op Fl r Ar low Ns .. Ns Ar high
52.Op Fl s Ar shell
53.Ek
54.Nm user
55.Bk -words
56.Cm add
57.Op Fl mov
58.Op Fl b Ar base-directory
59.Op Fl c Ar comment
60.Op Fl d Ar home-directory
61.Op Fl e Ar expiry-time
62.Op Fl f Ar inactive-time
63.Op Fl G Ar secondary-group Ns Op , Ns Ar group , Ns ...
64.Op Fl g Ar gid | name | Li =uid
65.Op Fl k Ar skel-directory
66.Op Fl L Ar login-class
67.Op Fl p Ar password
68.Op Fl r Ar low Ns .. Ns Ar high
69.Op Fl s Ar shell
70.Op Fl u Ar uid
71.Ar user
72.Ek
73.Nm user
74.Cm del
75.Fl D
76.Op Fl p Ar preserve-value
77.Nm user
78.Cm del
79.Op Fl prv
80.Ar user
81.Nm user
82.Cm info
83.Op Fl e
84.Ar user
85.Nm user
86.Bk -words
87.Cm mod
88.Op Fl mov
89.Op Fl c Ar comment
90.Op Fl d Ar home-directory
91.Op Fl e Ar expiry-time
92.Op Fl f Ar inactive-time
93.Op Fl G Ar secondary-group Ns Op , Ns Ar group , Ns ...
94.Op Fl g Ar gid | name | Li =uid
95.Op Fl L Ar login-class
96.Op Fl l Ar new-login
97.Op Fl p Ar password
98.Op Fl s Ar shell
99.Op Fl u Ar uid
100.Ar user
101.Ek
102.Sh DESCRIPTION
103The
104.Nm
105utility acts as a frontend to the
106.Xr useradd 8 ,
107.Xr usermod 8 ,
108.Xr userinfo 8 ,
109and
110.Xr userdel 8
111commands.
112.Pp
113For a full explanation of the options, please see the relevant manual page.
114.Sh FILES
115.Bl -tag -width /etc/usermgmt.conf -compact
116.It Pa /etc/skel/.[A-z]*
117Skeleton files for new user
118.It Pa /etc/usermgmt.conf
119Configuration file for
120.Nm user ,
121.Xr group 8
122and those backend commands
123.El
124.Sh EXIT STATUS
125.Ex -std user
126.Sh SEE ALSO
127.Xr chpass 1 ,
128.Xr group 5 ,
129.Xr passwd 5 ,
130.Xr usermgmt.conf 5 ,
131.Xr useradd 8 ,
132.Xr userdel 8 ,
133.Xr userinfo 8 ,
134.Xr usermod 8
135.Sh STANDARDS
136Other implementations of the
137.Nm user
138utilities use the
139.Ar inactive-time
140parameter to refer to the maximum number of days allowed between logins (this
141is used to lock "stale" accounts that have not been used for a period of time).
142However, on
143.Ox
144systems this parameter refers instead to the password change time.
145This is due to differences in the
146.Xr passwd 5
147database compared to other operating systems.
148.Sh HISTORY
149The
150.Nm
151utility first appeared in
152.Ox 2.7 .
153.Sh AUTHORS
154The
155.Nm
156utility was written by
157.An Alistair G. Crooks Aq agc@NetBSD.org .
158