Files
oldlinux-files/Ref-docs/POSIX/susv3/utilities/mkdir.html
2024-02-19 00:21:47 -05:00

280 lines
9.3 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>mkdir</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="mkdir"></a> <a name="tag_04_87"></a><!-- mkdir -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_04_87_01"></a>NAME</h4>
<blockquote>mkdir - make directories</blockquote>
<h4><a name="tag_04_87_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>mkdir</tt> <b>[</b><tt>-p</tt><b>][</b><tt>-m</tt> <i>mode</i><b>]</b> <i>dir</i><tt>...</tt></code></p>
</blockquote>
<h4><a name="tag_04_87_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>mkdir</i> utility shall create the directories specified by the operands, in the order specified.</p>
<p>For each <i>dir</i> operand, the <i>mkdir</i> utility shall perform actions equivalent to the <a href=
"../functions/mkdir.html"><i>mkdir</i>()</a> function defined in the System Interfaces volume of IEEE&nbsp;Std&nbsp;1003.1-2001,
called with the following arguments:</p>
<ol>
<li>
<p>The <i>dir</i> operand is used as the <i>path</i> argument.</p>
</li>
<li>
<p>The value of the bitwise-inclusive OR of S_IRWXU, S_IRWXG, and S_IRWXO is used as the <i>mode</i> argument. (If the <b>-m</b>
option is specified, the <i>mode</i> option-argument overrides this default.)</p>
</li>
</ol>
</blockquote>
<h4><a name="tag_04_87_04"></a>OPTIONS</h4>
<blockquote>
<p>The <i>mkdir</i> utility shall conform to the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/xbd_chap12.html#tag_12_02">Section 12.2, Utility Syntax Guidelines</a>.</p>
<p>The following options shall be supported:</p>
<dl compact>
<dt><b>-m&nbsp;</b> <i>mode</i></dt>
<dd>Set the file permission bits of the newly-created directory to the specified <i>mode</i> value. The <i>mode</i> option-argument
shall be the same as the <i>mode</i> operand defined for the <a href="../utilities/chmod.html"><i>chmod</i></a> utility. In the
<i>symbolic_mode</i> strings, the <i>op</i> characters <tt>'+'</tt> and <tt>'-'</tt> shall be interpreted relative to an assumed
initial mode of <i>a</i>= <i>rwx</i>; <tt>'+'</tt> shall add permissions to the default mode, <tt>'-'</tt> shall delete permissions
from the default mode.</dd>
<dt><b>-p</b></dt>
<dd>Create any missing intermediate pathname components.
<p>For each <i>dir</i> operand that does not name an existing directory, effects equivalent to those caused by the following
command shall occur:</p>
<pre>
<tt>mkdir -p -m $(umask -S),u+wx $(dirname</tt> <i>dir</i><tt>) &amp;&amp;
mkdir</tt> <b>[</b><tt>-m</tt> <i>mode</i><b>]</b> <i>dir</i>
</pre>
<p>where the <b>-m</b> <i>mode</i> option represents that option supplied to the original invocation of <i>mkdir</i>, if any.</p>
<p>Each <i>dir</i> operand that names an existing directory shall be ignored without error.</p>
</dd>
</dl>
</blockquote>
<h4><a name="tag_04_87_05"></a>OPERANDS</h4>
<blockquote>
<p>The following operand shall be supported:</p>
<dl compact>
<dt><i>dir</i></dt>
<dd>A pathname of a directory to be created.</dd>
</dl>
</blockquote>
<h4><a name="tag_04_87_06"></a>STDIN</h4>
<blockquote>
<p>Not used.</p>
</blockquote>
<h4><a name="tag_04_87_07"></a>INPUT FILES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_04_87_08"></a>ENVIRONMENT VARIABLES</h4>
<blockquote>
<p>The following environment variables shall affect the execution of <i>mkdir</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&nbsp;Std&nbsp;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_87_09"></a>ASYNCHRONOUS EVENTS</h4>
<blockquote>
<p>Default.</p>
</blockquote>
<h4><a name="tag_04_87_10"></a>STDOUT</h4>
<blockquote>
<p>Not used.</p>
</blockquote>
<h4><a name="tag_04_87_11"></a>STDERR</h4>
<blockquote>
<p>The standard error shall be used only for diagnostic messages.</p>
</blockquote>
<h4><a name="tag_04_87_12"></a>OUTPUT FILES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_04_87_13"></a>EXTENDED DESCRIPTION</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_04_87_14"></a>EXIT STATUS</h4>
<blockquote>
<p>The following exit values shall be returned:</p>
<dl compact>
<dt>&nbsp;0</dt>
<dd>All the specified directories were created successfully or the <b>-p</b> option was specified and all the specified directories
now exist.</dd>
<dt>&gt;0</dt>
<dd>An error occurred.</dd>
</dl>
</blockquote>
<h4><a name="tag_04_87_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_87_16"></a>APPLICATION USAGE</h4>
<blockquote>
<p>The default file mode for directories is <i>a</i>= <i>rwx</i> (777 on most systems) with selected permissions removed in
accordance with the file mode creation mask. For intermediate pathname components created by <i>mkdir</i>, the mode is the default
modified by <i>u</i>+ <i>wx</i> so that the subdirectories can always be created regardless of the file mode creation mask; if
different ultimate permissions are desired for the intermediate directories, they can be changed afterwards with <a href=
"../utilities/chmod.html"><i>chmod</i></a>.</p>
<p>Note that some of the requested directories may have been created even if an error occurs.</p>
</blockquote>
<h4><a name="tag_04_87_17"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_04_87_18"></a>RATIONALE</h4>
<blockquote>
<p>The System V <b>-m</b> option was included to control the file mode.</p>
<p>The System V <b>-p</b> option was included to create any needed intermediate directories and to complement the functionality
provided by <a href="../utilities/rmdir.html"><i>rmdir</i></a> for removing directories in the path prefix as they become empty.
Because no error is produced if any path component already exists, the <b>-p</b> option is also useful to ensure that a particular
directory exists.</p>
<p>The functionality of <i>mkdir</i> is described substantially through a reference to the <a href=
"../functions/mkdir.html"><i>mkdir</i>()</a> function in the System Interfaces volume of IEEE&nbsp;Std&nbsp;1003.1-2001. For
example, by default, the mode of the directory is affected by the file mode creation mask in accordance with the specified behavior
of the <a href="../functions/mkdir.html"><i>mkdir</i>()</a> function. In this way, there is less duplication of effort required for
describing details of the directory creation.</p>
</blockquote>
<h4><a name="tag_04_87_19"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_04_87_20"></a>SEE ALSO</h4>
<blockquote>
<p><a href="chmod.html"><i>chmod</i>()</a> , <a href="rm.html"><i>rm</i></a> , <a href="rmdir.html"><i>rmdir</i>()</a> , <a href=
"umask.html"><i>umask</i>()</a> , the System Interfaces volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../functions/mkdir.html"><i>mkdir</i>()</a></p>
</blockquote>
<h4><a name="tag_04_87_21"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 2.</p>
</blockquote>
<h4><a name="tag_04_87_22"></a>Issue 5</h4>
<blockquote>
<p>The FUTURE DIRECTIONS section is added.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; 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>