lib/libc/sys/rmdir.2

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