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