ezcArchiver
~~~~~~~~~~~

Purpose
=======

The ezcArchiver is an example application to show the capabilities and usage
of the following eZ components:

- ConsoleTools
- Archive

Description
===========

ezcArchiver is an application to handle file archives of different types. By
now it is capable of creating / listing / extracting the following types of
archives:

- tar
- tar.gz
- tar.bz2
- zip

You can view the contents of these archives, extract them and create new
archives. The creation works recursively over a specific directory. For all of
these actions, the files taken into account can be reduced by supplying one
ore more PCRE to the program.

Usage
=====


To run this sample application you have to adjust the path in line 6 of this
file, to point to the eZ components base.php file, included in the eZ
components Base package. With the default setting included in the file, you
can run the ezcArchiver from the command line, when your current working
directory is the eZ components SVN base directory.

SYNOPSIS
--------

    ::

     archiver.php [-h] [-l] [-e] [-c] [-d <string>] [-i <string>] [-a]  [[--] <args>]

Options
-------

-h/--help       Get help information.
-l/--list       List contents of an archive.
-e/--extract    Extract all files from an archive.
-c/--create     Create a new archive from a directory.
-d/--directory  Directory to perform option on (default is <./>).
-i/--ignore     Ignore paths matching a PCRE from any action (multiple
                possible).
-a/--all-info   No help available.

Examples
--------

    ::

       archiver.php -c -d UserInput/trunk/src -i "/\.svn/" UserInput.tar.bz2

This will create a tar.bz2 archive of the directory UserInput/trunk/src
recursively and will ignore all paths, that match the regular expression
/\.svn/, which means all SVN special directories.

	::

	  archiver.php -l -i "/exception/i" ConsoleTools.zip

This will make the ezcArchiver list the contents of a file called
ConsoleTools.zip and will not display any path that contains the word
"exception", without caring for the case of the letters.
	
	::

	  archiver.php -e -d /tmp -i "/exception/i" ConsoleTools.zip

This will extract all files shown in the previous command to the directory
/tmp.