mg Tue Jan 6 16:02:10 2004 EDT
Added files:
/phpdoc/en/reference/lzf/functions lzf-compress.xml
lzf-decompress.xml
lzf-optimized-for.xml
/phpdoc/en/reference/lzf functions.xml reference.xml
Log:
Added LZF documentation.
Index: phpdoc/en/reference/lzf/functions/lzf-compress.xml
+++ phpdoc/en/reference/lzf/functions/lzf-compress.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.lzf-compress">
<refnamediv>
<refname>lzf_compress</refname>
<refpurpose>
LZF compression.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>lzf_compress</methodname>
<methodparam><type>string</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<para>
<function>lzf_compress</function> compresses data in <parametr>arg</parametr>
parametr.
</para>
<para>
Returns compressed data or &false; if an error occured.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/lzf/functions/lzf-decompress.xml
+++ phpdoc/en/reference/lzf/functions/lzf-decompress.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.lzf-decompress">
<refnamediv>
<refname>lzf_decompress</refname>
<refpurpose>
LZF decompression.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>lzf_decompress</methodname>
<methodparam><type>string</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<para>
<function>lzf_decompress</function> decompresses data from parametr
<parametr>arg</parametr>.
</para>
<para>
Returns decompressed data or &false; if an error occured.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/lzf/functions/lzf-optimized-for.xml
+++ phpdoc/en/reference/lzf/functions/lzf-optimized-for.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.lzf-optimized-for">
<refnamediv>
<refname>lzf_optimized_for</refname>
<refpurpose>
Determines what lzf extension was optimized for.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lzf_optimized_for</methodname>
<void/>
</methodsynopsis>
<para>
Returns 1 if lzf was optimized for speed, 0 for compression.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/lzf/functions.xml
+++ phpdoc/en/reference/lzf/functions.xml
&reference.lzf.functions.lzf-compress;
&reference.lzf.functions.lzf-decompress;
&reference.lzf.functions.lzf-optimized-for;
Index: phpdoc/en/reference/lzf/reference.xml
+++ phpdoc/en/reference/lzf/reference.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<reference id="ref.lzf">
<title>LZF Functions</title>
<titleabbrev>LZF</titleabbrev>
<partintro>
<section id="lzf.intro">
&reftitle.intro;
<para>
LZF is a very fast compression algorithm, ideal for saving space with only slight
speed cost. It can be optimized for speed or space in compilation time.
</para>
</section>
<section id="lzf.installation">
&reftitle.install;
<para>
LZF is currently available through PECL (http://pecl.php.net/lzf).
To install LZF extension all you need to do is:
<programlisting role="shell">
<![CDATA[
gunzip lzf-xxx.tgz
tar -xvf lzf-xxx.tar
cd lzf-xxx
phpize
/configure && make && make install
]]>
</programlisting>
</para>
<para>
You can pass --enable-lzf-better-compression to optimize lzf for space rather
then speed.
</para>
</section>
</partintro>
&reference.lzf.functions;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
