Sync with FreeBSD rm(1) with my modifications. Some things have been
[dragonfly.git] / bin / rmdir / rmdir.1
CommitLineData
984263bc
MD
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 $
1de703da 37.\" $DragonFly: src/bin/rmdir/rmdir.1,v 1.2 2003/06/17 04:22:50 dillon Exp $
984263bc
MD
38.\"
39.Dd May 31, 1993
40.Dt RMDIR 1
41.Os
42.Sh NAME
43.Nm rmdir
44.Nd remove directories
45.Sh SYNOPSIS
46.Nm
47.Op Fl p
48.Ar directory ...
49.Sh DESCRIPTION
50The
51.Nm
52utility removes the directory entry specified by
53each
54.Ar directory
55argument, provided it is empty.
56.Pp
57Arguments are processed in the order given.
58In order to remove both a parent directory and a subdirectory
59of that parent, the subdirectory
60must be specified first so the parent directory
61is empty when
62.Nm
63tries to remove it.
64.Pp
65The following option is available:
66.Bl -tag -width indent
67.It Fl p
68Each
69.Ar directory
70argument is treated as a pathname of which all
71components will be removed, if they are empty,
72starting with the last most component.
73(See
74.Xr rm 1
75for fully non-discriminant recursive removal.)
76.El
77.Pp
78The
79.Nm
80utility exits with one of the following values:
81.Bl -tag -width Ds
82.It Li \&0
83Each directory entry specified by a dir operand
84referred to an empty directory and was removed
85successfully.
86.It Li \&>\&0
87An error occurred.
88.El
89.Sh SEE ALSO
90.Xr rm 1
91.Sh STANDARDS
92The
93.Nm
94command is expected to be
95.St -p1003.2
96compatible.
97.Sh HISTORY
98A
99.Nm
100command appeared in
101.At v1 .