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