Reverted the [$verb] status message changes.
[clive-utils.git] / INSTALL
blob751341cddfc650223641309940cfa4b2bbb94e0d
1 Prerequisites
2 ------------------------------------------------------------------------------
4 clive >= 2.0beta1 (http://clive.sf.net)
5 Perl >= 5.8 (http://perl.org)
7 The following 3rd party perl modules are required. The versions are
8 recommendations. The module lists below are more or less comprehensive.
9 The required Perl core modules have not been listed below.
11 Note that some Unix/Linux distributions may pack some of the Perl core modules
12 separately and require them to be installed separately. This means also that
13 the actual installation procedure may vary greatly for each distro.
15 The FreeBSD and Ubuntu details further below are likely to be inaccurate and
16 missing some steps. The information was mainly gathered to aid the current
17 and future clive package maintainers to get started. Note that the CPAN
18 installation steps exist only if the distro does not have the equivalent
19 package or a version available. For example, the 3.x of WWW::Curl kept
20 refusing to work with the current version of clive.
22 Note that the Clipboard module is OPTIONAL.
24 clivefeed
25 ---------
27 * Config::Tiny/2.12           * WWW::Curl/4.05
28 * XML::RSS::LibXML/0.3002     * Clipboard/0.09
29 * Tk/804.027                  * URI::Escape/3.29
30 * Tk::DialogBox/4.013         * HTML::Strip/1.06
31 * Tk::FontDialog/0.15         * Tk::Tree/4.005
33 clivescan
34 ---------
36 * Config::Tiny/2.12           * WWW::Curl/4.05
37 * Tk/804.027                  * Tk::Tree/4.005
38 * Tk::DialogBox/4.013         * Clipboard/0.09
39 * Tk::FontDialog/0.15         * HTML::TokeParser/2.37
41 clivepass
42 ---------
44 * Crypt::PasswdMD5/1.3        * Crypt::Twofish2/1.01
45 * Crypt::Salt/0.01            * Config::Tiny/2.12
48 Installation
49 ------------------------------------------------------------------------------
51 Extract:
52     % tar xvjf clive-utils-$release.tar.bz2 && cd clive-utils-$release
54 Run:
55     # If the path to clive(1) is not specified (e.g. --clive=path), the
56     # clive-utils programs try to locate it in the $PATH.
58     % clivefeed [option]... [URL]...
59     % clivescan [option]... [URL]...
60     % clivepass [option]...
62 Getting started:
63     % clivefeed --manual
64     % clivescan --manual
65     % clivepass --manual
67 The manual pages is written in Perl Pod markup language and they are embedded
68 in the script files. See "perldoc perlpod" for more info. For example:
69     % pod2man clivefeed > clivefeed.1
72 Installation: FreeBSD (7.0)
73 ------------------------------------------------------------------------------
75 From the ports:
76   * x11-toolkits/p5-Tk-FontDialog
77   * textproc/p5-XML-RSS-LibXML
78   * security/p5-Digest-SHA
79   * devel/p5-Config-Tiny
80   * x11-toolkits/p5-Tk
81   * www/p5-HTML-Parser
82   * www/p5-HTML-Strip
83   * net/p5-URI
84   * ftp/curl
85   * security/p5-Crypt-PasswdMD5
86   * security/p5-Crypt-Twofish2
87   * security/p5-Crypt-Salt
88   * security/p5-Digest-MD5
89   * converters/p5-MIME-Base64
90   * devel/p5-File-Path
91   -- Optional:
92   * x11/p5-Clipboard
94 From CPAN:
95   * WWW::Curl
98 Installation: Ubuntu (Hardy)
99 ------------------------------------------------------------------------------
101 From apt: # Typically: "sudo apt-get install $module"
102   * libcurl4-openssl-dev
103   * libhtml-parser-perl
104   * libconfig-tiny-perl
105   * libdigest-sha-perl
106   * libfile-spec-perl
107   * liburi-perl 
108   * perl-doc
109   * perl-tk
110   * libmd5-perl
111   * libemail-mime-encodings-perl
112   * libio-all-perl
113   -- Optional:
114   * xclip (for Clipboard module below)
116 From CPAN: # Typically: "sudo cpan install $module"
117   * WWW::Curl
118   * HTML::Strip
119   * XML::RSS::LibXML
120   * Tk::FontDialog
121   * Crypt::PasswdMD5
122   * Crypt::Twofish2
123   * Crypt::Salt
124   -- Optional:
125   * Clipboard