Sync usage with man page.
[netbsd-mini2440.git] / usr.sbin / user / user.8
blobd206fb1157dcf842bddd78e39dbcb35ebb0c8535
1 .\" $NetBSD: user.8,v 1.22 2005/11/16 20:24:17 wiz Exp $ */
2 .\"
3 .\" Copyright (c) 1999 Alistair G. Crooks.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. The name of the author may not be used to endorse or promote
14 .\"    products derived from this software without specific prior written
15 .\"    permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
18 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .\"
29 .\"
30 .Dd November 16, 2005
31 .Dt USER 8
32 .Os
33 .Sh NAME
34 .Nm user
35 .Nd manage user login information on the system
36 .Sh SYNOPSIS
37 .Nm
38 .Cm add
39 .Fl D
40 .Op options
41 .Nm
42 .Cm add
43 .Op options
44 .Ar user
45 .Nm
46 .Cm del
47 .Fl D
48 .Op options
49 .Nm
50 .Cm del
51 .Op options
52 .Ar user
53 .Nm
54 .Cm info
55 .Op options
56 .Ar user
57 .Nm
58 .Cm mod
59 .Op options
60 .Ar user
61 .Sh DESCRIPTION
62 The
63 .Nm
64 utility acts as a frontend to the
65 .Xr useradd 8 ,
66 .Xr usermod 8 ,
67 .Xr userinfo 8 ,
68 and
69 .Xr userdel 8
70 commands.
71 The utilities by default are built with
72 .Dv EXTENSIONS .
73 This allows for further functionality.
74 .Pp
75 For a full explanation of the options available, please see the relevant manual page.
76 .Sh EXIT STATUS
77 .Ex -std user
78 .Sh FILES
79 .Bl -tag -width /usr/share/examples/usermgmt -compact
80 .It Pa /etc/skel/.[A-z]*
81 Skeleton files for new user
82 .It Pa /etc/usermgmt.conf
83 Configuration file for
84 .Nm ,
85 .Xr group 8
86 and the backend commands mentioned above.
87 .\" .It Pa /usr/share/examples/usermgmt
88 .\" A directory containing examples for
89 .\" .Nm
90 .\" and
91 .\" .Xr group 8 .
92 .El
93 .Sh SEE ALSO
94 .Xr chpass 1 ,
95 .Xr group 5 ,
96 .Xr passwd 5 ,
97 .Xr usermgmt.conf 5 ,
98 .Xr useradd 8 ,
99 .Xr userdel 8 ,
100 .Xr userinfo 8 ,
101 .Xr usermod 8
102 .Sh HISTORY
105 utility first appeared in
106 .Nx 1.5 .
107 It is based on the
108 .Ar addnerd
109 package by the same author.
110 .Sh AUTHORS
113 utility was written by
114 .An Alistair G. Crooks
115 .Aq agc@NetBSD.org .