[unix-history] / bin / rmdir / rmdir.1

.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     from: @(#)rmdir.1	6.5 (Berkeley) 6/27/91
.\"	$Id: rmdir.1,v 1.7 1993/09/10 18:57:43 jtc Exp $
.\"
.Dd June 27, 1991
.Dt RMDIR 1
.Os
.Sh NAME
.Nm rmdir
.Nd remove directories
.Sh SYNOPSIS
.Nm rmdir
.Op Fl p
.Ar directory ...
.Sh DESCRIPTION
The rmdir utility removes the directory entry specified by
each
.Ar directory
argument, provided it is empty.
.Pp
Arguments are processed in the order given.
In order to remove both a parent directory and a subdirectory
of that parent, the subdirectory
must be specified first so the parent directory
is empty when
.Nm rmdir
tries to remove it.
.Pp
The following option is available:
.Bl -tag -width Ds
.It Fl p
Each
.Ar directory
argument is treated as a pathname of which all
components will be removed, if they are empty,
starting with the last most component.
(See
.Xr rm 1
for fully non-discriminant recursive removal).
.El
.Pp
The
.Nm rmdir
utility exits with one of the following values:
.Bl -tag -width Ds
.It Li \&0
Each directory entry specified by a dir operand
referred to an empty directory and was removed
successfully.
.It Li \&>\&0
An error occurred.
.El
.Sh SEE ALSO
.Xr rm 1
.Sh STANDARDS
The
.Nm rmdir
utility conforms to
.St -p1003.2-92 .
Commit	Line	Data
15637ed4 RG	1	.\" Copyright (c) 1990 The Regents of the University of California.
	2	.\" 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	.\"
cb5bed7c C	35	.\" from: @(#)rmdir.1 6.5 (Berkeley) 6/27/91
cb5bed7c C	36	.\" $Id: rmdir.1,v 1.7 1993/09/10 18:57:43 jtc Exp $
15637ed4	37	.\"
15637ed4 RG	38	.Dd June 27, 1991
	39	.Dt RMDIR 1
	40	.Os
	41	.Sh NAME
	42	.Nm rmdir
	43	.Nd remove directories
	44	.Sh SYNOPSIS
	45	.Nm rmdir
25fd433a	46	.Op Fl p
15637ed4 RG	47	.Ar directory ...
	48	.Sh DESCRIPTION
	49	The rmdir utility removes the directory entry specified by
	50	each
	51	.Ar directory
	52	argument, provided it is empty.
	53	.Pp
	54	Arguments are processed in the order given.
	55	In order to remove both a parent directory and a subdirectory
	56	of that parent, the subdirectory
	57	must be specified first so the parent directory
	58	is empty when
	59	.Nm rmdir
	60	tries to remove it.
25fd433a C	61	.Pp
	62	The following option is available:
	63	.Bl -tag -width Ds
	64	.It Fl p
	65	Each
	66	.Ar directory
	67	argument is treated as a pathname of which all
	68	components will be removed, if they are empty,
	69	starting with the last most component.
	70	(See
	71	.Xr rm 1
	72	for fully non-discriminant recursive removal).
	73	.El
15637ed4 RG	74	.Pp
	75	The
	76	.Nm rmdir
	77	utility exits with one of the following values:
f3acbda9 C	78	.Bl -tag -width Ds
f3acbda9 C	79	.It Li \&0
15637ed4 RG	80	Each directory entry specified by a dir operand
	81	referred to an empty directory and was removed
	82	successfully.
f3acbda9	83	.It Li \&>\&0
15637ed4	84	An error occurred.
f3acbda9	85	.El
15637ed4 RG	86	.Sh SEE ALSO
	87	.Xr rm 1
	88	.Sh STANDARDS
	89	The
	90	.Nm rmdir
cb5bed7c C	91	utility conforms to
cb5bed7c C	92	.St -p1003.2-92 .