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