xref: /openbsd-src/usr.sbin/user/user.8 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\" $OpenBSD: user.8,v 1.8 2001/08/02 18:37:35 mpech Exp $ */
2.\" $NetBSD: user.8,v 1.5 2000/02/28 05:10:57 enami Exp $ */
3.\"
4.\"
5.\" Copyright (c) 1999 Alistair G. Crooks.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by Alistair G. Crooks.
18.\" 4. The name of the author may not be used to endorse or promote
19.\"    products derived from this software without specific prior written
20.\"    permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
23.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
26.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
28.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
30.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33.\"
34.\"
35.Dd November 30, 1999
36.Dt USER 8
37.Os
38.Sh NAME
39.Nm user
40.Nd manage user login information on the system
41.Sh SYNOPSIS
42.Nm user add
43.Op Fl D
44.Op Fl b Ar base-dir
45.Op Fl e Ar expiry-time
46.Op Fl f Ar inactive-secs
47.Op Fl g Ar gid/name/=uid
48.Op Fl r Ar low..high
49.Nm user add
50.Op Fl G Ar secondary-group
51.Op Fl b Ar base-dir
52.Op Fl c Ar comment
53.Op Fl d Ar home-dir
54.Op Fl e Ar expiry-time
55.Op Fl f Ar inactive-secs
56.Op Fl g Ar gid/name/=uid
57.Op Fl k Ar skel-dir
58.Op Fl m
59.Op Fl o
60.Op Fl p Ar password
61.Op Fl r Ar low..high
62.Op Fl s Ar shell
63.Op Fl u Ar uid
64.Op Fl v
65.Ar user
66.Nm user del
67.Op Fl D
68.Op Fl p Ar preserve-value
69.Nm user del
70.Op Fl p
71.Op Fl r
72.Op Fl v
73.Ar user
74.Nm user info
75.Op Fl e
76.Op Fl v
77.Ar user
78.Nm user mod
79.Op Fl G Ar secondary-group
80.Op Fl c Ar comment
81.Op Fl d Ar home-dir
82.Op Fl e Ar expiry-time
83.Op Fl f Ar inactive-secs
84.Op Fl g Ar gid/name/=uid
85.Op Fl l Ar new-login
86.Op Fl m
87.Op Fl o
88.Op Fl p Ar password
89.Op Fl s Ar shell
90.Op Fl u Ar uid
91.Op Fl v
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, please see the relevant manual page.
105.Pp
106The
107.Nm
108utility exits 0 on success, and >0 if an error occurs.
109.Sh FILES
110.Bl -tag -width /etc/usermgmt.conf -compact
111.It Pa /etc/skel/.[A-z]*
112Skelton dot files for new user
113.It Pa /etc/usermgmt.conf
114Configuration file for
115.Xr user 8 ,
116.Xr group 8
117and those backend commands
118.El
119.Sh SEE ALSO
120.Xr chpass 1 ,
121.Xr group 5 ,
122.Xr passwd 5 ,
123.Xr useradd 8 ,
124.Xr userdel 8 ,
125.Xr userinfo 8 ,
126.Xr usermod 8
127.Sh HISTORY
128The
129.Nm
130utility first appeared in
131.Ox 2.7 .
132.Sh AUTHORS
133The
134.Nm
135utility was written by Alistair G. Crooks (agc@netbsd.org).
136