usr/src/man/man2/rmdir.2

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Copyright 1989 AT&T
   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 RMDIR 2 "May 18, 2007"
   8 .SH NAME
   9 rmdir \- remove a directory
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <unistd.h>
  14
  15 \fBint\fR \fBrmdir\fR(\fBconst char *\fR\fIpath\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBrmdir()\fR function removes the directory named by the path name pointed
  22 to by \fIpath\fR. The directory must not have any entries other than
  23 "\fB\&.\fR" and "\fB\&..\fR".
  24 .sp
  25 .LP
  26 If the directory's link count becomes zero and no process has the directory
  27 open, the space occupied by the directory is freed and the directory is no
  28 longer accessible. If one or more processes have the directory open when the
  29 last link is removed, the "\fB\&.\fR" and "\fB\&..\fR" entries, if present, are
  30 removed before \fBrmdir()\fR returns and no new entries may be created in the
  31 directory, but the directory is not removed until all references to the
  32 directory have been closed.
  33 .sp
  34 .LP
  35 Upon successful completion \fBrmdir()\fR marks for update the \fBst_ctime\fR
  36 and \fBst_mtime\fR fields of the parent directory.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  41 returned, \fBerrno\fR is set to indicate the error, and the named directory is
  42 not changed.
  43 .SH ERRORS
  44 .sp
  45 .LP
  46 The \fBrmdir()\fR function will fail if:
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBEACCES\fR\fR
  51 .ad
  52 .RS 16n
  53 Search permission is denied for a component of the path prefix and
  54 {\fBPRIV_FILE_DAC_SEARCH\fR} is not asserted in the effective set of the
  55 calling process
  56 .sp
  57 Write permission is denied on the directory containing the directory to be
  58 removed and {\fBPRIV_FILE_DAC_WRITE\fR} is not asserted.
  59 .sp
  60 The parent directory has the \fBS_ISVTX\fR variable set, is not owned by the
  61 user, and {\fBPRIV_FILE_OWNER\fR} is not asserted.
  62 .sp
  63 The directory is not owned by the user and is not writable by the user.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBEBUSY\fR\fR
  70 .ad
  71 .RS 16n
  72 The directory to be removed is the mount point for a mounted file system.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBEEXIST\fR\fR
  79 .ad
  80 .RS 16n
  81 The directory contains entries other than those for "\fB\&.\fR" and
  82 "\fB\&..\fR".
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBEFAULT\fR\fR
  89 .ad
  90 .RS 16n
  91 The \fIpath\fR argument points to an illegal address.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBEINVAL\fR\fR
  98 .ad
  99 .RS 16n
 100 The directory to be removed is the current directory, or the final component of
 101 \fIpath\fR is "\fB\&.\fR".
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBEILSEQ\fR\fR
 108 .ad
 109 .RS 16n
 110 The path argument includes non-UTF8 characters and the file system accepts only
 111 file names where all characters are part of the UTF-8 character codeset.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEIO\fR\fR
 118 .ad
 119 .RS 16n
 120 An I/O error occurred while accessing the file system.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBELOOP\fR\fR
 127 .ad
 128 .RS 16n
 129 Too many symbolic links were encountered in translating \fIpath\fR.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBENAMETOOLONG\fR\fR
 136 .ad
 137 .RS 16n
 138 The length of the \fIpath\fR argument exceeds \fBPATH_MAX\fR, or the length of
 139 a \fIpath\fR component exceeds \fINAME_MAX\fR while \fB_POSIX_NO_TRUNC\fR is in
 140 effect.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBENOENT\fR\fR
 147 .ad
 148 .RS 16n
 149 The named directory does not exist or is the null pathname.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBENOLINK\fR\fR
 156 .ad
 157 .RS 16n
 158 The \fIpath\fR argument points to a remote machine, and the connection to that
 159 machine is no longer active.
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fBENOTDIR\fR\fR
 166 .ad
 167 .RS 16n
 168 A component of the path prefix is not a directory.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fBEROFS\fR\fR
 175 .ad
 176 .RS 16n
 177 The directory entry to be removed is part of a read-only file system.
 178 .RE
 179
 180 .SH ATTRIBUTES
 181 .sp
 182 .LP
 183 See \fBattributes\fR(5) for descriptions of the following attributes:
 184 .sp
 185
 186 .sp
 187 .TS
 188 box;
 189 c | c
 190 l | l .
 191 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 192 _
 193 Interface Stability     Standard
 194 _
 195 MT-Level        Async-Signal-Safe
 196 .TE
 197
 198 .SH SEE ALSO
 199 .sp
 200 .LP
 201 \fBmkdir\fR(1), \fBrm\fR(1), \fBmkdir\fR(2), \fBattributes\fR(5),
 202 \fBprivileges\fR(5), \fBstandards\fR(5)