xref: /netbsd-src/lib/libc/sys/rmdir.2 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)rmdir.2	6.6 (Berkeley) 3/10/91
33.\"	$Id: rmdir.2,v 1.6 1994/04/22 00:13:47 jtc Exp $
34.\"
35.Dd March 10, 1991
36.Dt RMDIR 2
37.Os BSD 4.2
38.Sh NAME
39.Nm rmdir
40.Nd remove a directory file
41.Sh SYNOPSIS
42.Fd #include <unistd.h>
43.Ft int
44.Fn rmdir "const char *path"
45.Sh DESCRIPTION
46.Fn Rmdir
47removes a directory file
48whose name is given by
49.Fa path .
50The directory must not have any entries other
51than
52.Ql \&.
53and
54.Ql \&.. .
55.Sh RETURN VALUES
56A 0 is returned if the remove succeeds; otherwise a -1 is
57returned and an error code is stored in the global location
58.Va errno .
59.Sh ERRORS
60The named file is removed unless:
61.Bl -tag -width Er
62.It Bq Er ENOTDIR
63A component of the path is not a directory.
64.It Bq Er ENAMETOOLONG
65A component of a pathname exceeded
66.Dv {NAME_MAX}
67characters, or an entire path name exceeded
68.Dv {PATH_MAX}
69characters.
70.It Bq Er ENOENT
71The named directory does not exist.
72.It Bq Er ELOOP
73Too many symbolic links were encountered in translating the pathname.
74.It Bq Er ENOTEMPTY
75The named directory contains files other than
76.Ql \&.
77and
78.Ql \&..
79in it.
80.It Bq Er EACCES
81Search permission is denied for a component of the path prefix.
82.It Bq Er EACCES
83Write permission is denied on the directory containing the link
84to be removed.
85.It Bq Er EPERM
86The directory containing the directory to be removed is marked sticky,
87and neither the containing directory nor the directory to be removed
88are owned by the effective user ID.
89.It Bq Er EBUSY
90The directory to be removed is the mount point
91for a mounted file system.
92.It Bq Er EIO
93An I/O error occurred while deleting the directory entry
94or deallocating the inode.
95.It Bq Er EROFS
96The directory entry to be removed resides on a read-only file system.
97.It Bq Er EFAULT
98.Fa Path
99points outside the process's allocated address space.
100.El
101.Sh SEE ALSO
102.Xr mkdir 2 ,
103.Xr unlink 2
104.Sh HISTORY
105The
106.Fn rmdir
107function call appeared in
108.Bx 4.2 .
109