reference/bzip2/functions/bzopen.xml
c564dbc4f35dd39b4415ebbb671f2764a44306a6
...
...
@@ -8,12 +8,12 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>resource</type><methodname>bzopen</methodname>
12
-
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
11
+
<type class="union"><type>resource</type><type>false</type></type><methodname>bzopen</methodname>
12
+
<methodparam><type class="union"><type>string</type><type>resource</type></type><parameter>file</parameter></methodparam>
13
13
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
-
<function>bzopen</function> opens a bzip2 (.bz2) file for reading or
16
+
<function>bzopen</function> opens a bzip2 (<filename>.bz2</filename>) file for reading or
17
17
writing.
18
18
</para>
19
19
</refsect1>
...
...
@@ -22,7 +22,7 @@
22
22
<para>
23
23
<variablelist>
24
24
<varlistentry>
25
-
<term><parameter>filename</parameter></term>
25
+
<term><parameter>file</parameter></term>
26
26
<listitem>
27
27
<para>
28
28
The name of the file to open, or an existing stream resource.
...
...
@@ -33,9 +33,8 @@
33
33
<term><parameter>mode</parameter></term>
34
34
<listitem>
35
35
<para>
36
-
Similar to the <function>fopen</function> function, only 'r' (read)
37
-
and 'w' (write) are supported. Everything else will cause bzopen
38
-
to return &false;.
36
+
The modes <literal>'r'</literal> (read), and <literal>'w'</literal> (write) are supported.
37
+
Everything else will cause <function>bzopen</function> to return &false;.
39
38
</para>
40
39
</listitem>
41
40
</varlistentry>
...
...
@@ -78,7 +77,6 @@ bzclose($bz);
78
77
</para>
79
78
</refsect1>
80
79
</refentry>
81
-

82
80
<!-- Keep this comment at the end of the file
83
81
Local variables:
84
82
mode: sgml
85
83