[PHP-DOC] cvs: phpdoc /en/functions filesystem.xml From: Andrei Zmievski (andrei <email protected>)
Date: 07/11/00

andrei Tue Jul 11 13:06:21 2000 EDT

  Modified files:
    /phpdoc/en/functions filesystem.xml
  Log:
  Docs for realpath().
  
  
Index: phpdoc/en/functions/filesystem.xml
diff -u phpdoc/en/functions/filesystem.xml:1.22 phpdoc/en/functions/filesystem.xml:1.23
--- phpdoc/en/functions/filesystem.xml:1.22 Sat Jul 8 03:52:07 2000
+++ phpdoc/en/functions/filesystem.xml Tue Jul 11 13:06:21 2000
@@ -2029,6 +2029,38 @@
    </refsect1>
   </refentry>
 
+ <refentry id="function.realpath">
+ <refnamediv>
+ <refname>realpath</refname>
+ <refpurpose>Return canonicalized absolute pathname</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>realpath</function></funcdef>
+ <paramdef>string <parameter>path</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ <function>realpath</function> expands all symbolic links and
+ resolves references to '/./', '/../' and extra '/' characters in
+ the input <parameter>path</parameter> and return the canonicalized
+ absolute pathname. The resulting path will have no symbolic link,
+ '/./' or '/../' components.
+ </para>
+
+ <para>
+ <example>
+ <title><function>realpath</function> example</title>
+ <programlisting role="php">
+$real_path = realpath("../../index.php");
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ </refentry>
+
   <refentry id="function.symlink">
    <refnamediv>
     <refname>symlink</refname>