- Added documentation for the chroot() function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@41290 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2001-02-15 19:53:57 +00:00
parent fbd49b6663
commit 70b791fb93

View file

@ -2,6 +2,33 @@
<title>Directory functions</title>
<titleabbrev>Directories</titleabbrev>
<refentry id="function.chroot">
<refnamediv>
<refname>chroot</refname>
<refpurpose>change the root directory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>chroot</function></funcdef>
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Changes the root directory of the current process to
<parameter>directory</parameter>. Returns FALSE if unable to
change the root directory, TRUE otherwise.
<note>
It's not wise to use this function when running in a webserver
environment, because it's not possible to reset the root
directory to / again at the end of the request. This function
will only function correct when running as CGI this way.
</note>
</para>
</refsect1>
</refentry>
<refentry id="function.chdir">
<refnamediv>
<refname>chdir</refname>