[PHP-DOC] cvs: phpdoc /en/functions filesystem.xml From: Jon Parise (jon <email protected>)
Date: 05/15/01

jon Tue May 15 16:51:56 2001 EDT

  Modified files:
    /phpdoc/en/functions filesystem.xml
  Log:
  Documentation for the new disk_total_space() function.
  
  
Index: phpdoc/en/functions/filesystem.xml
diff -u phpdoc/en/functions/filesystem.xml:1.63 phpdoc/en/functions/filesystem.xml:1.64
--- phpdoc/en/functions/filesystem.xml:1.63 Mon May 14 05:37:47 2001
+++ phpdoc/en/functions/filesystem.xml Tue May 15 16:51:56 2001
@@ -330,6 +330,36 @@
    </refsect1>
   </refentry>
 
+ <refentry id="function.disk-total-space">
+ <refnamediv>
+ <refname>disk_total_space</refname>
+ <refpurpose>Returns the total size of a directory</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>float <function>disk_total_space</function></funcdef>
+ <paramdef>string <parameter>directory</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Given a string containing a directory, this function will return
+ the total number of bytes on the corresponding filesystem or disk
+ partition.
+ </para>
+ <para>
+ <example>
+ <title><function>disk_total_space</function> example</title>
+ <programlisting role="php">
+$df = disk_total_space("/"); // $df contains the total number of
+ // bytes available on "/"
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ </refentry>
+
   <refentry id="function.fclose">
    <refnamediv>
     <refname>fclose</refname>