1.\" $NetBSD: rmdir.2,v 1.15 2002/02/08 01:28:21 ross 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. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)rmdir.2 8.1 (Berkeley) 6/4/93 35.\" 36.Dd June 4, 1993 37.Dt RMDIR 2 38.Os 39.Sh NAME 40.Nm rmdir 41.Nd remove a directory file 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include \*[Lt]unistd.h\*[Gt] 46.Ft int 47.Fn rmdir "const char *path" 48.Sh DESCRIPTION 49.Fn rmdir 50removes a directory file 51whose name is given by 52.Fa path . 53The directory must not have any entries other 54than 55.Ql \&. 56and 57.Ql \&.. . 58.Sh RETURN VALUES 59A 0 is returned if the remove succeeds; otherwise a -1 is 60returned and an error code is stored in the global location 61.Va errno . 62.Sh ERRORS 63The named file is removed unless: 64.Bl -tag -width Er 65.It Bq Er ENOTDIR 66A component of the path is not a directory. 67.It Bq Er ENAMETOOLONG 68A component of a pathname exceeded 69.Dv {NAME_MAX} 70characters, or an entire path name exceeded 71.Dv {PATH_MAX} 72characters. 73.It Bq Er ENOENT 74The named directory does not exist. 75.It Bq Er ELOOP 76Too many symbolic links were encountered in translating the pathname. 77.It Bq Er ENOTEMPTY 78The named directory contains files other than 79.Ql \&. 80and 81.Ql \&.. 82in it. 83.It Bq Er EACCES 84Search permission is denied for a component of the path prefix, or 85write permission is denied on the directory containing the link 86to be removed. 87.It Bq Er EPERM 88The directory containing the directory to be removed is marked sticky, 89and neither the containing directory nor the directory to be removed 90are owned by the effective user ID. 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.Sh STANDARDS 107The 108.Fn rmdir 109function conforms to 110.St -p1003.1-90 . 111.Sh HISTORY 112The 113.Fn rmdir 114function call appeared in 115.Bx 4.2 . 116