Manual: Update, cleanup, fix grammar
[clive.git] / README
blob48b5b37e5fde5301d49a947724c1b6cfb12053f3
1 clive
2 ============
4 clive is a command line video extraction tool for Youtube and other similar
5 video websites that require Adobe Flash for viewing the content.
7 WWW: <http://clive.sourceforge.net/>
8 GIT: <git://repo.or.cz/clive.git>
11 PREREQUISITES
13 See the Makefile.PL file for Perl module prerequisites, under "PREREQ_PM".
14 Additionally, you will need:
15   * quvi [1], 0.2.7+
16   * Download command, e.g. curl [2] or wget [2]
18 [1] <http://quvi.sourceforge.net/>
19 [2] <http://curl.haxx.se/>
20 [3] <http://www.gnu.org/software/wget/>
23 INSTALLATION
25 You could skip this step, if you like, and instead just run "bin/clive".
26 This should work as long as the prerequisites are found.
28 perl Makefile.PL
29 make
30 make install
32 You can specify the install prefix with INSTALL_BASE
33 e.g. "perl Makefile.PL INSTALL_BASE=/usr/local"
35 More: <http://search.cpan.org/perldoc?ExtUtils::MakeMaker>
36  FAQ: <http://perldoc.perl.org/ExtUtils/MakeMaker/FAQ.html>
39 GETTING STARTED
41 Read "man clive" (or "perldoc man1/clive.1.pod"). You should consider
42 setting --quvi and --get-with in your config file for seamless use.
43 For example:
45 % cat > ~/.cliverc
46 --quvi "/usr/bin/quvi %u"
47 --get-with "/usr/bin/curl -L -C - -o %f %u"
49 If you need to set HTTP proxy, etc., please refer to the documentation
50 of those commands.
53 NOTES FOR PACKAGERS
55 Consider packaging a system-wide default configuration file along with
56 your clive package. The config file should define at least --quvi and
57 --get-with (see "GETTING STARTED" above) so that clive will work
58 "out-of-the-box" when your package is installed.
60 You could use wget(1) instead of curl(1), although I am yet to find
61 the correct combo of options that allows resuming file transfers
62 without overwriting the existing file (e.g. "wget -c -O %f" does not
63 yield the hoped results).
65 Whatever values you choose to set in the default system-wide config
66 file, please be sure to make your clive package depend on those
67 commands/packages.
69 For additional notes about the configuration file (e.g. paths), please
70 read the "FILES" section in the manual page.
71     % perldoc man1/clive.1.pod
73 For an example config file, please see also examples/cliverc.