Drop main() prototype. Syncs with NetBSD-8
[minix.git] / usr.sbin / user / userdel.8
blob9758fc5c825a5c235816c4f4e559884db12bbd83
1 .\" $NetBSD: userdel.8,v 1.33 2014/09/19 16:02:59 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 USERDEL 8
32 .Os
33 .Sh NAME
34 .Nm userdel
35 .Nd remove a user from the system
36 .Sh SYNOPSIS
37 .Nm
38 .Fl D
39 .Op Fl p Ar preserve-value
40 .Nm
41 .Op Fl rSv
42 .Op Fl p Ar preserve-value
43 .Ar user
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility removes a user from the system, optionally
48 removing that user's home directory and any subdirectories.
49 .Pp
50 Default values are taken from the information provided in the
51 .Pa /etc/usermgmt.conf
52 file, which, if running as root, is created using the built-in
53 defaults if it does not exist.
54 .Pp
55 The first form of the command shown above (using the
56 .Fl D
57 option) sets and displays the defaults for the
58 .Nm
59 utility.
60 .Pp
61 See
62 .Xr user 8
63 for more information about
64 .Dv EXTENSIONS .
65 .Bl -tag -width Ds
66 .It Fl D
67 Without any further options,
68 .Fl D
69 will show the current defaults which will be used by the
70 .Nm
71 utility.
72 Together with one of the options shown for the first version
73 of the command,
74 .Fl D
75 will set the default to be the new value.
76 This option is included if built with
77 .Dv EXTENSIONS .
78 .It Fl p Ar preserve-value
79 Set the preservation value.
80 If this value is one of
81 .Ql true ,
82 .Ql yes ,
83 or a non-zero number, then the user login information will be
84 preserved.
85 This option is included if built with
86 .Dv EXTENSIONS .
87 .El
88 .Pp
89 In the second form of the command,
90 after setting any defaults, and then reading values from
91 .Pa /etc/usermgmt.conf ,
92 the following command line options are processed:
93 .Bl -tag -width Ds
94 .It Fl p Ar preserve-value
95 Preserve the user information in the password file,
96 but do not allow the user to login, by switching the
97 password to an
98 .Dq impossible
99 one, and by setting the user's shell to the
100 .Xr nologin 8
101 program.
102 This option can be helpful in preserving a user's
103 files for later use by members of that person's
104 group after the user has moved on.
105 This value can also be set in the
106 .Pa /etc/usermgmt.conf
107 file, using the
108 .Ql preserve
109 field.
110 If the field has any of the values
111 .Ql true ,
112 .Ql yes ,
113 or a non-zero number, then user information preservation will take
114 place.
115 This option is included if built with
116 .Dv EXTENSIONS .
117 .It Fl r
118 Remove the user's home directory, any subdirectories,
119 and any files and other entries in them.
120 .It Fl S
121 Allow a samba user name (with a trailing dollar sign)
122 to be deleted.
123 This option is included if built with
124 .Dv EXTENSIONS .
125 .It Fl v
126 Perform any actions in a verbose manner.
127 This option is included if built with
128 .Dv EXTENSIONS .
131 Once the information has been verified,
133 uses
134 .Xr pwd_mkdb 8
135 to update the user database.
136 This is run in the background, and,
137 at very large sites could take several minutes.
138 Until this update
139 is completed, the password file is unavailable for other updates
140 and the new information is not available to programs.
141 .Sh FILES
142 .Bl -tag -width /etc/usermgmt.conf -compact
143 .It Pa /etc/usermgmt.conf
145 .Sh EXIT STATUS
146 .Ex -std userdel
147 .Sh SEE ALSO
148 .Xr passwd 5 ,
149 .Xr usermgmt.conf 5 ,
150 .Xr group 8 ,
151 .Xr nologin 8 ,
152 .Xr pwd_mkdb 8 ,
153 .Xr user 8 ,
154 .Xr useradd 8
155 .Sh HISTORY
158 utility first appeared in
159 .Nx 1.5 .
160 It is based on the
161 .Ar addnerd
162 package by the same author.
163 .Sh AUTHORS
166 utility was written by
167 .An Alistair G. Crooks
168 .Aq agc@NetBSD.org .