265 lines
7.8 KiB
HTML
265 lines
7.8 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>rmdir</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="rmdir"></a> <a name="tag_04_123"></a><!-- rmdir -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_04_123_01"></a>NAME</h4>
|
|
|
|
<blockquote>rmdir - remove directories</blockquote>
|
|
|
|
<h4><a name="tag_04_123_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<p><code><tt>rmdir</tt> <b>[</b><tt>-p</tt><b>]</b> <i>dir</i><tt>...</tt></code></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>rmdir</i> utility shall remove the directory entry specified by each <i>dir</i> operand.</p>
|
|
|
|
<p>For each <i>dir</i> operand, the <i>rmdir</i> utility shall perform actions equivalent to the <a href=
|
|
"../functions/rmdir.html"><i>rmdir</i>()</a> function called with the <i>dir</i> operand as its only argument.</p>
|
|
|
|
<p>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 <i>rmdir</i> utility, the application shall specify the subdirectory before the parent directory so that
|
|
the parent directory will be empty when the <i>rmdir</i> utility tries to remove it.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_04"></a>OPTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>rmdir</i> utility shall conform to the Base Definitions volume of IEEE Std 1003.1-2001, <a href=
|
|
"../basedefs/xbd_chap12.html#tag_12_02">Section 12.2, Utility Syntax Guidelines</a>.</p>
|
|
|
|
<p>The following option shall be supported:</p>
|
|
|
|
<dl compact>
|
|
<dt><b>-p</b></dt>
|
|
|
|
<dd>Remove all directories in a pathname. For each <i>dir</i> operand:
|
|
|
|
<ol>
|
|
<li>
|
|
<p>The directory entry it names shall be removed.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>If the <i>dir</i> operand includes more than one pathname component, effects equivalent to the following command shall
|
|
occur:</p>
|
|
|
|
<pre>
|
|
<tt>rmdir -p $(dirname</tt> <i>dir</i><tt>)
|
|
</tt>
|
|
</pre>
|
|
</li>
|
|
</ol>
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_05"></a>OPERANDS</h4>
|
|
|
|
<blockquote>
|
|
<p>The following operand shall be supported:</p>
|
|
|
|
<dl compact>
|
|
<dt><i>dir</i></dt>
|
|
|
|
<dd>A pathname of an empty directory to be removed.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_06"></a>STDIN</h4>
|
|
|
|
<blockquote>
|
|
<p>Not used.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_07"></a>INPUT FILES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_08"></a>ENVIRONMENT VARIABLES</h4>
|
|
|
|
<blockquote>
|
|
<p>The following environment variables shall affect the execution of <i>rmdir</i>:</p>
|
|
|
|
<dl compact>
|
|
<dt><i>LANG</i></dt>
|
|
|
|
<dd>Provide a default value for the internationalization variables that are unset or null. (See the Base Definitions volume of
|
|
IEEE Std 1003.1-2001, <a href="../basedefs/xbd_chap08.html#tag_08_02">Section 8.2, Internationalization Variables</a> for
|
|
the precedence of internationalization variables used to determine the values of locale categories.)</dd>
|
|
|
|
<dt><i>LC_ALL</i></dt>
|
|
|
|
<dd>If set to a non-empty string value, override the values of all the other internationalization variables.</dd>
|
|
|
|
<dt><i>LC_CTYPE</i></dt>
|
|
|
|
<dd>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).</dd>
|
|
|
|
<dt><i>LC_MESSAGES</i></dt>
|
|
|
|
<dd>Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard
|
|
error.</dd>
|
|
|
|
<dt><i>NLSPATH</i></dt>
|
|
|
|
<dd><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
|
|
Determine the location of message catalogs for the processing of <i>LC_MESSAGES .</i> <img src="../images/opt-end.gif" alt=
|
|
"[Option End]" border="0"></dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_09"></a>ASYNCHRONOUS EVENTS</h4>
|
|
|
|
<blockquote>
|
|
<p>Default.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_10"></a>STDOUT</h4>
|
|
|
|
<blockquote>
|
|
<p>Not used.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_11"></a>STDERR</h4>
|
|
|
|
<blockquote>
|
|
<p>The standard error shall be used only for diagnostic messages.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_12"></a>OUTPUT FILES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_13"></a>EXTENDED DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_14"></a>EXIT STATUS</h4>
|
|
|
|
<blockquote>
|
|
<p>The following exit values shall be returned:</p>
|
|
|
|
<dl compact>
|
|
<dt> 0</dt>
|
|
|
|
<dd>Each directory entry specified by a <i>dir</i> operand was removed successfully.</dd>
|
|
|
|
<dt>>0</dt>
|
|
|
|
<dd>An error occurred.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_15"></a>CONSEQUENCES OF ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>Default.</p>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_04_123_16"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>The definition of an empty directory is one that contains, at most, directory entries for dot and dot-dot.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_17"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<p>If a directory <b>a</b> in the current directory is empty except it contains a directory <b>b</b> and <b>a/b</b> is empty except
|
|
it contains a directory <b>c</b>:</p>
|
|
|
|
<pre>
|
|
<tt>rmdir -p a/b/c
|
|
</tt>
|
|
</pre>
|
|
|
|
<p>removes all three directories.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_18"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>On historical System V systems, the <b>-p</b> 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 <i>dir</i> operand is not removed, but does not allow the status message reporting
|
|
success to be written as a diagnostic.</p>
|
|
|
|
<p>The <i>rmdir</i> utility on System V also included a <b>-s</b> option that suppressed the informational message output by the
|
|
<b>-p</b> option. This option has been omitted because the informational message is not specified by this volume of
|
|
IEEE Std 1003.1-2001.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_19"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_20"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p><a href="rm.html"><i>rm</i></a> , the System Interfaces volume of IEEE Std 1003.1-2001, <a href=
|
|
"../functions/remove.html"><i>remove</i>()</a>, <a href="../functions/rmdir.html"><i>rmdir</i>()</a>, <a href=
|
|
"../functions/unlink.html"><i>unlink</i>()</a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_21"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 2.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_123_22"></a>Issue 6</h4>
|
|
|
|
<blockquote>
|
|
<p>The normative text is reworded to avoid use of the term "must" for application requirements.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|