lib/libc/sys/rmdir.2

   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$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt RMDIR 2
  37 .Os BSD 4.2
  38 .Sh NAME
  39 .Nm rmdir
  40 .Nd remove a directory file
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .Fd #include <unistd.h>
  45 .Ft int
  46 .Fn rmdir "const char *path"
  47 .Sh DESCRIPTION
  48 .Fn Rmdir
  49 removes a directory file
  50 whose name is given by
  51 .Fa path .
  52 The directory must not have any entries other
  53 than
  54 .Ql .\&
  55 and
  56 .Ql \&.. .
  57 .Sh RETURN VALUES
  58 A 0 is returned if the remove succeeds; otherwise a -1 is
  59 returned and an error code is stored in the global location
  60 .Va errno .
  61 .Sh ERRORS
  62 The named file is removed unless:
  63 .Bl -tag -width Er
  64 .It Bq Er ENOTDIR
  65 A component of the path is not a directory.
  66 .It Bq Er ENAMETOOLONG
  67 A component of a pathname exceeded 255 characters,
  68 or an entire path name exceeded 1023 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.
  81 .It Bq Er EACCES
  82 Write permission is denied on the directory containing the link
  83 to be removed.
  84 .It Bq Er EPERM
  85 The directory containing the directory to be removed is marked sticky,
  86 and neither the containing directory nor the directory to be removed
  87 are owned by the effective user ID.
  88 .It Bq Er EBUSY
  89 The directory to be removed is the mount point
  90 for a mounted file system.
  91 .It Bq Er EIO
  92 An I/O error occurred while deleting the directory entry
  93 or deallocating the inode.
  94 .It Bq Er EROFS
  95 The directory entry to be removed resides on a read-only file system.
  96 .It Bq Er EFAULT
  97 .Fa Path
  98 points outside the process's allocated address space.
  99 .El
 100 .Sh SEE ALSO
 101 .Xr mkdir 2 ,
 102 .Xr unlink 2
 103 .Sh HISTORY
 104 The
 105 .Fn rmdir
 106 function call appeared in
 107 .Bx 4.2 .