minix/man/man2/rmdir.2
2005-05-02 13:01:42 +00:00

77 lines
1.9 KiB
Groff

.\" Copyright (c) 1983 Regents of the University of California.
.\" All rights reserved. The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\"
.\" @(#)rmdir.2 6.3 (Berkeley) 8/26/85
.\"
.TH RMDIR 2 "August 26, 1985"
.UC 5
.SH NAME
rmdir \- remove a directory file
.SH SYNOPSIS
.nf
.ft B
#include <unistd.h>
int rmdir(const char *\fIpath\fP)
.fi
.ft R
.SH DESCRIPTION
.B 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
[ENAMETOOLONG]
The path name exceeds PATH_MAX characters.
.TP 15
[ENOENT]
The named directory does not exist.
.TP 15
[ELOOP]
Too many symbolic links were encountered in translating the pathname.
(Minix-vmd)
.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"
.BR mkdir (2),
.BR unlink (2).