INSTALL

   1 Prerequisites
   2 ------------------------------------------------------------------------------
   3
   4  * clive >= 2.0.0  (http://clive.sourceforge.net)
   5  * Perl  >= 5.8    (http://perl.org)
   6
   7 If a module is listed as "opt." (optional), this means that the utility
   8 works without it but some functionalities are disabled.
   9
  10 Most distros should have the modules listed below as installable packages.
  11 If this is not the case, you can install the missing modules from CPAN
  12 (http://cpan.org), e.g.:
  13     % cpan install WWW::Curl # as root or sudo
  14
  15 clivefeed
  16 ---------
  17
  18 * Config::Tiny/2.12           * WWW::Curl/4.05
  19 * XML::RSS::LibXML/0.3002     * Clipboard/0.09 (opt.)
  20 * Tk/804.027                  * URI::Escape/3.29
  21 * Tk::DialogBox/4.013         * HTML::Strip/1.06
  22 * Tk::FontDialog/0.15 (opt.)  * Tk::Tree/4.005
  23
  24   * Clipboard       -- affects --paste
  25   * Tk::FontDialog  -- affects GUI font configuration
  26
  27 clivescan
  28 ---------
  29
  30 * Config::Tiny/2.12           * WWW::Curl/4.05
  31 * Tk/804.027                  * Tk::Tree/4.005
  32 * Tk::DialogBox/4.013         * Clipboard/0.09 (opt.)
  33 * Tk::FontDialog/0.15 (opt.)  * HTML::TokeParser/2.37
  34
  35   * Clipboard       -- affects --paste
  36   * Tk::FontDialog  -- affects GUI font configuration
  37
  38 clivepass
  39 ---------
  40
  41 * Crypt::PasswdMD5/1.3        * Crypt::Twofish2/1.01
  42 * Crypt::Salt/0.01            * Config::Tiny/2.12
  43
  44
  45 Installation
  46 ------------------------------------------------------------------------------
  47
  48 Extract:
  49     % tar xvjf clive-utils-$release.tar.bz2
  50     % cd clive-utils-$release
  51
  52 Run:
  53     If the path to clive(1) utility is not specified (e.g. --clive=path), the
  54     clive-utils programs try to locate it in the $PATH.
  55         % clivefeed [option]... [URL]...
  56         % clivescan [option]... [URL]...
  57         % clivepass [option]...
  58
  59     See also the configs/ for example configuration files. To minimize the
  60     overhead, it's a good idea to save the path to a configuration file.
  61
  62 Getting started:
  63     The manual pages are written in Perl Pod markup language and they are
  64     embedded in the script files. See "perldoc perlpod" for more info.
  65     You can access the manual page by using the --manual option, e.g.:
  66         % clivefeed --manual
  67
  68     Or you can use the pod2(man|text|latex|html) utilities to convert the
  69     Pod to another format, e.g.:
  70         % pod2man clivefeed > clivefeed.1
  71
  72     There is also the "genman" script which wraps the pod2man and produces
  73     the manual pages with the most common options. This script is used to
  74     generate the manual pages bundled with the source code.
  75
  76 See also:
  77     configs/ subdir for example configuration files
  78
  79