bin/rmdir/rmdir.1

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