2930 beadm should sort by creation date
[illumos-gate.git] / usr / src / man / man1m / roledel.1m
blob197b149830ea5b11788261359125de2db79294d8
1 '\" te
2 .\" Copyright 1989 AT&T  Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH ROLEDEL 1M "Sep 8, 1999"
7 .SH NAME
8 roledel \- delete a role's login from the system
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBroledel\fR [\fB-r\fR] \fIrole\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBroledel\fR utility deletes a role account from the system and makes the
19 appropriate account-related changes to the system file and file system.
20 \fBroledel\fR also removes the role from each user's list of assumable roles.
21 .SH OPTIONS
22 .sp
23 .LP
24 The following options are supported:
25 .sp
26 .ne 2
27 .na
28 \fB\fB-r\fR\fR
29 .ad
30 .RS 6n
31 Remove the role's home directory from the system. This directory must exist.
32 The files and directories under the home directory will no longer be accessible
33 following successful execution of the command.
34 .RE
36 .SH OPERANDS
37 .sp
38 .LP
39 The following operands are supported:
40 .sp
41 .ne 2
42 .na
43 \fB\fIrole\fR\fR
44 .ad
45 .RS 8n
46 An existing role name to be deleted.
47 .RE
49 .SH EXIT STATUS
50 .sp
51 .LP
52 The following exit values are returned:
53 .sp
54 .ne 2
55 .na
56 \fB\fB0\fR\fR
57 .ad
58 .RS 6n
59 Successful completion.
60 .RE
62 .sp
63 .ne 2
64 .na
65 \fB\fB2\fR\fR
66 .ad
67 .RS 6n
68 Invalid command syntax. A usage message for the \fBroledel\fR command is
69 displayed.
70 .RE
72 .sp
73 .ne 2
74 .na
75 \fB\fB6\fR\fR
76 .ad
77 .RS 6n
78 The account to be removed does not exist.
79 .RE
81 .sp
82 .ne 2
83 .na
84 \fB\fB8\fR\fR
85 .ad
86 .RS 6n
87 The account to be removed is in use.
88 .RE
90 .sp
91 .ne 2
92 .na
93 \fB\fB10\fR\fR
94 .ad
95 .RS 6n
96 Cannot update the \fB/etc/group\fR or \fB/etc/user_attr\fR file but the login
97 is removed from the \fB/etc/passwd\fR file.
98 .RE
101 .ne 2
103 \fB\fB12\fR\fR
105 .RS 6n
106 Cannot remove or otherwise modify the home directory.
109 .SH FILES
111 .ne 2
113 \fB\fB/etc/passwd\fR\fR
115 .RS 18n
116 system password file
120 .ne 2
122 \fB\fB/etc/shadow\fR\fR
124 .RS 18n
125 system file containing roles' encrypted passwords and related information
129 .ne 2
131 \fB\fB/etc/group\fR\fR
133 .RS 18n
134 system file containing group definitions
138 .ne 2
140 \fB\fB/etc/user_attr\fR\fR
142 .RS 18n
143 system file containing additional role attributes
146 .SH SEE ALSO
149 \fBauths\fR(1), \fBpasswd\fR(1), \fBprofiles\fR(1), \fBroles\fR(1),
150 \fBusers\fR(1B), \fBgroupadd\fR(1M), \fBgroupdel\fR(1M), \fBgroupmod\fR(1M),
151 \fBlogins\fR(1M), \fBroleadd\fR(1M), \fBrolemod\fR(1M), \fBuseradd\fR(1M),
152 \fBuserdel\fR(1M), \fBusermod\fR(1M), \fBpasswd\fR(4), \fBprof_attr\fR(4),
153 \fBuser_attr\fR(4), \fBattributes\fR(5)
154 .SH NOTES
157 The \fBroledel\fR utility only deletes an account definition that is in the
158 local \fB/etc/group\fR, \fB/etc/passwd\fR, \fB/etc/shadow\fR, and
159 \fB/etc/user_attr\fR file. file. If a network name service such as \fBNIS\fR or
160 \fBNIS+\fR is being used to supplement the local \fB/etc/passwd\fR file with
161 additional entries, \fBroledel\fR cannot change information supplied by the
162 network name service.