usr/src/lib/libc/sys/rmdir.2

.\" Copyright (c) 1983 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted provided
.\" that: (1) source distributions retain this entire copyright notice and
.\" comment, and (2) distributions including binaries display the following
.\" acknowledgement:  ``This product includes software developed by the
.\" University of California, Berkeley and its contributors'' in the
.\" documentation or other materials provided with the distribution and in
.\" all advertising materials mentioning features or use of this software.
.\" Neither the name of the University nor the names of its contributors may
.\" be used to endorse or promote products derived from this software without
.\" specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"     @(#)rmdir.2     6.5 (Berkeley) 6/23/90
.\"
.TH RMDIR 2 "June 23, 1990"
.UC 5
.SH NAME
rmdir \- remove a directory file
.SH SYNOPSIS
.nf
.ft B
rmdir(path)
char *path;
.fi
.ft R
.SH DESCRIPTION
.I Rmdir
removes a directory file
whose name is given by
.I path.
The directory must not have any entries other
than \*(lq.\*(rq and \*(lq..\*(rq.
.SH "RETURN VALUE
A 0 is returned if the remove succeeds; otherwise a \-1 is
returned and an error code is stored in the global location \fIerrno\fP\|.
.SH ERRORS
The named file is removed unless one or more of the
following are true:
.TP 15
[ENOTDIR]
A component of the path is not a directory.
.TP 15
[EINVAL]
The pathname contains a character with the high-order bit set.
.TP 15
[ENAMETOOLONG]
A component of a pathname exceeded 255 characters,
or an entire path name exceeded 1023 characters.
.TP 15
[ENOENT]
The named directory does not exist.
.TP 15
[ELOOP]
Too many symbolic links were encountered in translating the pathname.
.TP 15
[ENOTEMPTY]
The named directory contains files other than ``.'' and ``..'' in it.
.TP 15
[EACCES]
Search permission is denied for a component of the path prefix.
.TP 15
[EACCES]
Write permission is denied on the directory containing the link
to be removed.
.TP 15
[EPERM]
The directory containing the directory to be removed is marked sticky,
and neither the containing directory nor the directory to be removed
are owned by the effective user ID.
.TP 15
[EBUSY]
The directory to be removed is the mount point
for a mounted file system.
.TP 15
[EIO]
An I/O error occurred while deleting the directory entry
or deallocating the inode.
.TP 15
[EROFS]
The directory entry to be removed resides on a read-only file system.
.TP 15
[EFAULT]
.I Path
points outside the process's allocated address space.
.SH "SEE ALSO"
mkdir(2), unlink(2)