Fixed scanning: invalid links with garbage chars.
[clive-utils.git] / INSTALL
blob2bbf214d47223f77a2b01efa88ed7848b6e965ac
1 Prerequisites
2 ------------------------------------------------------------------------------
4 clive >= 2.0.0 (http://clive.sf.net)
5 Perl >= 5.8 (http://perl.org)
7 clivefeed
8 ---------
10 * Config::Tiny/2.12           * WWW::Curl/4.05
11 * XML::RSS::LibXML/0.3002     * Clipboard/0.09 (optional)
12 * Tk/804.027                  * URI::Escape/3.29
13 * Tk::DialogBox/4.013         * HTML::Strip/1.06
14 * Tk::FontDialog/0.15 (opt.)  * Tk::Tree/4.005
16 clivescan
17 ---------
19 * Config::Tiny/2.12           * WWW::Curl/4.05
20 * Tk/804.027                  * Tk::Tree/4.005
21 * Tk::DialogBox/4.013         * Clipboard/0.09
22 * Tk::FontDialog/0.15 (opt.)  * HTML::TokeParser/2.37
24 clivepass
25 ---------
27 * Crypt::PasswdMD5/1.3        * Crypt::Twofish2/1.01
28 * Crypt::Salt/0.01            * Config::Tiny/2.12
30 Most distros should have the above versions available as packages.
31 If not, you can still use CPAN to install the missing modules, e.g.:
32     % cpan install WWW::Curl # as root
35 Installation
36 ------------------------------------------------------------------------------
38 Extract:
39     % tar xvjf clive-utils-$release.tar.bz2; cd clive-utils-$release
41 Run:
42     # If the path to clive(1) is not specified (e.g. --clive=path), the
43     # clive-utils programs try to locate it in the $PATH.
45     % clivefeed [option]... [URL]...
46     % clivescan [option]... [URL]...
47     % clivepass [option]...
49 Getting started:
50     % clivefeed --manual
51     % clivescan --manual
52     % clivepass --manual
54 The manual pages is written in Perl Pod markup language and they are embedded
55 in the script files. See "perldoc perlpod" for more info. For example:
56     % pod2man clivefeed > clivefeed.1
57     Or:
58     % ./genman # wraps the above for all scripts with the most common options
60 See also:
61     configs/ subdir for example configuration files
64 Installation: FreeBSD (7.0)
65 ------------------------------------------------------------------------------
67 TODO: Needs more extensive details.
69 From the ports:
70   * x11-toolkits/p5-Tk-FontDialog
71   * textproc/p5-XML-RSS-LibXML
72   * security/p5-Digest-SHA
73   * devel/p5-Config-Tiny
74   * x11-toolkits/p5-Tk
75   * www/p5-HTML-Parser
76   * www/p5-HTML-Strip
77   * net/p5-URI
78   * ftp/curl
79   * security/p5-Crypt-PasswdMD5
80   * security/p5-Crypt-Twofish2
81   * security/p5-Crypt-Salt
82   * security/p5-Digest-MD5
83   * converters/p5-MIME-Base64
84   * devel/p5-File-Path
85   -- Optional:
86   * x11/p5-Clipboard
88 From CPAN:
89   * WWW::Curl
92 Installation: Ubuntu (Hardy)
93 ------------------------------------------------------------------------------
95 TODO: Needs more extensive details.
97 From apt: # Typically: "sudo apt-get install $module"
98   * libcurl4-openssl-dev
99   * libhtml-parser-perl
100   * libconfig-tiny-perl
101   * libdigest-sha-perl
102   * libfile-spec-perl
103   * liburi-perl 
104   * perl-doc
105   * perl-tk
106   * libmd5-perl
107   * libemail-mime-encodings-perl
108   * libio-all-perl
109   -- Optional:
110   * xclip (for Clipboard module below)
112 From CPAN: # Typically: "sudo cpan install $module"
113   * WWW::Curl
114   * HTML::Strip
115   * XML::RSS::LibXML
116   * Tk::FontDialog
117   * Crypt::PasswdMD5
118   * Crypt::Twofish2
119   * Crypt::Salt
120   -- Optional:
121   * Clipboard