cvs: phpdoc /en/functions strings.xml

derick Wed Dec 12 02:53:11 2001 EDT Modified files: /phpdoc/en/functions strings.xml Log: - Add md5_file documentation Index: phpdoc/en/functions/strings.xml diff -u phpdoc/en/functions/strings.xml:1.134 phpdoc/en/functions/strings.xml:1.135 --- phpdoc/en/functions/strings.xml:1.134 Sat Dec 8 18:39:06 2001 +++ phpdoc/en/functions/strings.xml Wed Dec 12 02:53:11 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.134 $ --> +<!-- $Revision: 1.135 $ --> <reference id="ref.strings"> <title>String functions</title> <titleabbrev>Strings</titleabbrev> @@ -1539,7 +1539,36 @@ The hash is a 32-character hexadecimal number. </para> <para> - See also <function>crc32</function>. + See also: <function>crc32</function> and <function>md5_file</function> + </para> + </refsect1> + </refentry> + + <refentry id="function.md5-file"> + <refnamediv> + <refname>md5_file</refname> + <refpurpose>Calculates the md5 hash of a given filename</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>md5_file</function></funcdef> + <paramdef>string <parameter>filename</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Calculates the MD5 hash of the specified + <parameter>filename</parameter> using the + <ulink url="&url.rfc;rfc1321.html">RSA Data Security, Inc. + MD5 Message-Digest Algorithm</ulink>, and returns that hash. + </para> + <para> + This function has the same purpose of the command line utility + md5sum. + </para> + <para> + See also: <function>md5</function> and <function>crc32</function> </para> </refsect1> </refentry>