ezcWebDownloader
~~~~~~~~~~~~~~~~

Purpose
=======

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

- ConsoleTools::ezcConsoleParameter
- ConsoleTools::ezcConsoleProgressBar

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

ezcWebDownloader is an application to handle file downloads via HTTP. By
now it is capable to download and save to the local disk files of any 
types adressed by any correct HTTP URL. Application provides 
possibility to limit bandwidth usage while downloading.
You can set user name and password to download sequrity protected files.
File retrieving progress and current download speed are shown during 
downloading.

Usage
=====


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

SYNOPSIS
--------

    ::

     webget.php [-h] [-b <int>] [-u <string>] [-p <string>] [[--] <args>]

Options
-------

-b/--bandwidth-limit     Bandwidth limit in Kb per second.
-h/--help                Get help information.
-p/--http-password       Connect to server with password PWD.
-u/--http-user           Connect to server with user name USER.

Examples
--------

    ::

          webget.php -b 10 http://ez.no/downloads/ezcomponents-1.0.tar.bz2

This will download ezcomponents-1.0.tar.bz2 to the current directory with download speed
not more than 10 Kbytes per second.

	::

	  webget.php -u myName -p myPass http://www.mysite.com/myDocument.zip

This will download myDocument.zip protected with basic HTTP authentification to 
the current directory. Download speed is not limited.

	::

	  webget.php http://www.ez.no

This will download main page of eZ Systems site to index.html the current directory.