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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)rmdir.2     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd December 9, 2006
  32 .Dt RMDIR 2
  33 .Os
  34 .Sh NAME
  35 .Nm rmdir
  36 .Nd remove a directory file
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In unistd.h
  41 .Ft int
  42 .Fn rmdir "const char *path"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn rmdir
  46 system call
  47 removes a directory file
  48 whose name is given by
  49 .Fa path .
  50 The directory must not have any entries other
  51 than
  52 .Ql .\&
  53 and
  54 .Ql \&.. .
  55 .Sh RETURN VALUES
  56 .Rv -std rmdir
  57 .Sh ERRORS
  58 The named file is removed unless:
  59 .Bl -tag -width Er
  60 .It Bq Er ENOTDIR
  61 A component of the path is not a directory.
  62 .It Bq Er ENAMETOOLONG
  63 A component of a pathname exceeded 255 characters,
  64 or an entire path name exceeded 1023 characters.
  65 .It Bq Er ENOENT
  66 The named directory does not exist.
  67 .It Bq Er ELOOP
  68 Too many symbolic links were encountered in translating the pathname.
  69 .It Bq Er ENOTEMPTY
  70 The named directory contains files other than
  71 .Ql .\&
  72 and
  73 .Ql ..\&
  74 in it.
  75 .It Bq Er EACCES
  76 Search permission is denied for a component of the path prefix.
  77 .It Bq Er EACCES
  78 Write permission is denied on the directory containing the link
  79 to be removed.
  80 .It Bq Er EPERM
  81 The directory to be removed has its immutable, undeletable or append-only flag
  82 set, see the
  83 .Xr chflags 2
  84 manual page for more information.
  85 .It Bq Er EPERM
  86 The parent directory of the directory to be removed has its immutable or
  87 append-only flag set.
  88 .It Bq Er EPERM
  89 The directory containing the directory to be removed is marked sticky,
  90 and neither the containing directory nor the directory to be removed
  91 are owned by the effective user ID.
  92 .It Bq Er EINVAL
  93 The last component of the path is
  94 .Ql .\&
  95 or
  96 .Ql .. .
  97 .It Bq Er EBUSY
  98 The directory to be removed is the mount point
  99 for a mounted file system.
 100 .It Bq Er EIO
 101 An I/O error occurred while deleting the directory entry
 102 or deallocating the inode.
 103 .It Bq Er EROFS
 104 The directory entry to be removed resides on a read-only file system.
 105 .It Bq Er EFAULT
 106 The
 107 .Fa path
 108 argument
 109 points outside the process's allocated address space.
 110 .El
 111 .Sh SEE ALSO
 112 .Xr mkdir 2 ,
 113 .Xr unlink 2
 114 .Sh HISTORY
 115 The
 116 .Fn rmdir
 117 system call appeared in
 118 .Bx 4.2 .