xref: /netbsd/usr.sbin/user/user.8 (revision bf9ec67e)
1.\" $NetBSD: user.8,v 1.12 2002/02/08 01:38:57 ross Exp $ */
2.\"
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 September 5, 2001
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 ""
42.Cm add
43.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 L Ar login-class
49.Op Fl r Ar low..high
50.Nm ""
51.Cm add
52.Op Fl mov
53.Op Fl G Ar secondary-group
54.Op Fl b Ar base-dir
55.Op Fl c Ar comment
56.Op Fl d Ar home-dir
57.Op Fl e Ar expiry-time
58.Op Fl f Ar inactive-secs
59.Op Fl g Ar gid/name/=uid
60.Op Fl k Ar skel-dir
61.Op Fl L Ar login-class
62.Op Fl p Ar password
63.Op Fl r Ar low..high
64.Op Fl s Ar shell
65.Op Fl u Ar uid
66.Ar user
67.Nm ""
68.Cm del
69.Fl D
70.Op Fl p Ar preserve-value
71.Nm ""
72.Cm del
73.Op Fl prv
74.Ar user
75.Nm ""
76.Cm info
77.Op Fl ev
78.Ar user
79.Nm ""
80.Cm mod
81.Op Fl mov
82.Op Fl G Ar secondary-group
83.Op Fl c Ar comment
84.Op Fl d Ar home-dir
85.Op Fl e Ar expiry-time
86.Op Fl f Ar inactive-secs
87.Op Fl g Ar gid/name/=uid
88.Op Fl L Ar login-class
89.Op Fl l Ar new-login
90.Op Fl p Ar password
91.Op Fl s Ar shell
92.Op Fl u Ar uid
93.Ar user
94.Sh DESCRIPTION
95The
96.Nm
97utility acts as a frontend to the
98.Xr useradd 8 ,
99.Xr usermod 8 ,
100.Xr userinfo 8 ,
101and
102.Xr userdel 8
103commands.
104.Pp
105For a full explanation of the options, please see the relevant manual page.
106.Pp
107The
108.Nm
109utility exits 0 on success, and \*[Gt]0 if an error occurs.
110.Sh FILES
111.Bl -tag -width /usr/share/examples/usermgmt -compact
112.It Pa /etc/skel/.[A-z]*
113Skeleton files for new user
114.It Pa /etc/usermgmt.conf
115Configuration file for
116.Xr user 8 ,
117.Xr group 8
118and those backend commands
119.It Pa /usr/share/examples/usermgmt
120A directory containing examples for
121.Xr user 8
122and
123.Xr group 8
124.El
125.Sh SEE ALSO
126.Xr chpass 1 ,
127.Xr group 5 ,
128.Xr passwd 5 ,
129.Xr useradd 8 ,
130.Xr userdel 8 ,
131.Xr userinfo 8 ,
132.Xr usermod 8
133.Sh HISTORY
134The
135.Nm
136utility first appeared in
137.Nx 1.5 .
138It is based on the
139.Ar addnerd
140package by the same author.
141.Sh AUTHORS
142The
143.Nm
144utility was written by Alistair G. Crooks (agc@netbsd.org).
145