Add: return codes for each error case.
[clive.git] / README
blob5fab5e572256668bdb633f376371bde2d7c17e45
1 README for clive
2 ----------------
4 clive is a command line utility for extracting videos from Youtube and other
5 video-sharing websites. It was written to bypass the Adobe Flash requirement
6 to view the hosted videos. See http://clive.sf.net for more information
7 on clive.
10 Prerequisites
11 -------------
13 See Makefile.PL file.
16 Optional modules
17 ----------------
19 * BerkeleyDB
20   - If not installed, clive cache features will be disabled
22 * Term::ReadKey
23   - If not installed, clive will not resize progressbar to
24   match terminal width
27 Installation
28 ------------
30 INSTALL_BASE can be passed into Makefile.PL to change where clive will
31 be installed. For example:
33   perl Makefile.PL INSTALL_BASE=/usr/local
35   perl Makefile.PL
36   make
37   make test
38   make install
40 NOTE: "make test" will use ~/.cliverc settings.
43 Bugs
44 ----
46   http://code.google.com/p/clive/issues/
49 FAQ
50 ---
52   http://code.google.com/p/clive/wiki/FAQ