didou Sat Feb 5 21:20:23 2005 EDT
Modified files:
/phpdoc/en/reference/bzip2/functions bzclose.xml bzcompress.xml
bzdecompress.xml bzerrno.xml
bzerror.xml bzerrstr.xml
bzflush.xml bzopen.xml
bzread.xml bzwrite.xml
Log:
WS (start at col 0 and end at col 78
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzclose.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzclose.xml
diff -u phpdoc/en/reference/bzip2/functions/bzclose.xml:1.4
phpdoc/en/reference/bzip2/functions/bzclose.xml:1.5
--- phpdoc/en/reference/bzip2/functions/bzclose.xml:1.4 Sat Jan 29 20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzclose.xml Sat Feb 5 21:20:23 2005
@@ -1,51 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
- <refentry id="function.bzclose">
- <refnamediv>
- <refname>bzclose</refname>
- <refpurpose>Close a bzip2 file</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>int</type><methodname>bzclose</methodname>
- <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
- </methodsynopsis>
- <para>
- Closes the bzip2 file referenced by the pointer <parameter>bz</parameter>.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
successfully
- opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- &return.success;
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzopen</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.bzclose">
+ <refnamediv>
+ <refname>bzclose</refname>
+ <refpurpose>Close a bzip2 file</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>bzclose</methodname>
+ <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Closes the given bzip2 file pointer.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzopen</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzcompress.xml?r1=1.8&r2=1.9&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzcompress.xml
diff -u phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.8
phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.9
--- phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.8 Sat Jan 29
20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzcompress.xml Sat Feb 5 21:20:23 2005
@@ -1,75 +1,73 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
- <refentry id="function.bzcompress">
- <refnamediv>
- <refname>bzcompress</refname>
- <refpurpose>Compress a string into bzip2 encoded data</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>string</type><methodname>bzcompress</methodname>
-
<methodparam><type>string</type><parameter>source</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>blocksize</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>workfactor</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>bzcompress</function> compresses the given string and returns
- it as bzip2 encoded data.
- </para>
- <para>
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>source</parameter></term>
- <listitem>
- <para>
- The string to compress.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>blocksize</parameter></term>
- <listitem>
- <para>
- Specifies the blocksize used during compression and should be a
number
- from 1 to 9 with 9 giving the best compression, but using more
resources
- to do so. <parameter>blocksize</parameter> defaults to 4.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>workfactor</parameter></term>
- <listitem>
- <para>
- Controls how the compression phase behaves when presented with worst
- case, highly repetitive, input data. The value can be between 0 and
- 250 with 0 being a special case and 30 being the default value.
- </para>
- <para>
- Regardless of the <parameter>workfactor</parameter>, the generated
- output is the same.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- The compressed string.
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title>Compressing data</title>
- <programlisting role="php">
+<!-- $Revision: 1.9 $ -->
+<refentry id="function.bzcompress">
+ <refnamediv>
+ <refname>bzcompress</refname>
+ <refpurpose>Compress a string into bzip2 encoded data</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>bzcompress</methodname>
+ <methodparam><type>string</type><parameter>source</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>blocksize</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>workfactor</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>bzcompress</function> compresses the given string and returns
+ it as bzip2 encoded data.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>source</parameter></term>
+ <listitem>
+ <para>
+ The string to compress.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>blocksize</parameter></term>
+ <listitem>
+ <para>
+ Specifies the blocksize used during compression and should be a number
+ from 1 to 9 with 9 giving the best compression, but using more
+ resources to do so. <parameter>blocksize</parameter> defaults to 4.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>workfactor</parameter></term>
+ <listitem>
+ <para>
+ Controls how the compression phase behaves when presented with worst
+ case, highly repetitive, input data. The value can be between 0 and
+ 250 with 0 being a special case and 30 being the default value.
+ </para>
+ <para>
+ Regardless of the <parameter>workfactor</parameter>, the generated
+ output is the same.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The compressed string.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title>Compressing data</title>
+ <programlisting role="php">
<![CDATA[
<?php
$str = "sample data";
@@ -77,18 +75,18 @@
echo $bzstr;
?>
]]>
- </programlisting>
- </example>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzdecompress</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzdecompress</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzdecompress.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzdecompress.xml
diff -u phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.9
phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.10
--- phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.9 Sat Jan 29
20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzdecompress.xml Sat Feb 5
21:20:23 2005
@@ -1,63 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
- <refentry id="function.bzdecompress">
- <refnamediv>
- <refname>bzdecompress</refname>
- <refpurpose>Decompresses bzip2 encoded data</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>string</type><methodname>bzdecompress</methodname>
-
<methodparam><type>string</type><parameter>source</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>small</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>bzdecompress</function> decompresses the given string containing
- bzip2 encoded data.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>source</parameter></term>
- <listitem>
- <para>
- The string to decompress.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>small</parameter></term>
- <listitem>
- <para>
- If &true;, an alternative decompression algorithm will be used which
- uses less memory (the maximum memory requirement drops to around
2300K)
- but works at roughly half the speed.
- </para>
- <para>
- See the <ulink url="&url.bzip2;">bzip2 documentation</ulink> for more
- information about this feature.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- The decompressed string.
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>Decompressing a String</title>
- <programlisting role="php">
+<!-- $Revision: 1.10 $ -->
+<refentry id="function.bzdecompress">
+ <refnamediv>
+ <refname>bzdecompress</refname>
+ <refpurpose>Decompresses bzip2 encoded data</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>bzdecompress</methodname>
+ <methodparam><type>string</type><parameter>source</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>small</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>bzdecompress</function> decompresses the given string containing
+ bzip2 encoded data.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>source</parameter></term>
+ <listitem>
+ <para>
+ The string to decompress.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>small</parameter></term>
+ <listitem>
+ <para>
+ If &true;, an alternative decompression algorithm will be used which
+ uses less memory (the maximum memory requirement drops to around 2300K)
+ but works at roughly half the speed.
+ </para>
+ <para>
+ See the <ulink url="&url.bzip2;">bzip2 documentation</ulink> for more
+ information about this feature.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The decompressed string.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Decompressing a String</title>
+ <programlisting role="php">
<![CDATA[
<?php
$start_str = "This is not an honest face?";
@@ -73,19 +73,19 @@
echo "\n<br />\n";
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzcompress</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzcompress</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerrno.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzerrno.xml
diff -u phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.4
phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.5
--- phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.4 Sat Jan 29 20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzerrno.xml Sat Feb 5 21:20:23 2005
@@ -1,53 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
- <refentry id="function.bzerrno">
- <refnamediv>
- <refname>bzerrno</refname>
- <refpurpose>Returns a bzip2 error number</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>int</type><methodname>bzerrno</methodname>
- <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
- </methodsynopsis>
- <para>
- Returns the error number of any bzip2 error returned by the given file
- pointer.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
successfully
- opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- Returns the error number as an interger.
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzerror</function></member>
- <member><function>bzerrstr</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.bzerrno">
+ <refnamediv>
+ <refname>bzerrno</refname>
+ <refpurpose>Returns a bzip2 error number</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>bzerrno</methodname>
+ <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Returns the error number of any bzip2 error returned by the given file
+ pointer.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the error number as an interger.
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzerror</function></member>
+ <member><function>bzerrstr</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerror.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzerror.xml
diff -u phpdoc/en/reference/bzip2/functions/bzerror.xml:1.5
phpdoc/en/reference/bzip2/functions/bzerror.xml:1.6
--- phpdoc/en/reference/bzip2/functions/bzerror.xml:1.5 Sat Jan 29 20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzerror.xml Sat Feb 5 21:20:23 2005
@@ -1,51 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.bzerror">
- <refnamediv>
- <refname>bzerror</refname>
- <refpurpose>Returns the bzip2 error number and error string in an
array</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>array</type><methodname>bzerror</methodname>
- <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
- </methodsynopsis>
- <para>
- Returns the error number and error string of any bzip2 error returned by
- the given file pointer.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
successfully
- opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- Returns an associative array, with the error code in the
- <literal>errno</literal> entry, and the error message in the
- <literal>errstr</literal> entry.
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title><function>bzerror</function> example</title>
- <programlisting role="php">
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.bzerror">
+ <refnamediv>
+ <refname>bzerror</refname>
+ <refpurpose>
+ Returns the bzip2 error number and error string in an array
+ </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>bzerror</methodname>
+ <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Returns the error number and error string of any bzip2 error returned by
+ the given file pointer.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an associative array, with the error code in the
+ <literal>errno</literal> entry, and the error message in the
+ <literal>errstr</literal> entry.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>bzerror</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$error = bzerror($bz);
@@ -54,20 +56,20 @@
echo $error["errstr"];
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzerrno</function></member>
- <member><function>bzerrstr</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzerrno</function></member>
+ <member><function>bzerrstr</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerrstr.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzerrstr.xml
diff -u phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.5
phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.6
--- phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.5 Sat Jan 29
20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzerrstr.xml Sat Feb 5 21:20:23 2005
@@ -1,53 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.bzerrstr">
- <refnamediv>
- <refname>bzerrstr</refname>
- <refpurpose>Returns a bzip2 error string</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>string</type><methodname>bzerrstr</methodname>
- <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
- </methodsynopsis>
- <para>
- Gets the error string of any bzip2 error returned by the given file
- pointer.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
successfully
- opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- Returns a string containing the error message.
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzerrno</function></member>
- <member><function>bzerror</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.bzerrstr">
+ <refnamediv>
+ <refname>bzerrstr</refname>
+ <refpurpose>Returns a bzip2 error string</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>bzerrstr</methodname>
+ <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Gets the error string of any bzip2 error returned by the given file
+ pointer.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a string containing the error message.
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzerrno</function></member>
+ <member><function>bzerror</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzflush.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzflush.xml
diff -u phpdoc/en/reference/bzip2/functions/bzflush.xml:1.4
phpdoc/en/reference/bzip2/functions/bzflush.xml:1.5
--- phpdoc/en/reference/bzip2/functions/bzflush.xml:1.4 Sat Jan 29 20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzflush.xml Sat Feb 5 21:20:23 2005
@@ -1,53 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
- <refentry id="function.bzflush">
- <refnamediv>
- <refname>bzflush</refname>
- <refpurpose>Force a write of all buffered data</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>int</type><methodname>bzflush</methodname>
- <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
- </methodsynopsis>
- <para>
- Forces a write of all buffered bzip2 data for the file pointer
- <parameter>bz</parameter>.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
successfully
- opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- &return.success;
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzread</function></member>
- <member><function>bzwrite</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.bzflush">
+ <refnamediv>
+ <refname>bzflush</refname>
+ <refpurpose>Force a write of all buffered data</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>bzflush</methodname>
+ <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Forces a write of all buffered bzip2 data for the file pointer
+ <parameter>bz</parameter>.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzread</function></member>
+ <member><function>bzwrite</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzopen.xml?r1=1.8&r2=1.9&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzopen.xml
diff -u phpdoc/en/reference/bzip2/functions/bzopen.xml:1.8
phpdoc/en/reference/bzip2/functions/bzopen.xml:1.9
--- phpdoc/en/reference/bzip2/functions/bzopen.xml:1.8 Sat Jan 29 20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzopen.xml Sat Feb 5 21:20:23 2005
@@ -1,58 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
- <refentry id="function.bzopen">
- <refnamediv>
- <refname>bzopen</refname>
- <refpurpose>Opens a bzip2 compressed file</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>resource</type><methodname>bzopen</methodname>
-
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
- <methodparam><type>string</type><parameter>mode</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>bzopen</function> opens a bzip2 (.bz2) file for reading or
writing.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- The name of the file to open.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- <para>
- Similar to the <function>fopen</function> function ('r' for read, 'w'
for
- write, etc.).
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- If the open fails, <function>bzopen</function> returns &false;, otherwise
it
- returns a pointer to the newly opened file.
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title><function>bzopen</function> example</title>
- <programlisting role="php">
+<!-- $Revision: 1.9 $ -->
+<refentry id="function.bzopen">
+ <refnamediv>
+ <refname>bzopen</refname>
+ <refpurpose>Opens a bzip2 compressed file</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>resource</type><methodname>bzopen</methodname>
+
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
+ <methodparam><type>string</type><parameter>mode</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>bzopen</function> opens a bzip2 (.bz2) file for reading or
+ writing.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The name of the file to open.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ Similar to the <function>fopen</function> function ('r' for read,
+ 'w' for write, etc.).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ If the open fails, <function>bzopen</function> returns &false;, otherwise
+ it returns a pointer to the newly opened file.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>bzopen</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -63,19 +64,19 @@
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzclose</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzclose</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzread.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzread.xml
diff -u phpdoc/en/reference/bzip2/functions/bzread.xml:1.9
phpdoc/en/reference/bzip2/functions/bzread.xml:1.10
--- phpdoc/en/reference/bzip2/functions/bzread.xml:1.9 Sat Jan 29 20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzread.xml Sat Feb 5 21:20:23 2005
@@ -1,62 +1,62 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
- <refentry id="function.bzread">
- <refnamediv>
- <refname>bzread</refname>
- <refpurpose>Binary safe bzip2 file read</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>string</type><methodname>bzread</methodname>
- <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>length</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>bzread</function> reads from the given bzip2 file pointer.
- </para>
- <para>
- Reading stops when <parameter>length</parameter> (uncompressed) bytes
have been read
- or EOF is reached, whichever comes first.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
successfully
- opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>length</parameter></term>
- <listitem>
- <para>
- If not specified, <function>bzread</function> will read 1024
- (uncompressed) bytes at a time.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- Returns the uncompressed data, or &false; on error.
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title><function>bzread</function> example</title>
- <programlisting role="php">
+<!-- $Revision: 1.10 $ -->
+<refentry id="function.bzread">
+ <refnamediv>
+ <refname>bzread</refname>
+ <refpurpose>Binary safe bzip2 file read</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>bzread</methodname>
+ <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>length</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>bzread</function> reads from the given bzip2 file pointer.
+ </para>
+ <para>
+ Reading stops when <parameter>length</parameter> (uncompressed) bytes have
+ been read or EOF is reached, whichever comes first.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>length</parameter></term>
+ <listitem>
+ <para>
+ If not specified, <function>bzread</function> will read 1024
+ (uncompressed) bytes at a time.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the uncompressed data, or &false; on error.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>bzread</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -65,7 +65,7 @@
$decompressed_file = '';
while (!feof($bz)) {
- $decompressed_file .= bzread($bz, 4096);
+ $decompressed_file .= bzread($bz, 4096);
}
bzclose($bz);
@@ -74,21 +74,21 @@
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzwrite</function></member>
- <member><function>feof</function></member>
- <member><function>bzopen</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzwrite</function></member>
+ <member><function>feof</function></member>
+ <member><function>bzopen</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzwrite.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/bzip2/functions/bzwrite.xml
diff -u phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.5
phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.6
--- phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.5 Sat Jan 29 20:46:49 2005
+++ phpdoc/en/reference/bzip2/functions/bzwrite.xml Sat Feb 5 21:20:23 2005
@@ -1,69 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
- <refentry id="function.bzwrite">
- <refnamediv>
- <refname>bzwrite</refname>
- <refpurpose>Binary safe bzip2 file write</refpurpose>
- </refnamediv>
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <type>int</type><methodname>bzwrite</methodname>
- <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
- <methodparam><type>string</type><parameter>data</parameter></methodparam>
- <methodparam
choice="opt"><type>int</type><parameter>length</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>bzwrite</function> writes a string into the given bzip2 file
- stream.
- </para>
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
successfully
- opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- The written data.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>length</parameter></term>
- <listitem>
- <para>
- If supplied, writing will stop after <parameter>length</parameter>
- (uncompressed) bytes have been written or the end of
- <parameter>data</parameter> is reached, whichever comes first.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- Returns the number of bytes written, or &false; on error.
- </para>
- </refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title><function>bzwrite</function> example</title>
- <programlisting role="php">
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.bzwrite">
+ <refnamediv>
+ <refname>bzwrite</refname>
+ <refpurpose>Binary safe bzip2 file write</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>bzwrite</methodname>
+ <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>length</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>bzwrite</function> writes a string into the given bzip2 file
+ stream.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ The written data.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>length</parameter></term>
+ <listitem>
+ <para>
+ If supplied, writing will stop after <parameter>length</parameter>
+ (uncompressed) bytes have been written or the end of
+ <parameter>data</parameter> is reached, whichever comes first.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the number of bytes written, or &false; on error.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>bzwrite</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$str = "uncompressed data";
@@ -72,20 +72,20 @@
bzclose($bz);
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- <refsect1 role="seealso">
- &reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzread</function></member>
- <member><function>bzopen</function></member>
- </simplelist>
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>bzread</function></member>
+ <member><function>bzopen</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
