Manual: minor tweaks.
[clive.git] / README
blob764444510c52fa0afed78c45655396c9ffcbf484
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     perl Makefile.PL
32 INSTALL_BASE can be passed into Makefile.PL to change where your module
33 will be installed. INSTALL_BASE is more like what everyone else calls
34 "prefix" than PREFIX is. For example:
36     perl Makefile.PL INSTALL_BASE=~
38     make
39     make test
40     make install
42 NOTE: "make test" will not run the host specific test cases unless
43 you set CLIVE_TEST_HOSTS env. variable. Please note that these
44 tests run clive executable which will use ~/.cliverc settings
45 if they can be found.
48 Bugs
49 ----
51     http://code.google.com/p/clive/issues/