Applying new structure, adding constants

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@89173 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Gabor Hojtsy 2002-07-20 12:09:59 +00:00
parent dd2787ae73
commit c2c9df9734
2 changed files with 95 additions and 37 deletions

View file

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="zlib.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>FORCE_GZIP</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>FORCE_DEFLATE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- 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:
-->

View file

@ -1,46 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<reference id="ref.zlib">
<title>Zlib Compression Functions</title>
<titleabbrev>Zlib</titleabbrev>
<partintro>
<para>
This module uses the functions of <ulink
url="&url.zlib;">zlib</ulink> by Jean-loup Gailly and Mark Adler to
transparently read and write gzip (.gz) compressed files. You have
to use a zlib version &gt;= 1.0.9 with this module.
</para>
<para>
This module contains versions of most of the <link
linkend="ref.filesystem">filesystem</link> functions which work
with gzip-compressed files (and uncompressed files, too, but not
with sockets).
</para>
<note>
<para>
Version 4.0.4 introduces a fopen-wrapper for .gz-files, so that
you can use a special 'zlib:' URL to access compressed files
transparently using the normal f*() file access functions if you
prepend the filename or path with a 'zlib:' prefix when calling
<function>fopen</function>.
</para>
<para>
In version 4.3.0, this special prefix has been changed to 'zlib://'
to prevent ambiguities with filenames containing ':'.
</para>
<para>
This feature requires a C runtime library that provides the
<literal>fopencookie()</literal> function. To my current
knowledge the GNU libc is the only library that provides
this feature.
</para>
</note>
<section id="zlib-example">
<title>Small code example</title>
<partintro>
<section id="zlib.intro">
&reftitle.intro;
<para>
Opens a temporary file and writes a test string to it, then it
prints out the content of this file twice.
This module enables you to transparently read and write
gzip (.gz) compressed files, through versions of most of
the <link linkend="ref.filesystem">filesystem</link> functions
which work with gzip-compressed files (and uncompressed files,
too, but not with sockets).
</para>
<note>
<para>
Version 4.0.4 introduced a fopen-wrapper for .gz-files, so that
you can use a special 'zlib:' URL to access compressed files
transparently using the normal f*() file access functions if you
prepend the filename or path with a 'zlib:' prefix when calling
<function>fopen</function>.
</para>
<para>
In version 4.3.0, this special prefix has been changed to 'zlib://'
to prevent ambiguities with filenames containing ':'.
</para>
<para>
This feature requires a C runtime library that provides the
<literal>fopencookie()</literal> function. To my current
knowledge the GNU libc is the only library that provides
this feature.
</para>
</note>
</section>
<section id="zlib.requirements">
&reftitle.required;
<para>
This module uses the functions of <ulink url="&url.zlib;">zlib</ulink>
by Jean-loup Gailly and Mark Adler. You have to use a zlib
version &gt;= 1.0.9 with this module.
</para>
</section>
&reference.zlib.constants;
<section id="zlib.examples">
&reftitle.examples;
<para>
This example opens a temporary file and writes a test string
to it, then it prints out the content of this file twice.
</para>
<example>
<title>Small Zlib Example</title>