diff --git a/reference/rar/book.xml b/reference/rar/book.xml new file mode 100644 index 0000000000..33f3c77360 --- /dev/null +++ b/reference/rar/book.xml @@ -0,0 +1,53 @@ + + + + + + + RAR + + + + &reftitle.intro; + + 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 + by UnRar library and is directly prohibited by it's license. + + + More information about Rar and UnRar can be found at &url.rar;. + + + + + &reference.rar.setup; + &reference.rar.constants; + &reference.rar.examples; + + &reference.rar.reference; + + + + + diff --git a/reference/rar/constants.xml b/reference/rar/constants.xml new file mode 100644 index 0000000000..03d7169d8a --- /dev/null +++ b/reference/rar/constants.xml @@ -0,0 +1,86 @@ + + + + + &reftitle.constants; + &extension.constants; + + + + RAR_HOST_MSDOS + (integer) + + + + + + + + + + RAR_HOST_OS2 + (integer) + + + + + + + + + + RAR_HOST_WIN32 + (integer) + + + + + + + + + + RAR_HOST_UNIX + (integer) + + + + + + + + + + RAR_HOST_BEOS + (integer) + + + + + + + + + + + + diff --git a/reference/rar/examples.xml b/reference/rar/examples.xml new file mode 100644 index 0000000000..dfeaa9f36e --- /dev/null +++ b/reference/rar/examples.xml @@ -0,0 +1,58 @@ + + + + + &reftitle.examples; + + + Rar extension overview example + +getName() . "\n"; + echo 'Packed size: ' . $entry->getPackedSize() . "\n"; + echo 'Unpacked size: ' . $entry->getUnpackedSize() . "\n"; + + $entry->extract('/dir/extract/to/'); +} + +rar_close($rar_file); + +?> +]]> + + + + + This example opens a Rar file archive and extracts each entry to the + specified directory. + + + + + diff --git a/reference/rar/reference.xml b/reference/rar/reference.xml index baf01de82a..10eb390b4b 100644 --- a/reference/rar/reference.xml +++ b/reference/rar/reference.xml @@ -1,175 +1,13 @@ - - - + - - Rar Functions - Rar + + Rar &Functions; + Rar - + &reference.rar.entities.functions; -
- &reftitle.intro; - - RAR is a powerful and effective archiver created by Eugene Roshal. - This extension uses unRAR library which implements read-only support - for Rar archives. - Re-creating a RAR/WinRAR archiver using unRAR sources is prohibited - by the unRAR license. - - - More information about RAR and unRAR can be found at &url.rar;. - -
- -
- &reftitle.required; - &no.requirement; -
- - &reference.rar.ini; - -
- &reftitle.install; - - Rar extension is currently available through PECL - &url.pecl.package;rar. - - - Also you can use the PECL installer to install the Rar extension, - using the following command: pecl -v install rar. - - - You can always download the tar.gz package and install Rar by hand: - - Rar installation - - - - - - - Windows users can download the extension dll php_rar.dll - here: &url.pecl.get.win;. - -
- -
- &reftitle.resources; - - There is one resource used in Rar extension: a file descriptor returned - by rar_open. - -
- -
- &reftitle.constants; - - - - RAR_HOST_MSDOS - (integer) - - - - - - - - - - RAR_HOST_OS2 - (integer) - - - - - - - - - - RAR_HOST_WIN32 - (integer) - - - - - - - - - - RAR_HOST_UNIX - (integer) - - - - - - - - - - RAR_HOST_BEOS - (integer) - - - - - - - - -
- -
- &reftitle.examples; - - - Rar extension overview example - -getName() . "\n"; - echo 'Packed size: ' . $entry->getPackedSize() . "\n"; - echo 'Unpacked size: ' . $entry->getUnpackedSize() . "\n"; - - $entry->extract('/dir/extract/to/'); -} - -rar_close($rar_file); - -?> -]]> - - - - - This example opens a Rar file archive and extracts each entry to the - specified directory. - -
- -
- - &reference.rar.entities.functions; - -
+
+ + + &reftitle.setup; + + +
+ &reftitle.required; + &no.requirement; +
+ + + +
+ &reftitle.install; + + Rar is currently available through PECL + &url.pecl.package;rar. + + + Also you can use the PECL installer to install the Rar extension, + using the following command: pecl -v install rar. + + + You can always download the tar.gz package and install Rar by hand: + + Rar installation + + + + + + + Windows users can download the extension dll php_rar.dll + here: &url.pecl.get.win;. + +
+ + + + &reference.rar.ini; + + + +
+ &reftitle.resources; + + There is one resource used in Rar extension: a file descriptor returned + by rar_open. + +
+ + +
+ + +