From 022db99f60780afd340e0229c0fd8a5300890f22 Mon Sep 17 00:00:00 2001
From: Marcin Gibula <mg@php.net>
Date: Tue, 6 Jan 2004 21:02:10 +0000
Subject: [PATCH] Added LZF documentation.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@148006 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/lzf/functions.xml                   |  3 +
 reference/lzf/functions/lzf-compress.xml      | 45 +++++++++++++++
 reference/lzf/functions/lzf-decompress.xml    | 45 +++++++++++++++
 reference/lzf/functions/lzf-optimized-for.xml | 42 ++++++++++++++
 reference/lzf/reference.xml                   | 56 +++++++++++++++++++
 5 files changed, 191 insertions(+)
 create mode 100644 reference/lzf/functions.xml
 create mode 100644 reference/lzf/functions/lzf-compress.xml
 create mode 100644 reference/lzf/functions/lzf-decompress.xml
 create mode 100644 reference/lzf/functions/lzf-optimized-for.xml
 create mode 100644 reference/lzf/reference.xml

diff --git a/reference/lzf/functions.xml b/reference/lzf/functions.xml
new file mode 100644
index 0000000000..7e7ee6d3a9
--- /dev/null
+++ b/reference/lzf/functions.xml
@@ -0,0 +1,3 @@
+&reference.lzf.functions.lzf-compress;
+&reference.lzf.functions.lzf-decompress;
+&reference.lzf.functions.lzf-optimized-for;
diff --git a/reference/lzf/functions/lzf-compress.xml b/reference/lzf/functions/lzf-compress.xml
new file mode 100644
index 0000000000..cd556bef03
--- /dev/null
+++ b/reference/lzf/functions/lzf-compress.xml
@@ -0,0 +1,45 @@
+<?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
+-->
diff --git a/reference/lzf/functions/lzf-decompress.xml b/reference/lzf/functions/lzf-decompress.xml
new file mode 100644
index 0000000000..1d064f9c63
--- /dev/null
+++ b/reference/lzf/functions/lzf-decompress.xml
@@ -0,0 +1,45 @@
+<?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
+-->
diff --git a/reference/lzf/functions/lzf-optimized-for.xml b/reference/lzf/functions/lzf-optimized-for.xml
new file mode 100644
index 0000000000..d44cda4831
--- /dev/null
+++ b/reference/lzf/functions/lzf-optimized-for.xml
@@ -0,0 +1,42 @@
+<?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
+-->
diff --git a/reference/lzf/reference.xml b/reference/lzf/reference.xml
new file mode 100644
index 0000000000..c825e530bd
--- /dev/null
+++ b/reference/lzf/reference.xml
@@ -0,0 +1,56 @@
+<?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
+-->