lib/libcr/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: src/lib/libc/sys/rmdir.2,v 1.5.2.5 2001/12/14 18:34:01 ru Exp $
  34 .\" $DragonFly: src/lib/libcr/sys/Attic/rmdir.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt RMDIR 2
  38 .Os
  39 .Sh NAME
  40 .Nm rmdir
  41 .Nd remove a directory file
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft int
  47 .Fn rmdir "const char *path"
  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 .Rv -std rmdir
  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 255 characters,
  67 or an entire path name exceeded 1023 characters.
  68 .It Bq Er ENOENT
  69 The named directory does not exist.
  70 .It Bq Er ELOOP
  71 Too many symbolic links were encountered in translating the pathname.
  72 .It Bq Er ENOTEMPTY
  73 The named directory contains files other than
  74 .Ql .\&
  75 and
  76 .Ql ..\&
  77 in it.
  78 .It Bq Er EACCES
  79 Search permission is denied for a component of the path prefix.
  80 .It Bq Er EACCES
  81 Write permission is denied on the directory containing the link
  82 to be removed.
  83 .It Bq Er EPERM
  84 The directory containing the directory to be removed is marked sticky,
  85 and neither the containing directory nor the directory to be removed
  86 are owned by the effective user ID.
  87 .It Bq Er EBUSY
  88 The directory to be removed is the mount point
  89 for a mounted file system.
  90 .It Bq Er EIO
  91 An I/O error occurred while deleting the directory entry
  92 or deallocating the inode.
  93 .It Bq Er EROFS
  94 The directory entry to be removed resides on a read-only file system.
  95 .It Bq Er EFAULT
  96 .Fa Path
  97 points outside the process's allocated address space.
  98 .El
  99 .Sh SEE ALSO
 100 .Xr mkdir 2 ,
 101 .Xr unlink 2
 102 .Sh HISTORY
 103 The
 104 .Fn rmdir
 105 function call appeared in
 106 .Bx 4.2 .