INSTALL

   1
   2
   3 Prerequisites
   4 -------------
   5
   6 * libcurl   7.18.2+  <http://curl.haxx.se/>
   7 * libiconv  1.12.0+  <http://www.gnu.org/software/libiconv/>
   8 * (lib)lua  5.1+     <http://lua.org/>
   9
  10          [quvi]
  11           /
  12          /
  13   [libquvi]-----[libcurl]
  14        |   \       \
  15    [liblua] \       \
  16             |    [dragons be here]
  17       [libiconv]
  18
  19
  20 Installation from source
  21 ------------------------
  22
  23 REMINDER: Run "make uninstall" if you have installed quvi from the
  24 source previously.
  25
  26   * How to use GNU Autotools build system falls outside of the scope of
  27   this documentation, refer to the appropriate sources instead
  28
  29   * IF you are unsure, THEN do not install from the source; quvi is
  30   available to many distros as a precompiled package which (should) make
  31   sure that no files are left behind on your system that might later
  32   interfere with the newer versions of quvi
  33
  34   * Consider yourself reminded
  35
  36 "./configure && make install", typically. See also "./configure --help".
  37 If you are compiling quvi from the development code from the git
  38 repository, see "Installation from development code", instead.
  39
  40     --enable-tests          Enable tests (e.g. "make check", req. Perl)
  41                               The tests are not run by default. For
  42                               verbose tests, set TEST_VERBOSE environment.
  43                               Recommended for developers only.
  44
  45     --enable-nsfw           Install (&test) webscripts marked as "NSFW"
  46                               "Not safe for work" webscripts. Not installed
  47                               by default.
  48
  49     --enable-todo           Install (&test) webscripts marked as "TODO"
  50                               Broken, outdated etc. webscripts. Not
  51                               installed by default. Recommended for
  52                               developers only.
  53
  54     --enable-nlfy           Enable *tests* for webscripts marked as "NLFY"
  55                               "No love for you" scripts for websites that
  56                               follow strict country policies (a.k.a. "Sorry,
  57                               we do not accept connections from your
  58                               country"). Not tested by default.
  59
  60                               See also --enable-tests above. These
  61                               webscripts are installed *always*.
  62
  63     --disable-quvi          Do not build (&install) the quvi command
  64
  65     --enable-examples       Build examples which are not compiled by default,
  66                               No real value to the users, developers
  67                               may want to use this switch
  68
  69     --with-soup             Build with libsoup(-gnome)
  70                               Required *only* by examples/callback_libsoup.c,
  71                               ignored unless both --enable-examples and
  72                               --with-soup are used. No real value to the
  73                               users, recommended for developers only
  74
  75     --without-manual        Do not install manual page(s)
  76
  77
  78 Installation from development code
  79 ----------------------------------
  80
  81 If you are compiling quvi from the development code, run "autogen.sh",
  82 first. This generates the configuration files that are not in the git
  83 repository. You will need:
  84
  85   * Perl (with pod2man)
  86   * GNU autoconf
  87   * GNU automake
  88   * GNU gengetopt
  89
  90 Once the files have been generated, follow the instructions in "Installation
  91 from source" above.
  92
  93
  94 C API documentation
  95 -------------------
  96
  97 "make doc" generates the C API reference documentation from the
  98 NaturalDocs tags. The same documentation is available at:
  99   <http://quvi.sourceforge.net/>
 100
 101 The documentation is not installed with quvi.
 102
 103
 104 Tests
 105 -----
 106
 107 "configure --enable-tests && make check", typically. The test suite is
 108 intended for developers only and will use the Internet. See also
 109 $top_srcdir/tests/README.