Fixed missing prerequisite (INSTALL, --version).
[clive.git] / INSTALL
blob4722a8ee2beaed02f7daf92644062c1fa8150daf
1 Prerequisites
2 ------------------------------------------------------------------------------
4 Perl >= 5.8 with the following (recommended) module versions:
6 * Config::Tiny/2.12           * BerkeleyDB/0.34
7 * WWW::Curl/4.05              * URI::Escape/3.29
8 * HTML::TokeParser/2.37       * Clipboard/0.09
9 * IO::Pager/0.05              * XML::Simple/2.18
11 * Getopt::Long/2.35           * Pod::Usage/1.33
12 * File::Path/1.08             * File::Spec/3.12
13 * Digest::SHA/5.47            * POSIX/1.09
14 * Cwd/3.12                    * Encode/2.12
16 Note that the Clipboard module is OPTIONAL.
19 Installation
20 ------------------------------------------------------------------------------
22 Extract:
23     % tar xvjf clive-$release.tar.bz2 && cd clive-$release
25 Run:
26     % ./clive [option]... [URL]...
28 Getting started:
29     % ./clive --manual # See the EXAMPLES
32 Installation: FreeBSD
33 ------------------------------------------------------------------------------
35 Tested on 7.0. Likely inaccurate.
37 From the ports:
38   * databases/p5-BerkeleyDB
39   * security/p5-Digest-SHA
40   * devel/p5-Config-Tiny
41   * devel/p5-IO-Pager
42   * net/p5-URI
43   * www/p5-HTML-Parser
44   * x11/p5-Clipboard (if needed)
46 CPAN: WWW::Curl (outdated in the ports at the time of writing this)
47   % sudo pkg_add -r curl (or: cd /usr/ports/www/curl; sudo make install)
48   % sudo cpan install WWW::Curl
51 Installation: Ubuntu
52 ------------------------------------------------------------------------------
54 Tested on Hardy. Likely inaccurate.
56 % sudo apt-get install:
57   * libconfig-tiny-perl
58   * libberkeleydb-perl
59   * libdigest-sha-perl
60   * libfile-spec-perl
61   * libxml-simple-perl
62   * liburi-perl 
63   * libhtml-parser-perl
65 CPAN:
66   * WWW::Curl (outdated in apt at the time of writing this)
67     % sudo apt-get install libcurl-dev
68     % sudo cpan install WWW::Curl
70   * IO::Pager (not packaged?)
71     % sudo cpan install IO::Pager
73   * Clipboard (not packaged?, only if needed)
74     % sudo cpan install Clipboard