aboutsummaryrefslogtreecommitdiff
path: root/coreutils-5.3.0-bin/man/cat1p/rmdir.1p.txt
blob: 354e4e7d5ad2e61d9fe94394af6da9cd5f28daf0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
rmdir(P)                                               rmdir(P)





NAME
       rmdir - remove directories

SYNOPSIS
       rmdir [-p] dir...

DESCRIPTION
       The rmdir utility shall remove the directory entry spec-
       ified by each dir operand.

       For each dir operand, the rmdir  utility  shall  perform
       actions  equivalent  to the rmdir() function called with
       the dir operand as its only argument.

       Directories shall be processed in the  order  specified.
       If  a directory and a subdirectory of that directory are
       specified in a single invocation of the  rmdir  utility,
       the  application  shall  specify the subdirectory before
       the parent directory so that the parent  directory  will
       be empty when the rmdir utility tries to remove it.

OPTIONS
       The  rmdir utility shall conform to the Base Definitions
       volume of IEEE Std 1003.1-2001,  Section  12.2,  Utility
       Syntax Guidelines.

       The following option shall be supported:

       -p     Remove  all  directories  in a pathname. For each
              dir operand:

       The directory entry it names shall be removed.

       If the dir operand includes more than one pathname  com-
       ponent,  effects  equivalent  to  the  following command
       shall occur:


              rmdir -p $(dirname dir)


OPERANDS
       The following operand shall be supported:

       dir    A pathname of an empty directory to be removed.


STDIN
       Not used.

INPUT FILES
       None.

ENVIRONMENT VARIABLES
       The following environment  variables  shall  affect  the
       execution of rmdir:

       LANG   Provide a default value for the internationaliza-
              tion variables that are unset or null.  (See  the
              Base  Definitions volume of IEEE Std 1003.1-2001,
              Section 8.2, Internationalization  Variables  for
              the  precedence of internationalization variables
              used to determine  the  values  of  locale  cate-
              gories.)

       LC_ALL If  set to a non-empty string value, override the
              values  of  all  the  other  internationalization
              variables.

       LC_CTYPE
              Determine  the  locale  for the interpretation of
              sequences of bytes of  text  data  as  characters
              (for  example,  single-byte  as opposed to multi-
              byte characters in arguments).

       LC_MESSAGES
              Determine the  locale  that  should  be  used  to
              affect the format and contents of diagnostic mes-
              sages written to standard error.

       NLSPATH
              Determine the location of  message  catalogs  for
              the processing of LC_MESSAGES .


ASYNCHRONOUS EVENTS
       Default.

STDOUT
       Not used.

STDERR
       The  standard  error  shall  be used only for diagnostic
       messages.

OUTPUT FILES
       None.

EXTENDED DESCRIPTION
       None.

EXIT STATUS
       The following exit values shall be returned:

        0     Each directory entry specified by a  dir  operand
              was removed successfully.

       >0     An error occurred.


CONSEQUENCES OF ERRORS
       Default.

       The following sections are informative.

APPLICATION USAGE
       The  definition  of  an empty directory is one that con-
       tains, at most, directory entries for dot and dot-dot.

EXAMPLES
       If a directory a  in  the  current  directory  is  empty
       except it contains a directory b and a/b is empty except
       it contains a directory c:


              rmdir -p a/b/c

       removes all three directories.

RATIONALE
       On historical System  V  systems,  the  -p  option  also
       caused  a  message to be written to the standard output.
       The message indicated whether the whole path was removed
       or  whether  part  of the path remained for some reason.
       The STDERR section requires  this  diagnostic  when  the
       entire  path  specified by a dir operand is not removed,
       but does not allow the status message reporting  success
       to be written as a diagnostic.

       The  rmdir utility on System V also included a -s option
       that suppressed the informational message output by  the
       -p  option.  This  option  has  been omitted because the
       informational message is not specified by this volume of
       IEEE Std 1003.1-2001.

FUTURE DIRECTIONS
       None.

SEE ALSO
       rm     ,     the    System    Interfaces    volume    of
       IEEE Std 1003.1-2001, remove(), rmdir(), unlink()

COPYRIGHT
       Portions of this text are reprinted  and  reproduced  in
       electronic  form  from  IEEE  Std  1003.1, 2003 Edition,
       Standard for Information Technology -- Portable  Operat-
       ing System Interface (POSIX), The Open Group Base Speci-
       fications Issue 6, Copyright (C) 2001-2003 by the Insti-
       tute  of  Electrical  and Electronics Engineers, Inc and
       The Open Group. In the event of any discrepancy  between
       this  version  and  the original IEEE and The Open Group
       Standard, the original IEEE and The Open Group  Standard
       is  the  referee  document. The original Standard can be
       obtained        online        at        http://www.open-
       group.org/unix/online.html .



POSIX                         2003                     rmdir(P)