usr/src/man/man1m/userdel.1m

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1999,
   3 .\" Sun Microsystems, Inc.  All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH USERDEL 1M "Feb 25, 2017"
   8 .SH NAME
   9 userdel \- delete a user's login from the system
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBuserdel\fR [\fB-r\fR] \fIlogin\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .LP
  18 The \fBuserdel\fR utility deletes a user account from the system and makes the
  19 appropriate account-related changes to the system file and file system.
  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 user'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 .sp
  33 If the user's home directory is located on a separate \fBZFS\fR file system and
  34 the \fB/etc/default/useradd\fR file contains the parameter \fBMANAGE_ZFS\fR set
  35 to the value \fBYES\fR, the file system will be destroyed.
  36 .RE
  37
  38 .SH OPERANDS
  39 .LP
  40 The following operands are supported:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB\fIlogin\fR\fR\fR
  45 .ad
  46 .RS 9n
  47 An existing login name to be deleted.
  48 .RE
  49
  50 .SH EXIT STATUS
  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
  61
  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 \fBuserdel\fR command is
  69 displayed.
  70 .RE
  71
  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
  80
  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
  89
  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
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fB12\fR\fR
 104 .ad
 105 .RS 6n
 106 Cannot remove or otherwise modify the home directory.
 107 .RE
 108
 109 .SH FILES
 110 .ne 2
 111 .na
 112 \fB\fB/etc/default/useradd\fR\fR
 113 .ad
 114 .RS 18n
 115 useradd, usermod and userdel configuration file
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB/etc/passwd\fR\fR
 122 .ad
 123 .RS 18n
 124 system password file
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fB/etc/shadow\fR\fR
 131 .ad
 132 .RS 18n
 133 system file contain users' encrypted passwords and related information
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fB/etc/group\fR\fR
 140 .ad
 141 .RS 18n
 142 system file containing group definitions
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB/etc/user_attr\fR\fR
 149 .ad
 150 .RS 18n
 151 system file containing additional user attributes
 152 .RE
 153
 154 .SH SEE ALSO
 155 .LP
 156 \fBauths\fR(1), \fBpasswd\fR(1), \fBprofiles\fR(1), \fBroles\fR(1),
 157 \fBusers\fR(1B), \fBgroupadd\fR(1M), \fBgroupdel\fR(1M), \fBgroupmod\fR(1M),
 158 \fBlogins\fR(1M), \fBroleadd\fR(1M), \fBrolemod\fR(1M), \fBuseradd\fR(1M),
 159 \fBuserdel\fR(1M), \fBusermod\fR(1M), \fBpasswd\fR(4), \fBprof_attr\fR(4),
 160 \fBuser_attr\fR(4), \fBattributes\fR(5), \fBzfs\fR(1M)
 161 .SH NOTES
 162 .LP
 163 The \fBuserdel\fR utility only deletes an account definition that is in the
 164 local \fB/etc/group\fR, \fB/etc/passwd\fR, \fB/etc/shadow\fR, and
 165 \fB/etc/user_attr\fR file. file. If a network name service
 166 is being used to supplement the local \fB/etc/passwd\fR file with
 167 additional entries, \fBuserdel\fR cannot change information supplied by the
 168 network name service.