BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / rmdir.2

diff --git a/usr/src/lib/libc/sys/rmdir.2 b/usr/src/lib/libc/sys/rmdir.2
index 5a845d5..9c05d9c 100644 (file)
--- a/usr/src/lib/libc/sys/rmdir.2
+++ b/usr/src/lib/libc/sys/rmdir.2
@@ -1,91 +1,106 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" 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.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. 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.

 .\"
 .\"

-.\"    @(#)rmdir.2     6.5 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.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
+.\"     @(#)rmdir.2    6.6 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt RMDIR 2
+.Os BSD 4.2
+.Sh NAME
+.Nm rmdir
+.Nd remove a directory file
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft int
+.Fn rmdir "const char *path"
+.Sh DESCRIPTION
+.Fn Rmdir

 removes a directory file
 whose name is given by
 removes a directory file
 whose name is given by

-.I path.
+.Fa path .

 The directory must not have any entries other
 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]
+than
+.Ql \&.
+and
+.Ql \&.. .
+.Sh RETURN VALUES
+A 0 is returned if the remove succeeds; otherwise a -1 is
+returned and an error code is stored in the global location
+.Va errno .
+.Sh ERRORS
+The named file is removed unless:
+.Bl -tag -width [ENAMETOOLONG]
+.It Bq Er ENOTDIR

 A component of the path is not a directory.
 A component of the path is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 The named directory does not exist.
 The named directory does not exist.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 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]
+.It Bq Er ENOTEMPTY
+The named directory contains files other than
+.Ql \&.
+and
+.Ql \&..
+in it.
+.It Bq Er EACCES

 Search permission is denied for a component of the path prefix.
 Search permission is denied for a component of the path prefix.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Write permission is denied on the directory containing the link
 to be removed.
 Write permission is denied on the directory containing the link
 to be removed.

-.TP 15
-[EPERM]
+.It Bq Er 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.
 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]
+.It Bq Er EBUSY

 The directory to be removed is the mount point
 for a mounted file system.
 The directory to be removed is the mount point
 for a mounted file system.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while deleting the directory entry
 or deallocating the inode.
 An I/O error occurred while deleting the directory entry
 or deallocating the inode.

-.TP 15
-[EROFS]
+.It Bq Er EROFS

 The directory entry to be removed resides on a read-only file system.
 The directory entry to be removed resides on a read-only file system.

-.TP 15
-[EFAULT]
-.I Path
+.It Bq Er EFAULT
+.Fa Path

 points outside the process's allocated address space.
 points outside the process's allocated address space.

-.SH "SEE ALSO"
-mkdir(2), unlink(2)
+.El
+.Sh SEE ALSO
+.Xr mkdir 2 ,
+.Xr unlink 2
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .