<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/zlib.xml, last change in rev 1.4 -->
  <refentry id="function.gzcompress">
   <refnamediv>
    <refname>gzcompress</refname>
    <refpurpose>Compress a string</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>gzcompress</methodname>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function returns a compressed version of the input
     <parameter>data</parameter> using the ZLIB data format,
     or &false; if an error is encountered. The optional parameter
     <parameter>level</parameter> can be given as 0 for no
     compression up to 9 for maximum compression.
    </para>
    <para>
     For details on the ZLIB compression algorithm see the document
     "<ulink url="&url.rfc;1950">ZLIB Compressed Data Format
     Specification version 3.3</ulink>" (RFC 1950).
    </para>
    <note>
     <para>
      This is <emphasis>not</emphasis> the same as gzip compression,
      which includes some header data. See <function>gzencode</function>
      for gzip compression.
     </para>
    </note>
    <para>
     See also <function>gzdeflate</function>,
     <function>gzinflate</function>,
     <function>gzuncompress</function>,
     <function>gzencode</function>.
    </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
-->