Merge commit 'dfc115332c94a2f62058ac7f2bce7631fbd20b3d'
[unleashed/tickless.git] / share / man / man1m / roledel.1m
blob4827c6ac1a70eab2128fa77b5a96ba78f0c9832e
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 "Feb 25, 2017"
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 .LP
17 The \fBroledel\fR utility deletes a role account from the system and makes the
18 appropriate account-related changes to the system file and file system.
19 \fBroledel\fR also removes the role from each user's list of assumable roles.
20 .SH OPTIONS
21 .LP
22 The following options are supported:
23 .sp
24 .ne 2
25 .na
26 \fB\fB-r\fR\fR
27 .ad
28 .RS 6n
29 Remove the role's home directory from the system. This directory must exist.
30 The files and directories under the home directory will no longer be accessible
31 following successful execution of the command.
32 .RE
34 .SH OPERANDS
35 .LP
36 The following operands are supported:
37 .sp
38 .ne 2
39 .na
40 \fB\fIrole\fR\fR
41 .ad
42 .RS 8n
43 An existing role name to be deleted.
44 .RE
46 .SH EXIT STATUS
47 .LP
48 The following exit values are returned:
49 .sp
50 .ne 2
51 .na
52 \fB\fB0\fR\fR
53 .ad
54 .RS 6n
55 Successful completion.
56 .RE
58 .sp
59 .ne 2
60 .na
61 \fB\fB2\fR\fR
62 .ad
63 .RS 6n
64 Invalid command syntax. A usage message for the \fBroledel\fR command is
65 displayed.
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB6\fR\fR
72 .ad
73 .RS 6n
74 The account to be removed does not exist.
75 .RE
77 .sp
78 .ne 2
79 .na
80 \fB\fB8\fR\fR
81 .ad
82 .RS 6n
83 The account to be removed is in use.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fB10\fR\fR
90 .ad
91 .RS 6n
92 Cannot update the \fB/etc/group\fR or \fB/etc/user_attr\fR file but the login
93 is removed from the \fB/etc/passwd\fR file.
94 .RE
96 .sp
97 .ne 2
98 .na
99 \fB\fB12\fR\fR
101 .RS 6n
102 Cannot remove or otherwise modify the home directory.
105 .SH FILES
106 .ne 2
108 \fB\fB/etc/passwd\fR\fR
110 .RS 18n
111 system password file
115 .ne 2
117 \fB\fB/etc/shadow\fR\fR
119 .RS 18n
120 system file containing roles' encrypted passwords and related information
124 .ne 2
126 \fB\fB/etc/group\fR\fR
128 .RS 18n
129 system file containing group definitions
133 .ne 2
135 \fB\fB/etc/user_attr\fR\fR
137 .RS 18n
138 system file containing additional role attributes
141 .SH SEE ALSO
143 \fBauths\fR(1), \fBpasswd\fR(1), \fBprofiles\fR(1), \fBroles\fR(1),
144 \fBusers\fR(1B), \fBgroupadd\fR(1M), \fBgroupdel\fR(1M), \fBgroupmod\fR(1M),
145 \fBlogins\fR(1M), \fBroleadd\fR(1M), \fBrolemod\fR(1M), \fBuseradd\fR(1M),
146 \fBuserdel\fR(1M), \fBusermod\fR(1M), \fBpasswd\fR(4), \fBprof_attr\fR(4),
147 \fBuser_attr\fR(4), \fBattributes\fR(5)
148 .SH NOTES
150 The \fBroledel\fR utility only deletes an account definition that is in the
151 local \fB/etc/group\fR, \fB/etc/passwd\fR, \fB/etc/shadow\fR, and
152 \fB/etc/user_attr\fR file. file. If a network name service
153 is being used to supplement the local \fB/etc/passwd\fR file with
154 additional entries, \fBroledel\fR cannot change information supplied by the
155 network name service.