ezcLister
~~~~~~~~~

Purpose
=======

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

- ConsoleTools::ezcConsoleParameter
- ConsoleTools::ezcConsoleTable

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

ezcLister is an application with functionality similar to the Unix console
command ls. Not every option of ls is implemented.

Usage
=====

To run this sample application you have to adjust the path in line 397 of
application 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 ezcLister from the command line, when your current working
directory is the eZ components SVN base trunk/ directory.

SYNOPSIS
--------

    ::

     list.php [-h] [-a] [-c <string>] [-d] [-o] [-l]  [[--] <args>]

Options
-------

-h/--help                Get help information.
-a/--all                 Do not hide entries starting with . (dot).
-c/--color WHEN          Control whether color is used to distinguish file
                         types.  WHEN may be never, always, or auto.
                         Default is auto.
-d/--directory           List directory entries instead of contents, and do
                         not dereference symbolic links.
-l/--list                Use a long listing format.
-o/--order               Put files last.

<args>                   Specify one directory to display it's contents, or
                         leave blank to display the contents of the current
                         directory. If the specified directory does not exist,
                         the application will generate an error and it will
                         quit. Be sure to separate the directory from the other
                         options by using -- (ie. eg. list.php -l -- Base).

Examples
--------

    ::

     list.php

This will list all the files and directories in the current directories, into
as many columns as it fits, using colors, and it will not show the hidden
files.

    ::

     list.php -d

Same as the previous command, but it will only show the directories in the
current directory.

    ::

     list.php -l -a -o -- Base

This will show all the files (including hidden ones) in the Base sub-directory,
in a list format, putting files last.