bsd/man/man2/rmdir.2

   1 .\"     $NetBSD: rmdir.2,v 1.7 1995/02/27 12:36:30 cgd 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 BSD 4.2
  39 .Sh NAME
  40 .Nm rmdir
  41 .Nd remove a directory file
  42 .Sh SYNOPSIS
  43 .Fd #include <unistd.h>
  44 .Ft int
  45 .Fo rmdir
  46 .Fa "const char *path"
  47 .Fc
  48 .Sh DESCRIPTION
  49 .Fn Rmdir
  50 removes a directory file
  51 whose name is given by
  52 .Fa path .
  53 The directory must not have any entries other
  54 than
  55 .Ql \&.
  56 and
  57 .Ql \&.. .
  58 .Sh RETURN VALUES
  59 A 0 is returned if the remove succeeds; otherwise a -1 is
  60 returned and an error code is stored in the global location
  61 .Va errno .
  62 .Sh ERRORS
  63 The named file is removed unless:
  64 .Bl -tag -width Er
  65 .\" ===========
  66 .It Bq Er EACCES
  67 Search permission is denied for a component of the path prefix.
  68 .\" ===========
  69 .It Bq Er EACCES
  70 Write permission is denied on the directory containing the link
  71 to be removed.
  72 .\" ===========
  73 .It Bq Er EBUSY
  74 The directory to be removed is the mount point
  75 for a mounted file system.
  76 .\" ===========
  77 .It Bq Er EFAULT
  78 .Fa Path
  79 points outside the process's allocated address space.
  80 .\" ===========
  81 .It Bq Er EIO
  82 An I/O error occurs while deleting the directory entry
  83 or deallocating the inode.
  84 .\" ===========
  85 .It Bq Er ELOOP
  86 Too many symbolic links are encountered in translating the pathname.
  87 This is taken to be indicative of a looping symbolic link.
  88 .\" ===========
  89 .It Bq Er ENAMETOOLONG
  90 A component of a pathname (possibly expanded by a symbolic link) exceeds
  91 .Dv {NAME_MAX}
  92 characters, or an entire path name exceeded
  93 .Dv {PATH_MAX}
  94 characters.
  95 .\" ===========
  96 .It Bq Er ENOENT
  97 The named directory does not exist.
  98 .\" ===========
  99 .It Bq Er ENOTDIR
 100 A component of the path is not a directory.
 101 .\" ===========
 102 .It Bq Er ENOTEMPTY
 103 The named directory contains files other than
 104 .Ql \&.
 105 and
 106 .Ql \&..
 107 in it.
 108 .\" ===========
 109 .It Bq Er EPERM
 110 The directory containing the directory to be removed is marked sticky,
 111 and neither the containing directory nor the directory to be removed
 112 are owned by the effective user ID.
 113 .\" ===========
 114 .It Bq Er EROFS
 115 The directory entry to be removed resides on a read-only file system.
 116 .El
 117 .Sh SEE ALSO
 118 .Xr mkdir 2 ,
 119 .Xr unlink 2
 120 .Sh HISTORY
 121 The
 122 .Fn rmdir
 123 function call appeared in
 124 .Bx 4.2 .