bin/rmdir/rmdir.1

   1 .\"     $NetBSD: rmdir.1,v 1.15 2003/08/07 09:05:29 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the Institute of Electrical and Electronics Engineers, Inc.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\"     @(#)rmdir.1     8.1 (Berkeley) 5/31/93
  34 .\"
  35 .Dd May 31, 1993
  36 .Dt RMDIR 1
  37 .Os
  38 .Sh NAME
  39 .Nm rmdir
  40 .Nd remove directories
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl p
  44 .Ar directory ...
  45 .Sh DESCRIPTION
  46 The rmdir utility removes the directory entry specified by
  47 each
  48 .Ar directory
  49 argument, provided it is empty.
  50 .Pp
  51 Arguments are processed in the order given.
  52 In order to remove both a parent directory and a subdirectory
  53 of that parent, the subdirectory
  54 must be specified first so the parent directory
  55 is empty when
  56 .Nm
  57 tries to remove it.
  58 .Pp
  59 The following option is available:
  60 .Bl -tag -width Ds
  61 .It Fl p
  62 Each
  63 .Ar directory
  64 argument is treated as a pathname of which all
  65 components will be removed, if they are empty,
  66 starting with the last most component.
  67 (See
  68 .Xr rm 1
  69 for fully non-discriminant recursive removal.)
  70 .El
  71 .Sh EXIT STATUS
  72 The
  73 .Nm
  74 utility exits with one of the following values:
  75 .Bl -tag -width Ds
  76 .It Li \&0
  77 Each directory entry specified by a dir operand
  78 referred to an empty directory and was removed
  79 successfully.
  80 .It Li \&\*[Gt]\&0
  81 An error occurred.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr rm 1
  85 .Sh STANDARDS
  86 The
  87 .Nm
  88 utility is expected to be
  89 .St -p1003.2
  90 compatible.