xref: /dragonfly/lib/libc/sys/rmdir.2 (revision f2c43266)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)rmdir.2	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD: src/lib/libc/sys/rmdir.2,v 1.5.2.5 2001/12/14 18:34:01 ru Exp $
30.\"
31.Dd April 13, 2013
32.Dt RMDIR 2
33.Os
34.Sh NAME
35.Nm rmdir
36.Nd remove a directory file
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In 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
54.Rv -std rmdir
55.Sh ERRORS
56The named file is removed unless:
57.Bl -tag -width Er
58.It Bq Er ENOTDIR
59A component of the path is not a directory.
60.It Bq Er ENAMETOOLONG
61A component of a pathname exceeded 255 characters,
62or an entire path name exceeded 1023 characters.
63.It Bq Er ENOENT
64The named directory does not exist.
65.It Bq Er ELOOP
66Too many symbolic links were encountered in translating the pathname.
67.It Bq Er ENOTEMPTY
68The named directory contains files other than
69.Ql .\&
70and
71.Ql ..\&
72in it.
73.It Bq Er EACCES
74Search permission is denied for a component of the path prefix.
75.It Bq Er EACCES
76Write permission is denied on the directory containing the link
77to be removed.
78.It Bq Er EPERM
79The directory containing the directory to be removed is marked sticky,
80and neither the containing directory nor the directory to be removed
81are owned by the effective user ID.
82.It Bq Er EINVAL
83The last component of the path is
84.Ql .\&
85or
86.Ql .. .
87.It Bq Er EBUSY
88The directory to be removed is the mount point
89for a mounted file system.
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 mkdir 2 ,
101.Xr unlink 2 ,
102.Xr unlinkat 2
103.Sh HISTORY
104The
105.Fn rmdir
106function call appeared in
107.Bx 4.2 .
108