php-doc-en/reference/filesystem/functions/mkdir.xml
Gabor Hojtsy 99836ba9dd Adding explanation of modes in chmod functions documentation. Feel free
to correct wording if it is not correct. Also moved Nicos' note on modes
here. Point to chmod page from mkdir for mode details.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@110255 c90b9560-bf6c-de11-be94-00142212c4b1
2003-01-03 21:32:06 +00:00

72 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.39 -->
<refentry id="function.mkdir">
<refnamediv>
<refname>mkdir</refname>
<refpurpose>Makes directory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>mkdir</methodname>
<methodparam><type>string</type><parameter>pathname</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to create the directory specified by pathname.
</para>
<para>
Note that you probably want to specify the mode as an
octal number, which means it should have a leading zero.
The mode is also modified by the current umask, which you
can change using <function>umask</function>.
</para>
<para>
<note>
<para>
Mode is ignored on Windows, and became optional in PHP 4.2.0.
</para>
</note>
</para>
<para>
The mode is 0777 by default, which means the widest possible
access. For more information on modes, read the details
on the <function>chmod</function> page.
<informalexample>
<programlisting role="php">
<![CDATA[
mkdir ("/path/to/my/dir", 0700);
]]>
</programlisting>
</informalexample>
</para>
<para>
&return.success;
</para>
<para>
See also <function>rmdir</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->