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