intro.1, _exit.2, access.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bind.2, chdir...

[thirdparty/man-pages.git] / man2 / rmdir.2

.\" This manpage is Copyright (C) 1992 Drew Eckhardt;
.\"                               1993 Michael Haardt, Ian Jackson.
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
.\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
.\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.TH RMDIR 2 2008-05-08 "Linux" "Linux Programmer's Manual"
.SH NAME
rmdir \- delete a directory
.SH SYNOPSIS
.B #include <unistd.h>
.sp
.BI "int rmdir(const char *" pathname );
.SH DESCRIPTION
.BR rmdir ()
deletes a directory, which must be empty.
.SH RETURN VALUE
On success, zero is returned.
On error, \-1 is returned, and
.I errno
is set appropriately.
.SH ERRORS
.TP
.B EACCES
Write access to the directory containing
.I pathname
was not allowed, or one of the directories in the path prefix of
.I pathname
did not allow search permission.
(See also
.BR path_resolution (7).
.TP
.B EBUSY
.I pathname
is currently in use by the system or some process that prevents its
removal.
On Linux this means
.I pathname
is currently used as a mount point
or is the root directory of the calling process.
.TP
.B EFAULT
.IR pathname " points outside your accessible address space."
.TP
.B EINVAL
.I pathname
has
.I .
as last component.
.TP
.B ELOOP
Too many symbolic links were encountered in resolving
.IR pathname .
.TP
.B ENAMETOOLONG
.IR pathname " was too long."
.TP
.B ENOENT
A directory component in
.I pathname
does not exist or is a dangling symbolic link.
.TP
.B ENOMEM
Insufficient kernel memory was available.
.TP
.B ENOTDIR
.IR pathname ,
or a component used as a directory in
.IR pathname ,
is not, in fact, a directory.
.TP
.B ENOTEMPTY
.I pathname
contains entries other than
.IR . " and " .. " ;"
or,
.I pathname
has
.I ..
as its final component.
POSIX.1-2001 also allows
.B EEXIST
for this condition.
.TP
.B EPERM
The directory containing
.I pathname
has the sticky bit
.RB ( S_ISVTX )
set and the process's effective user ID is neither the user ID
of the file to be deleted nor that of the directory containing it,
and the process is not privileged (Linux: does not have the
.B CAP_FOWNER
capability).
.TP
.B EPERM
The file system containing
.I pathname
does not support the removal of directories.
.TP
.B EROFS
.I pathname
refers to a directory on a read-only file system.
.SH CONFORMING TO
SVr4, 4.3BSD, POSIX.1-2001.
.SH BUGS
Infelicities in the protocol underlying NFS can cause the unexpected
disappearance of directories which are still being used.
.SH SEE ALSO
.BR rm (1),
.BR rmdir (1),
.BR chdir (2),
.BR chmod (2),
.BR mkdir (2),
.BR rename (2),
.BR unlink (2),
.BR unlinkat (2)