Merge remote-tracking branch 'origin/vendor/LIBEDIT'
[dragonfly.git] / 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. Neither the name of the University nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)rmdir.1     8.1 (Berkeley) 5/31/93
32 .\" $FreeBSD: src/bin/rmdir/rmdir.1,v 1.8.2.1 2000/12/08 13:34:40 ru Exp $
33 .\"
34 .Dd April 10, 2013
35 .Dt RMDIR 1
36 .Os
37 .Sh NAME
38 .Nm rmdir
39 .Nd remove directories
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl pv
43 .Ar directory ...
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility removes the directory entry specified by
48 each
49 .Ar directory
50 argument, provided it is empty.
51 .Pp
52 Arguments are processed in the order given.
53 In order to remove both a parent directory and a subdirectory
54 of that parent, the subdirectory
55 must be specified first so the parent directory
56 is empty when
57 .Nm
58 tries to remove it.
59 .Pp
60 The following options are available:
61 .Bl -tag -width indent
62 .It Fl p
63 Each
64 .Ar directory
65 argument is treated as a pathname of which all
66 components will be removed, if they are empty,
67 starting with the last most component.
68 (See
69 .Xr rm 1
70 for fully non-discriminant recursive removal.)
71 .It Fl v
72 Be verbose, listing each directory as it is removed.
73 .El
74 .Sh EXIT STATUS
75 .Ex -std
76 .Sh SEE ALSO
77 .Xr rm 1
78 .Sh STANDARDS
79 The
80 .Nm
81 command is expected to be
82 .St -p1003.2
83 compatible.
84 .Sh HISTORY
85 A
86 .Nm
87 command appeared in
88 .At v1 .