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