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