| 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 | .\" |
| 35 | .\" @(#)rmdir.1 6.5 (Berkeley) 6/27/91 |
| 36 | .\" |
| 37 | .Vx |
| 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 |
| 46 | .Op Fl p |
| 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. |
| 61 | .\" .Pp |
| 62 | .\" The following option is available: |
| 63 | .\" .Tw Ds |
| 64 | .\" .Tp 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 | .Pp |
| 74 | The |
| 75 | .Nm rmdir |
| 76 | utility exits with one of the following values: |
| 77 | .Tw Ds |
| 78 | .Tp Li \&0 |
| 79 | Each directory entry specified by a dir operand |
| 80 | referred to an empty directory and was removed |
| 81 | successfully. |
| 82 | .Tp Li \&>\&0 |
| 83 | An error occurred. |
| 84 | .Tp |
| 85 | .Sh SEE ALSO |
| 86 | .Xr rm 1 |
| 87 | .Sh STANDARDS |
| 88 | The |
| 89 | .Nm rmdir |
| 90 | function is expected to be POSIX 1003.2 compatible. |