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