[DOC-CVS] [doc-en] master: rar : fix XML by converting para to simpara tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-25T15:15:29Z
Commit: https://github.com/php/doc-en/commit/ee741f54f831af19f135d1d9894a41477ab896c3
Raw diff: https://github.com/php/doc-en/commit/ee741f54f831af19f135d1d9894a41477ab896c3.diff
rar : fix XML by converting para to simpara tags via script
Changed paths:
M reference/rar/book.xml
M reference/rar/examples.xml
M reference/rar/functions/rar-wrapper-cache-stats.xml
M reference/rar/rararchive.xml
M reference/rar/rararchive/close.xml
M reference/rar/rararchive/getcomment.xml
M reference/rar/rararchive/getentries.xml
M reference/rar/rararchive/getentry.xml
M reference/rar/rararchive/isbroken.xml
M reference/rar/rararchive/issolid.xml
M reference/rar/rararchive/open.xml
M reference/rar/rararchive/setallowbroken.xml
M reference/rar/rararchive/tostring.xml
M reference/rar/rarentry.xml
M reference/rar/rarentry/extract.xml
M reference/rar/rarentry/getattr.xml
M reference/rar/rarentry/getcrc.xml
M reference/rar/rarentry/getfiletime.xml
M reference/rar/rarentry/gethostos.xml
M reference/rar/rarentry/getmethod.xml
M reference/rar/rarentry/getname.xml
M reference/rar/rarentry/getpackedsize.xml
M reference/rar/rarentry/getstream.xml
M reference/rar/rarentry/getunpackedsize.xml
M reference/rar/rarentry/getversion.xml
M reference/rar/rarentry/isdirectory.xml
M reference/rar/rarentry/isencrypted.xml
M reference/rar/rarentry/tostring.xml
M reference/rar/rarexception.xml
M reference/rar/rarexception/isusingexceptions.xml
M reference/rar/rarexception/setusingexceptions.xml
M reference/rar/setup.xml
Diff:
diff --git a/reference/rar/book.xml b/reference/rar/book.xml
index c28a4718858a..47e9a39e9cd6 100644
--- a/reference/rar/book.xml
+++ b/reference/rar/book.xml
@@ -1,27 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.rar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.rar">
<?phpdoc extension-membership="pecl" ?>
<title>Rar Archiving</title>
<titleabbrev>Rar</titleabbrev>
-
+
<!-- {{{ preface -->
<preface xml:id="intro.rar">
&reftitle.intro;
- <para>
- Rar is a powerful and effective archiver created by Eugene Roshal.
+ <simpara>
+ Rar is a powerful and effective archiver created by Eugene Roshal.
This extension gives you possibility to read Rar archives but
- doesn't support writing Rar archives, because this is not supported
+ doesn't support writing Rar archives, because this is not supported
by the UnRar library and is directly prohibited by its license.
- </para>
- <para>
- More information about Rar and UnRar can be found at <link
- xlink:href="&url.rar;">&url.rar;</link>.
- </para>
+ </simpara>
+ <simpara>
+ More information about Rar and UnRar can be found at <link xlink:href="&url.rar;">&url.rar;</link>.
+ </simpara>
</preface>
<!-- }}} -->
-
+
&reference.rar.setup;
&reference.rar.constants;
&reference.rar.examples;
@@ -31,7 +29,6 @@
&reference.rar.rarexception;
</book>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -52,4 +49,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/rar/examples.xml b/reference/rar/examples.xml
index a1e58a626833..e8fa7cbc7853 100644
--- a/reference/rar/examples.xml
+++ b/reference/rar/examples.xml
@@ -3,9 +3,9 @@
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rar.examples">
&reftitle.examples;
- <para>
+ <simpara>
See also the examples under <link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link>.
- </para>
+ </simpara>
<example>
<title>On-the-fly decompression</title>
@@ -115,9 +115,9 @@ while (!feof($fp)) {
]]>
</programlisting>
</example>
- <para>
+ <simpara>
This example opens a RAR file and presents the requested file inside the RAR archive for download to the client.
- </para>
+ </simpara>
<example>
<title>RAR extension filesystem extraction example</title>
@@ -143,10 +143,10 @@ rar_close($rar_file);
]]>
</programlisting>
</example>
- <para>
+ <simpara>
This example opens a RAR file archive and extracts each entry to the
specified directory.
- </para>
+ </simpara>
</chapter>
<!-- Keep this comment at the end of the file
diff --git a/reference/rar/functions/rar-wrapper-cache-stats.xml b/reference/rar/functions/rar-wrapper-cache-stats.xml
index 327a4e606244..b8b8c2b413d9 100644
--- a/reference/rar/functions/rar-wrapper-cache-stats.xml
+++ b/reference/rar/functions/rar-wrapper-cache-stats.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.rar-wrapper-cache-stats" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.rar-wrapper-cache-stats">
<refnamediv>
<refname>rar_wrapper_cache_stats</refname>
<refpurpose>Cache hits and misses for the URL wrapper</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>rar_wrapper_cache_stats</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -28,14 +27,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
-
- </para>
+ <simpara>
+
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive.xml b/reference/rar/rararchive.xml
index d2c61e95369f..a158b5adb053 100644
--- a/reference/rar/rararchive.xml
+++ b/reference/rar/rararchive.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.rararchive" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.rararchive" role="class">
<title>The RarArchive class</title>
<titleabbrev>RarArchive</titleabbrev>
@@ -11,15 +10,15 @@
<!-- {{{ RarArchive intro -->
<section xml:id="rararchive.intro">
&reftitle.intro;
- <para>
+ <simpara>
This class represents a RAR archive, which may be formed by several volumes (parts) and which contains
a number of RAR entries (i.e., files, directories and other special objects such as symbolic links).
- </para>
- <para>
+ </simpara>
+ <simpara>
Objects of this class can be traversed, yielding the entries stored in the respective RAR archive.
Those entries can also be obtained through <methodname>RarArchive::getEntry</methodname> and
<methodname>RarArchive::getEntries</methodname>.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -36,15 +35,15 @@
<modifier>final</modifier>
<classname>RarArchive</classname>
</ooclass>
-
+
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
-
+
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rararchive')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rararchive')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -55,7 +54,6 @@
&reference.rar.entities.rararchive;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rararchive/close.xml b/reference/rar/rararchive/close.xml
index 5b5873b7d63d..bdcbc7f67fff 100644
--- a/reference/rar/rararchive/close.xml
+++ b/reference/rar/rararchive/close.xml
@@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
- <para>&style.oop; (method):</para>
+ <simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarArchive::close</methodname>
<void/>
</methodsynopsis>
- <para>&style.procedural;:</para>
+ <simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>rar_close</methodname>
<methodparam><type>RarArchive</type><parameter>rarfile</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Close RAR archive and free all allocated resources.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,9 +30,9 @@
<varlistentry>
<term><parameter>rarfile</parameter></term>
<listitem>
- <para>
+ <simpara>
A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +40,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rararchive/getcomment.xml b/reference/rar/rararchive/getcomment.xml
index f4334ddbf89a..3c197af145f7 100644
--- a/reference/rar/rararchive/getcomment.xml
+++ b/reference/rar/rararchive/getcomment.xml
@@ -9,23 +9,23 @@
<refsect1 role="description">
&reftitle.description;
- <para>&style.oop; (method):</para>
+ <simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>RarArchive::getComment</methodname>
<void/>
</methodsynopsis>
- <para>&style.procedural;:</para>
+ <simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>string</type><methodname>rar_comment_get</methodname>
<methodparam><type>RarArchive</type><parameter>rarfile</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Get the (global) comment stored in the RAR archive. It may be up to 64 KiB long.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
This extension does not support comments at the entry level.
- </para>
+ </simpara>
</note>
</refsect1>
@@ -35,9 +35,9 @@
<varlistentry>
<term><parameter>rarfile</parameter></term>
<listitem>
- <para>
+ <simpara>
A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,15 +45,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the comment or &null; if there is none.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
RAR has currently no support for unicode comments. The encoding of the
result of this function is not specified, but it will probably be
Windows-1252.
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/rar/rararchive/getentries.xml b/reference/rar/rararchive/getentries.xml
index c1419eddba66..981992e53b0b 100644
--- a/reference/rar/rararchive/getentries.xml
+++ b/reference/rar/rararchive/getentries.xml
@@ -9,28 +9,28 @@
<refsect1 role="description">
&reftitle.description;
- <para>&style.oop; (method):</para>
+ <simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>RarArchive::getEntries</methodname>
<void/>
</methodsynopsis>
- <para>&style.procedural;:</para>
+ <simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>rar_list</methodname>
<methodparam><type>RarArchive</type><parameter>rarfile</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Get entries list (files and directories) from the RAR archive.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
If the archive has
entries with the same name, this method, together with <type>RarArchive</type>
<literal>foreach</literal> iteration and array-like access with numeric indexes,
are the only ones to access all the entries (i.e.,
<methodname>RarArchive::getEntry</methodname> and the <link linkend="wrappers.rar">
<literal>rar://</literal> wrapper</link> are insufficient).
- </para>
+ </simpara>
</note>
</refsect1>
@@ -40,9 +40,9 @@
<varlistentry>
<term><parameter>rarfile</parameter></term>
<listitem>
- <para>
+ <simpara>
A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,10 +50,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
<function>rar_list</function> returns array of <type>RarEntry</type> objects
&return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rararchive/getentry.xml b/reference/rar/rararchive/getentry.xml
index 66ef4350cd71..f98731c75df7 100644
--- a/reference/rar/rararchive/getentry.xml
+++ b/reference/rar/rararchive/getentry.xml
@@ -9,24 +9,24 @@
<refsect1 role="description">
&reftitle.description;
- <para>&style.oop; (method):</para>
+ <simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>RarEntry</type><type>false</type></type><methodname>RarArchive::getEntry</methodname>
<methodparam><type>string</type><parameter>entryname</parameter></methodparam>
</methodsynopsis>
- <para>&style.procedural;:</para>
+ <simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type class="union"><type>RarEntry</type><type>false</type></type><methodname>rar_entry_get</methodname>
<methodparam><type>RarArchive</type><parameter>rarfile</parameter></methodparam>
<methodparam><type>string</type><parameter>entryname</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Get entry object (file or directory) from the RAR archive.
- </para>
+ </simpara>
<note>
- <para>You can also get entry objects using <methodname>RarArchive::getEntries</methodname>.</para>
- <para>Note that a RAR archive can have multiple entries with the same name; this method
- will retrieve only the first.</para>
+ <simpara>You can also get entry objects using <methodname>RarArchive::getEntries</methodname>.</simpara>
+ <simpara>Note that a RAR archive can have multiple entries with the same name; this method
+ will retrieve only the first.</simpara>
</note>
</refsect1>
@@ -36,20 +36,20 @@
<varlistentry>
<term><parameter>rarfile</parameter></term>
<listitem>
- <para>
+ <simpara>
A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>entryname</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the entry within the RAR archive.
- </para>
+ </simpara>
<note>
- <para>The path must be the same returned by
- <methodname>RarEntry::getName</methodname>.</para>
+ <simpara>The path must be the same returned by
+ <methodname>RarEntry::getName</methodname>.</simpara>
</note>
</listitem>
</varlistentry>
@@ -58,9 +58,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the matching <type>RarEntry</type> object &return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rararchive/isbroken.xml b/reference/rar/rararchive/isbroken.xml
index db2aa988767c..1b1a5046f471 100644
--- a/reference/rar/rararchive/isbroken.xml
+++ b/reference/rar/rararchive/isbroken.xml
@@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
- <para>&style.oop; (method):</para>
+ <simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarArchive::isBroken</methodname>
<void/>
</methodsynopsis>
- <para>&style.procedural;:</para>
+ <simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>rar_broken_is</methodname>
<methodparam><type>RarArchive</type><parameter>rarfile</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This function determines whether an archive is incomplete, i.e., if a volume is missing or a volume is truncated.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,9 +30,9 @@
<varlistentry>
<term><parameter>rarfile</parameter></term>
<listitem>
- <para>
+ <simpara>
A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,13 +40,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if the archive is broken, &false; otherwise. This function may also
return &false; if the passed file has already been closed. The only way
to tell the two cases apart is to enable
exceptions with <methodname>RarException::setUsingExceptions</methodname>; however,
this should be unnecessary as a program should not operate on closed files.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rararchive/issolid.xml b/reference/rar/rararchive/issolid.xml
index 5ad24fc7b76c..b111a94ed136 100644
--- a/reference/rar/rararchive/issolid.xml
+++ b/reference/rar/rararchive/issolid.xml
@@ -9,20 +9,20 @@
<refsect1 role="description">
&reftitle.description;
- <para>&style.oop; (method):</para>
+ <simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarArchive::isSolid</methodname>
<void/>
</methodsynopsis>
- <para>&style.procedural;:</para>
+ <simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>rar_solid_is</methodname>
<methodparam><type>RarArchive</type><parameter>rarfile</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Check whether the RAR archive is solid. Individual file extraction is slower on solid
archives.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -31,9 +31,9 @@
<varlistentry>
<term><parameter>rarfile</parameter></term>
<listitem>
- <para>
+ <simpara>
A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -41,9 +41,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if the archive is solid, &false; otherwise.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rararchive/open.xml b/reference/rar/rararchive/open.xml
index e5e005d10805..b7014b3216ab 100644
--- a/reference/rar/rararchive/open.xml
+++ b/reference/rar/rararchive/open.xml
@@ -9,28 +9,28 @@
<refsect1 role="description">
&reftitle.description;
- <para>&style.oop; (method):</para>
+ <simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>RarArchive</type><type>false</type></type><methodname>RarArchive::open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>volume_callback</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
- <para>&style.procedural;:</para>
+ <simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type class="union"><type>RarArchive</type><type>false</type></type><methodname>rar_open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>volume_callback</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Open specified RAR archive and return <type>RarArchive</type> instance representing it.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
If opening a multi-volume archive, the path of the first volume should be passed as the first parameter.
Otherwise, not all files will be shown. This is by design.
- </para>
+ </simpara>
</note>
</refsect1>
@@ -40,25 +40,25 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the Rar archive.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
- <para>
+ <simpara>
A plain password, if needed to decrypt the headers. It will also be used by default
if encrypted files are found. Note that the files may have
different passwords in respect to the headers and among them.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>volume_callback</parameter></term>
<listitem>
- <para>
+ <simpara>
A function that receives one parameter – the path of the volume
that was not found – and returns a string with the correct path
for such volume or &null; if such volume does
@@ -69,23 +69,23 @@
the notice that would otherwise be emitted whenever a volume is
not found; an implementation that only returns &null;
can therefore be used to merely omit such notices.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
<warning>
- <para>
+ <simpara>
Prior to version 2.0.0, this function would not handle relative
paths correctly. Use <function>realpath</function> as a workaround.
- </para>
+ </simpara>
</warning>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the requested <type>RarArchive</type> instance &return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rararchive/setallowbroken.xml b/reference/rar/rararchive/setallowbroken.xml
index 5bef5278e4c3..9526c0ac41d8 100644
--- a/reference/rar/rararchive/setallowbroken.xml
+++ b/reference/rar/rararchive/setallowbroken.xml
@@ -8,23 +8,23 @@
<refsect1 role="description">
&reftitle.description;
- <para>&style.oop; (method):</para>
+ <simpara>&style.oop; (method):</simpara>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarArchive::setAllowBroken</methodname>
<methodparam><type>bool</type><parameter>allow_broken</parameter></methodparam>
</methodsynopsis>
- <para>&style.procedural;:</para>
+ <simpara>&style.procedural;:</simpara>
<methodsynopsis>
<type>bool</type><methodname>rar_allow_broken_set</methodname>
<methodparam><type>RarArchive</type><parameter>rarfile</parameter></methodparam>
<methodparam><type>bool</type><parameter>allow_broken</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
This method defines whether broken archives can be read or all the operations that
attempt to extract the archive entries will fail. Broken archives are archives for
which no error is detected when the file is opened but an error occurs when reading
the entries.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,17 +33,17 @@
<varlistentry>
<term><parameter>rarfile</parameter></term>
<listitem>
- <para>
+ <simpara>
A <type>RarArchive</type> object, opened with <function>rar_open</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>allow_broken</parameter></term>
<listitem>
- <para>
+ <simpara>
Whether to allow reading broken files (&true;) or not (&false;).
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,10 +51,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; &return.falseforfailure;. It will only fail if the file has
already been closed.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rararchive/tostring.xml b/reference/rar/rararchive/tostring.xml
index a91eabf554a3..1126fb56210b 100644
--- a/reference/rar/rararchive/tostring.xml
+++ b/reference/rar/rararchive/tostring.xml
@@ -12,15 +12,15 @@
<modifier>public</modifier> <type>string</type><methodname>RarArchive::__toString</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Provides a string representation for this <type>RarArchive</type> object. It currently shows
the full path name of the archive volume that was opened and whether the resource is valid
or was already closed through a call to <methodname>RarArchive::close</methodname>.
- </para>
- <para>
+ </simpara>
+ <simpara>
This method may be used only for debugging purposes, as there are no guarantees as to which
information the result contains or how it is formatted.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,10 +30,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
A textual representation of this <type>RarArchive</type> object.
The content of this representation is unspecified.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rarentry.xml b/reference/rar/rarentry.xml
index b22417f12f89..839b07553cfe 100644
--- a/reference/rar/rarentry.xml
+++ b/reference/rar/rarentry.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.rarentry" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.rarentry" role="class">
<title>The <classname>RarEntry</classname> class</title>
<titleabbrev>RarEntry</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ RarEntry intro -->
<section xml:id="rarentry.intro">
&reftitle.intro;
- <para>
+ <simpara>
A RAR entry, representing a directory or a compressed file inside a RAR archive.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -279,9 +278,9 @@
<varname linkend="rarentry.constants.attribute-unix-socket">RarEntry::ATTRIBUTE_UNIX_SOCKET</varname>
<initializer>49152</initializer>
</fieldsynopsis>
-
+
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarentry')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarentry')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -295,274 +294,274 @@
<varlistentry xml:id="rarentry.constants.host-msdos">
<term><constant>RarEntry::HOST_MSDOS</constant></term>
<listitem>
- <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, MS-DOS was used to
- add this entry. Use instead of <constant>RAR_HOST_MSDOS</constant>.</para>
+ <simpara>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, MS-DOS was used to
+ add this entry. Use instead of <constant>RAR_HOST_MSDOS</constant>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-os2">
<term><constant>RarEntry::HOST_OS2</constant></term>
<listitem>
- <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, OS/2 was used to
- add this entry. Intended to replace <constant>RAR_HOST_OS2</constant>.</para>
+ <simpara>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, OS/2 was used to
+ add this entry. Intended to replace <constant>RAR_HOST_OS2</constant>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-win32">
<term><constant>RarEntry::HOST_WIN32</constant></term>
<listitem>
- <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, Microsoft Windows was used to
- add this entry. Intended to replace <constant>RAR_HOST_WIN32</constant>.</para>
+ <simpara>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, Microsoft Windows was used to
+ add this entry. Intended to replace <constant>RAR_HOST_WIN32</constant>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-unix">
<term><constant>RarEntry::HOST_UNIX</constant></term>
<listitem>
- <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, an unspecified UNIX OS was used to
- add this entry. Intended to replace <constant>RAR_HOST_UNIX</constant>.</para>
+ <simpara>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, an unspecified UNIX OS was used to
+ add this entry. Intended to replace <constant>RAR_HOST_UNIX</constant>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-macos">
<term><constant>RarEntry::HOST_MACOS</constant></term>
<listitem>
- <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, Mac OS was used to
- add this entry.</para>
+ <simpara>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, Mac OS was used to
+ add this entry.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.host-beos">
<term><constant>RarEntry::HOST_BEOS</constant></term>
<listitem>
- <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, BeOS was used to
- add this entry. Intended to replace <constant>RAR_HOST_BEOS</constant>.</para>
+ <simpara>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, BeOS was used to
+ add this entry. Intended to replace <constant>RAR_HOST_BEOS</constant>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-readonly">
<term><constant>RarEntry::ATTRIBUTE_WIN_READONLY</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a read-only attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a read-only attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-hidden">
<term><constant>RarEntry::ATTRIBUTE_WIN_HIDDEN</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a hidden attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a hidden attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-system">
<term><constant>RarEntry::ATTRIBUTE_WIN_SYSTEM</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a system attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a system attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-directory">
<term><constant>RarEntry::ATTRIBUTE_WIN_DIRECTORY</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a directory attribute (entry is a directory). To be used with
+ <simpara>Bit that represents a Windows entry with a directory attribute (entry is a directory). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows. See also
- <methodname>RarEntry::isDirectory</methodname>, which also works with entries that were not added in WinRAR.</para>
+ <methodname>RarEntry::isDirectory</methodname>, which also works with entries that were not added in WinRAR.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-archive">
<term><constant>RarEntry::ATTRIBUTE_WIN_ARCHIVE</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with an archive attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with an archive attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-device">
<term><constant>RarEntry::ATTRIBUTE_WIN_DEVICE</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a device attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a device attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-normal">
<term><constant>RarEntry::ATTRIBUTE_WIN_NORMAL</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a normal file attribute (entry is NOT a directory). To be used with
+ <simpara>Bit that represents a Windows entry with a normal file attribute (entry is NOT a directory). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows. See also
- <methodname>RarEntry::isDirectory</methodname>, which also works with entries that were not added in WinRAR.</para>
+ <methodname>RarEntry::isDirectory</methodname>, which also works with entries that were not added in WinRAR.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-temporary">
<term><constant>RarEntry::ATTRIBUTE_WIN_TEMPORARY</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a temporary attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a temporary attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-sparse-file">
<term><constant>RarEntry::ATTRIBUTE_WIN_SPARSE_FILE</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a sparse file attribute (file is an NTFS sparse file). To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a sparse file attribute (file is an NTFS sparse file). To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-reparse-point">
<term><constant>RarEntry::ATTRIBUTE_WIN_REPARSE_POINT</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a reparse point attribute (entry is an NTFS reparse point, e.g. a
+ <simpara>Bit that represents a Windows entry with a reparse point attribute (entry is an NTFS reparse point, e.g. a
directory junction or a mount file system). To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-compressed">
<term><constant>RarEntry::ATTRIBUTE_WIN_COMPRESSED</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a compressed attribute (NTFS only). To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a compressed attribute (NTFS only). To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-offline">
<term><constant>RarEntry::ATTRIBUTE_WIN_OFFLINE</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with an offline attribute (entry is offline and not accessible). To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with an offline attribute (entry is offline and not accessible). To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-not-content-indexed">
<term><constant>RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a not content indexed attribute (entry is to be indexed). To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a not content indexed attribute (entry is to be indexed). To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-encrypted">
<term><constant>RarEntry::ATTRIBUTE_WIN_ENCRYPTED</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with an encrypted attribute (NTFS only). To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with an encrypted attribute (NTFS only). To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-win-virtual">
<term><constant>RarEntry::ATTRIBUTE_WIN_VIRTUAL</constant></term>
<listitem>
- <para>Bit that represents a Windows entry with a virtual attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
+ <simpara>Bit that represents a Windows entry with a virtual attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-world-execute">
<term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is world executable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is world executable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-world-write">
<term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is world writable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is world writable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-world-read">
<term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_READ</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is world readable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is world readable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-group-execute">
<term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is group executable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is group executable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-group-write">
<term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is group writable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is group writable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-group-read">
<term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_READ</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is group readable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is group readable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-owner-execute">
<term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is owner executable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is owner executable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-owner-write">
<term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is owner writable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is owner writable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-owner-read">
<term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_READ</constant></term>
<listitem>
- <para>Bit that represents a UNIX entry that is owner readable. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents a UNIX entry that is owner readable. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-sticky">
<term><constant>RarEntry::ATTRIBUTE_UNIX_STICKY</constant></term>
<listitem>
- <para>Bit that represents the UNIX sticky bit. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents the UNIX sticky bit. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-setgid">
<term><constant>RarEntry::ATTRIBUTE_UNIX_SETGID</constant></term>
<listitem>
- <para>Bit that represents the UNIX setgid attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents the UNIX setgid attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-setuid">
<term><constant>RarEntry::ATTRIBUTE_UNIX_SETUID</constant></term>
<listitem>
- <para>Bit that represents the UNIX setuid attribute. To be used with
- <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
+ <simpara>Bit that represents the UNIX setuid attribute. To be used with
+ <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-final-quartet">
<term><constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></term>
<listitem>
- <para>Mask to isolate the last four bits (nibble) of UNIX attributes
+ <simpara>Mask to isolate the last four bits (nibble) of UNIX attributes
(_S_IFMT, the type of file mask). To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constants <link linkend="rarentry.constants.attribute-unix-fifo"><constant>RarEntry::ATTRIBUTE_UNIX_FIFO</constant></link>,
@@ -571,81 +570,81 @@
<link linkend="rarentry.constants.attribute-unix-block-dev"><constant>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</constant></link>,
<link linkend="rarentry.constants.attribute-unix-regular-file"><constant>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</constant></link>,
<link linkend="rarentry.constants.attribute-unix-sym-link"><constant>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</constant></link> and
- <link linkend="rarentry.constants.attribute-unix-socket"><constant>RarEntry::ATTRIBUTE_UNIX_SOCKET</constant></link>.</para>
+ <link linkend="rarentry.constants.attribute-unix-socket"><constant>RarEntry::ATTRIBUTE_UNIX_SOCKET</constant></link>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-fifo">
<term><constant>RarEntry::ATTRIBUTE_UNIX_FIFO</constant></term>
<listitem>
- <para>Unix FIFOs will have attributes whose last four bits have this value. To be used with
+ <simpara>Unix FIFOs will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
- <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
+ <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-char-dev">
<term><constant>RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</constant></term>
<listitem>
- <para>Unix character devices will have attributes whose last four bits have this value. To be used with
+ <simpara>Unix character devices will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
- <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
+ <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-directory">
<term><constant>RarEntry::ATTRIBUTE_UNIX_DIRECTORY</constant></term>
<listitem>
- <para>Unix directories will have attributes whose last four bits have this value. To be used with
+ <simpara>Unix directories will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>. See also
<methodname>RarEntry::isDirectory</methodname>, which also works with entries that
- were added in other operating systems.</para>
+ were added in other operating systems.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-block-dev">
<term><constant>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</constant></term>
<listitem>
- <para>Unix block devices will have attributes whose last four bits have this value. To be used with
+ <simpara>Unix block devices will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
- <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
+ <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-regular-file">
<term><constant>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</constant></term>
<listitem>
- <para>Unix regular files (not directories) will have attributes whose last four bits have this value. To be used with
+ <simpara>Unix regular files (not directories) will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
<constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>. See also
<methodname>RarEntry::isDirectory</methodname>, which also works with entries that
- were added in other operating systems.</para>
+ were added in other operating systems.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-sym-link">
<term><constant>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</constant></term>
<listitem>
- <para>Unix symbolic links will have attributes whose last four bits have this value. To be used with
+ <simpara>Unix symbolic links will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
- <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
+ <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.constants.attribute-unix-socket">
<term><constant>RarEntry::ATTRIBUTE_UNIX_SOCKET</constant></term>
<listitem>
- <para>Unix sockets will have attributes whose last four bits have this value. To be used with
+ <simpara>Unix sockets will have attributes whose last four bits have this value. To be used with
<methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
- <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
+ <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</simpara>
</listitem>
</varlistentry>
@@ -659,7 +658,6 @@
&reference.rar.entities.rarentry;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/extract.xml b/reference/rar/rarentry/extract.xml
index 5f34ecd2218c..8fe1cd89a129 100644
--- a/reference/rar/rarentry/extract.xml
+++ b/reference/rar/rarentry/extract.xml
@@ -15,12 +15,12 @@
<methodparam choice="opt"><type>string</type><parameter>password</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>extended_data</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
<methodname>RarEntry::extract</methodname> extracts the entry's data.
It will create new file in the specified
<parameter>dir</parameter> with the name identical to the entry's name,
unless the second argument is specified. See below for more information.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,61 +29,61 @@
<varlistentry>
<term><parameter>dir</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the directory where files should be extracted. This parameter is
considered if and only if <parameter>filepath</parameter> is not. If both
parameters are empty an extraction to the current directory will be
attempted.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filepath</parameter></term>
<listitem>
- <para>
+ <simpara>
Path (relative or absolute) containing the directory and filename of the
extracted file. This parameter overrides both the parameter
<parameter>dir</parameter> and the original file name.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
- <para>
+ <simpara>
The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
be omitted. If this parameter is omitted and the entry is encrypted, the password given to
<function>rar_open</function>, if any, will be used. If a wrong password is given, either explicitly
or implicitly via <function>rar_open</function>, CRC checking will fail and this method will fail and return &false;.
If no password is given and one is required, this method will fail and return &false;.
You can check whether an entry is encrypted with <methodname>RarEntry::isEncrypted</methodname>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extended_data</parameter></term>
<listitem>
- <para>
+ <simpara>
If &true;, extended information such as NTFS ACLs and Unix owner information will be set in the extract
files, as long as it's present in the archive.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
<warning>
- <para>Prior to version 2.0.0, this function would not handle relative
- paths correctly. Use <function>realpath</function> as a workaround.</para>
+ <simpara>Prior to version 2.0.0, this function would not handle relative
+ paths correctly. Use <function>realpath</function> as a workaround.</simpara>
</warning>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rarentry/getattr.xml b/reference/rar/rarentry/getattr.xml
index 1d7b0c906008..0df6a2a67471 100644
--- a/reference/rar/rarentry/getattr.xml
+++ b/reference/rar/rarentry/getattr.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>int</type><methodname>RarEntry::getAttr</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns the OS-dependent attributes of the archive entry.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the attributes or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rarentry/getcrc.xml b/reference/rar/rarentry/getcrc.xml
index abd0b2abf478..93c7eb5000c2 100644
--- a/reference/rar/rarentry/getcrc.xml
+++ b/reference/rar/rarentry/getcrc.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>string</type><methodname>RarEntry::getCrc</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns an hexadecimal string representation of the CRC of the archive entry.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the CRC of the archive entry or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rarentry/getfiletime.xml b/reference/rar/rarentry/getfiletime.xml
index ceb0977c88ef..fd39b3c4ded6 100644
--- a/reference/rar/rarentry/getfiletime.xml
+++ b/reference/rar/rarentry/getfiletime.xml
@@ -1,23 +1,22 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.getfiletime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.getfiletime">
<refnamediv>
<refname>RarEntry::getFileTime</refname>
<refpurpose>Get entry last modification time</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>RarEntry::getFileTime</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Gets entry last modification time.
- </para>
+ </simpara>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
@@ -25,14 +24,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
- Returns entry last modification time as string in format
+ <simpara>
+ Returns entry last modification time as string in format
<literal>YYYY-MM-DD HH:II:SS</literal>, or &false; on error.
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/gethostos.xml b/reference/rar/rarentry/gethostos.xml
index a4cc08796c25..cb41184daae3 100644
--- a/reference/rar/rarentry/gethostos.xml
+++ b/reference/rar/rarentry/gethostos.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>int</type><methodname>RarEntry::getHostOs</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns the code of the host OS of the archive entry.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the code of the host OS, or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rarentry/getmethod.xml b/reference/rar/rarentry/getmethod.xml
index 137a958f3cf7..0a5fe81cf39f 100644
--- a/reference/rar/rarentry/getmethod.xml
+++ b/reference/rar/rarentry/getmethod.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>int</type><methodname>RarEntry::getMethod</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
<methodname>RarEntry::getMethod</methodname> returns number of the method used when adding
current archive entry.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the method number or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rarentry/getname.xml b/reference/rar/rarentry/getname.xml
index d2d1e56f7fad..14ccde1b657d 100644
--- a/reference/rar/rarentry/getname.xml
+++ b/reference/rar/rarentry/getname.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>string</type><methodname>RarEntry::getName</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns the name (with path) of the archive entry.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the entry name as a string, or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rarentry/getpackedsize.xml b/reference/rar/rarentry/getpackedsize.xml
index 7ef77fdcf93c..487a66f036b1 100644
--- a/reference/rar/rarentry/getpackedsize.xml
+++ b/reference/rar/rarentry/getpackedsize.xml
@@ -12,13 +12,13 @@
<modifier>public</modifier> <type>int</type><methodname>RarEntry::getPackedSize</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Get packed size of the archive entry.
- </para>
+ </simpara>
<note>
- <para>Note that on platforms with 32-bit longs (that includes Windows
+ <simpara>Note that on platforms with 32-bit longs (that includes Windows
x64), the maximum size returned is capped at 2 GiB. Check the constant
- <constant>PHP_INT_MAX</constant>.</para>
+ <constant>PHP_INT_MAX</constant>.</simpara>
</note>
</refsect1>
@@ -29,9 +29,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the packed size, or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rarentry/getstream.xml b/reference/rar/rarentry/getstream.xml
index 388f075f2b96..b22facb229bf 100644
--- a/reference/rar/rarentry/getstream.xml
+++ b/reference/rar/rarentry/getstream.xml
@@ -12,19 +12,19 @@
<modifier>public</modifier> <type class="union"><type>resource</type><type>false</type></type><methodname>RarEntry::getStream</methodname>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Returns a file handler that
supports read operations. This handler provides on-the-fly decompression
for this entry.
- </para>
- <para>
+ </simpara>
+ <simpara>
The handler is not invalidated by calling
<function>rar_close</function>.
- </para>
+ </simpara>
<warning>
- <para>The resulting stream has no integrity verification. In particular, file corruption and
+ <simpara>The resulting stream has no integrity verification. In particular, file corruption and
decryption with a wrong a key will not be detected. It is the programmer's responsability to use the entry's CRC
- to check for integrity, if he so wishes.</para>
+ to check for integrity, if he so wishes.</simpara>
</warning>
</refsect1>
@@ -34,14 +34,14 @@
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
- <para>
+ <simpara>
The password used to encrypt this entry. If the entry is not encrypted, this value will not be used and can
be omitted. If this parameter is omitted and the entry is encrypted, the password given to
<function>rar_open</function>, if any, will be used. If a wrong password is given, either explicitly
or implicitly via <function>rar_open</function>, this method's resulting stream will produce wrong
output. If no password is given and one is required, this method will fail and return &false;.
You can check whether an entry is encrypted with <methodname>RarEntry::isEncrypted</methodname>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
The file handler &return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rarentry/getunpackedsize.xml b/reference/rar/rarentry/getunpackedsize.xml
index 70e88eeedb0f..59442bf3e5fc 100644
--- a/reference/rar/rarentry/getunpackedsize.xml
+++ b/reference/rar/rarentry/getunpackedsize.xml
@@ -12,13 +12,13 @@
<modifier>public</modifier> <type>int</type><methodname>RarEntry::getUnpackedSize</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Get unpacked size of the archive entry.
- </para>
+ </simpara>
<note>
- <para>Note that on platforms with 32-bit longs (that includes Windows
+ <simpara>Note that on platforms with 32-bit longs (that includes Windows
x64), the maximum size returned is capped at 2 GiB. Check the constant
- <constant>PHP_INT_MAX</constant>.</para>
+ <constant>PHP_INT_MAX</constant>.</simpara>
</note>
</refsect1>
@@ -29,9 +29,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the unpacked size, or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
diff --git a/reference/rar/rarentry/getversion.xml b/reference/rar/rarentry/getversion.xml
index 2d7e5099030f..2984d76ba2ae 100644
--- a/reference/rar/rarentry/getversion.xml
+++ b/reference/rar/rarentry/getversion.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>int</type><methodname>RarEntry::getVersion</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns minimum version of RAR program (e.g. WinRAR) required to unpack the entry.
It is encoded as 10 * major version + minor version.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the version or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rarentry/isdirectory.xml b/reference/rar/rarentry/isdirectory.xml
index 53819b2f395f..d591f319d669 100644
--- a/reference/rar/rarentry/isdirectory.xml
+++ b/reference/rar/rarentry/isdirectory.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.isdirectory" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.isdirectory">
<refnamediv>
<refname>RarEntry::isDirectory</refname>
<refpurpose>Test whether an entry represents a directory</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>bool</type><methodname>RarEntry::isDirectory</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Tests whether the current entry is a directory.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +24,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if this entry is a directory and &false; otherwise.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="notes">
@@ -52,7 +51,6 @@ $isDirectory = (bool) ((($e->getHostOs() == RAR_HOST_WIN32) && ($e->getAttr() &
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/isencrypted.xml b/reference/rar/rarentry/isencrypted.xml
index 4f7172a915df..1e2de6487eb1 100644
--- a/reference/rar/rarentry/isencrypted.xml
+++ b/reference/rar/rarentry/isencrypted.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.isencrypted" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.isencrypted">
<refnamediv>
<refname>RarEntry::isEncrypted</refname>
<refpurpose>Test whether an entry is encrypted</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarEntry::isEncrypted</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Tests whether the current entry contents are encrypted.
- </para>
+ </simpara>
<note>
- <para>The password used may differ between files inside the same RAR archive.</para>
+ <simpara>The password used may differ between files inside the same RAR archive.</simpara>
</note>
</refsect1>
@@ -28,14 +27,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if the current entry is encrypted and &false; otherwise.
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarentry/tostring.xml b/reference/rar/rarentry/tostring.xml
index e25f18c8ce96..2a0d80cba4e1 100644
--- a/reference/rar/rarentry/tostring.xml
+++ b/reference/rar/rarentry/tostring.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="rarentry.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarentry.tostring">
<refnamediv>
<refname>RarEntry::__toString</refname>
<refpurpose>Get text representation of entry</refpurpose>
@@ -11,14 +10,14 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>RarEntry::__toString</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
<methodname>RarEntry::__toString</methodname> returns a textual representation for this entry. It includes whether
the entry is a file or a directory (symbolic links and other special objects will be treated as files),
the UTF-8 name of the entry and its CRC. The form and content of this representation may be changed in the future,
so they cannot be relied upon.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,14 +27,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
A textual representation for the entry.
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarexception.xml b/reference/rar/rarexception.xml
index 384ec76b59a1..cb5283dc2be6 100644
--- a/reference/rar/rarexception.xml
+++ b/reference/rar/rarexception.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.rarexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.rarexception" role="class">
<title>The RarException class</title>
<titleabbrev>RarException</titleabbrev>
@@ -11,14 +10,14 @@
<!-- {{{ RarException intro -->
<section xml:id="rarexception.intro">
&reftitle.intro;
- <para>
+ <simpara>
This class serves two purposes: it is the type of the exceptions thrown by the RAR extension
functions and methods and it allows, through static methods to query and define the error
behaviour of the extension, i.e., whether exceptions are thrown or only warnings are emitted.
- </para>
- <para>
+ </simpara>
+ <simpara>
The following error codes are used:
- </para>
+ </simpara>
<itemizedlist>
<listitem>
<simpara>
@@ -30,43 +29,43 @@
11 - insufficient memory
</simpara>
</listitem>
-
+
<listitem>
<simpara>
12 - bad data
</simpara>
</listitem>
-
+
<listitem>
<simpara>
13 - bad archive
</simpara>
</listitem>
-
+
<listitem>
<simpara>
14 - unknown format
</simpara>
</listitem>
-
+
<listitem>
<simpara>
15 - file open error
</simpara>
</listitem>
-
+
<listitem>
<simpara>
16 - file create error
</simpara>
</listitem>
-
+
<listitem>
<simpara>
17 - file close error
</simpara>
</listitem>
-
+
<listitem>
<simpara>
18 - read error
@@ -77,19 +76,19 @@
19 - write error
</simpara>
</listitem>
-
+
<listitem>
<simpara>
20 - buffer too small
</simpara>
</listitem>
-
+
<listitem>
<simpara>
21 - unknown RAR error
</simpara>
</listitem>
-
+
<listitem>
<simpara>
22 - password required but not given
@@ -112,7 +111,7 @@
<modifier>final</modifier>
<classname>RarException</classname>
</ooclass>
-
+
<ooclass>
<modifier>extends</modifier>
<classname>Exception</classname>
@@ -121,10 +120,10 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
+
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
</classsynopsis>
<!-- }}} -->
@@ -136,7 +135,6 @@
&reference.rar.entities.rarexception;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/rar/rarexception/isusingexceptions.xml b/reference/rar/rarexception/isusingexceptions.xml
index af5fe7fd317f..390f100376d3 100644
--- a/reference/rar/rarexception/isusingexceptions.xml
+++ b/reference/rar/rarexception/isusingexceptions.xml
@@ -12,11 +12,11 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>RarException::isUsingExceptions</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Checks whether the RAR functions will emit warnings and return error values or whether they
will throw exceptions in most of the circumstances (does not include some programmatic
errors such as passing the wrong type of arguments).
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if exceptions are being used, &false; otherwise.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/rarexception/setusingexceptions.xml b/reference/rar/rarexception/setusingexceptions.xml
index d1dcac32d3c3..89bd365e508f 100644
--- a/reference/rar/rarexception/setusingexceptions.xml
+++ b/reference/rar/rarexception/setusingexceptions.xml
@@ -12,12 +12,12 @@
<modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>RarException::setUsingExceptions</methodname>
<methodparam><type>bool</type><parameter>using_exceptions</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
If and only if the argument is &true;, then, instead of emitting warnings and returning a special value indicating error when the UnRAR library encounters an error, an exception of type <type>RarException</type> will be thrown.
- </para>
- <para>
+ </simpara>
+ <simpara>
Exceptions will also be thrown for the following errors, which occur outside the library (their error code will be -1):
- </para>
+ </simpara>
<itemizedlist>
<listitem>
<simpara>
@@ -40,9 +40,9 @@
<varlistentry>
<term><parameter>using_exceptions</parameter></term>
<listitem>
- <para>
+ <simpara>
Should be &true; to activate exception throwing, &false; to deactivate (the default).
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,9 +50,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/rar/setup.xml b/reference/rar/setup.xml
index d1115a8742ad..8f591d1221d0 100644
--- a/reference/rar/setup.xml
+++ b/reference/rar/setup.xml
@@ -1,20 +1,19 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="rar.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rar.setup">
&reftitle.setup;
<!-- {{{ Installation -->
<section xml:id="rar.installation">
&reftitle.install;
- <para>
+ <simpara>
Rar is currently available through PECL
<link xlink:href="&url.pecl.package;rar">&url.pecl.package;rar</link>.
- </para>
- <para>
+ </simpara>
+ <simpara>
Also you can use the PECL installer to install the Rar extension,
using the following command: <command>pecl -v install rar</command>.
- </para>
+ </simpara>
<para>
You can always download the <filename>tar.gz</filename> package and install Rar by hand:
<example>
@@ -30,32 +29,31 @@ phpize
</programlisting>
</example>
</para>
- <para>
+ <simpara>
Windows users will enable <filename>php_rar.dll</filename> inside
of &php.ini; in order to use these functions.
- </para>
+ </simpara>
</section>
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="rar.resources">
&reftitle.resources;
- <para>
+ <simpara>
This extension registers three internal classes:
the archive representations returned by <function>rar_open</function> –
<type>RarArchive</type>, the entry representations returned by
<function>rar_list</function> and <function>rar_entry_get</function> –
<type>RarEntry</type> and the exception type <type>RarException</type>.
- </para>
- <para>
+ </simpara>
+ <simpara>
This extension also register a stream resource, called "rar" and a URL
wrapper called "rar wrapper" and registered under the prefix "rar".
- </para>
+ </simpara>
</section>
<!-- }}} -->
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -76,4 +74,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-