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 .Fn rmdir "const char *path"
  46 .Sh DESCRIPTION
  47 .Fn Rmdir
  48 removes a directory file
  49 whose name is given by
  50 .Fa path .
  51 The directory must not have any entries other
  52 than
  53 .Ql \&.
  54 and
  55 .Ql \&.. .
  56 .Sh RETURN VALUES
  57 A 0 is returned if the remove succeeds; otherwise a -1 is
  58 returned and an error code is stored in the global location
  59 .Va errno .
  60 .Sh ERRORS
  61 The named file is removed unless:
  62 .Bl -tag -width Er
  63 .It Bq Er ENOTDIR
  64 A component of the path is not a directory.
  65 .It Bq Er ENAMETOOLONG
  66 A component of a pathname exceeded
  67 .Dv {NAME_MAX}
  68 characters, or an entire path name exceeded
  69 .Dv {PATH_MAX}
  70 characters.
  71 .It Bq Er ENOENT
  72 The named directory does not exist.
  73 .It Bq Er ELOOP
  74 Too many symbolic links were encountered in translating the pathname.
  75 .It Bq Er ENOTEMPTY
  76 The named directory contains files other than
  77 .Ql \&.
  78 and
  79 .Ql \&..
  80 in it.
  81 .It Bq Er EACCES
  82 Search permission is denied for a component of the path prefix.
  83 .It Bq Er EACCES
  84 Write permission is denied on the directory containing the link
  85 to be removed.
  86 .It Bq Er EPERM
  87 The directory containing the directory to be removed is marked sticky,
  88 and neither the containing directory nor the directory to be removed
  89 are owned by the effective user ID.
  90 .It Bq Er EBUSY
  91 The directory to be removed is the mount point
  92 for a mounted file system.
  93 .It Bq Er EIO
  94 An I/O error occurred while deleting the directory entry
  95 or deallocating the inode.
  96 .It Bq Er EROFS
  97 The directory entry to be removed resides on a read-only file system.
  98 .It Bq Er EFAULT
  99 .Fa Path
 100 points outside the process's allocated address space.
 101 .El
 102 .Sh SEE ALSO
 103 .Xr mkdir 2 ,
 104 .Xr unlink 2
 105 .Sh HISTORY
 106 The
 107 .Fn rmdir
 108 function call appeared in
 109 .Bx 4.2 .