derick Thu Feb 15 11:53:57 2001 EDT
Modified files:
/phpdoc/en/functions dir.xml
Log:
- Added documentation for the chroot() function
Index: phpdoc/en/functions/dir.xml
diff -u phpdoc/en/functions/dir.xml:1.10 phpdoc/en/functions/dir.xml:1.11
--- phpdoc/en/functions/dir.xml:1.10 Thu Oct 5 21:49:32 2000
+++ phpdoc/en/functions/dir.xml Thu Feb 15 11:53:57 2001
@@ -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>
