xref: /dragonfly/lib/libc/sys/rmdir.2 (revision 25a2db75)
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. 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.\"     @(#)rmdir.2	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: src/lib/libc/sys/rmdir.2,v 1.5.2.5 2001/12/14 18:34:01 ru Exp $
34.\"
35.Dd April 13, 2013
36.Dt RMDIR 2
37.Os
38.Sh NAME
39.Nm rmdir
40.Nd remove a directory file
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In unistd.h
45.Ft int
46.Fn rmdir "const char *path"
47.Sh DESCRIPTION
48.Fn Rmdir
49removes a directory file
50whose name is given by
51.Fa path .
52The directory must not have any entries other
53than
54.Ql .\&
55and
56.Ql \&.. .
57.Sh RETURN VALUES
58.Rv -std rmdir
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 255 characters,
66or an entire path name exceeded 1023 characters.
67.It Bq Er ENOENT
68The named directory does not exist.
69.It Bq Er ELOOP
70Too many symbolic links were encountered in translating the pathname.
71.It Bq Er ENOTEMPTY
72The named directory contains files other than
73.Ql .\&
74and
75.Ql ..\&
76in it.
77.It Bq Er EACCES
78Search permission is denied for a component of the path prefix.
79.It Bq Er EACCES
80Write permission is denied on the directory containing the link
81to be removed.
82.It Bq Er EPERM
83The directory containing the directory to be removed is marked sticky,
84and neither the containing directory nor the directory to be removed
85are owned by the effective user ID.
86.It Bq Er EINVAL
87The last component of the path is
88.Ql .\&
89or
90.Ql .. .
91.It Bq Er EBUSY
92The directory to be removed is the mount point
93for a mounted file system.
94.It Bq Er EIO
95An I/O error occurred while deleting the directory entry
96or deallocating the inode.
97.It Bq Er EROFS
98The directory entry to be removed resides on a read-only file system.
99.It Bq Er EFAULT
100.Fa Path
101points outside the process's allocated address space.
102.El
103.Sh SEE ALSO
104.Xr mkdir 2 ,
105.Xr unlink 2 ,
106.Xr unlinkat 2
107.Sh HISTORY
108The
109.Fn rmdir
110function call appeared in
111.Bx 4.2 .
112