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 "./configure && make install", typically. See also "./configure --help".
  24 If you are compiling quvi from the development code from the git
  25 repository, see "Installation from development code", instead.
  26
  27     --enable-tests          Enable tests (e.g. "make check", req. Perl)
  28                                 The tests are not run by default. For
  29                                 verbose tests, set TEST_VERBOSE
  30                                 environment.
  31
  32     --enable-nsfw           Install (&test) webscripts marked as "NSFW"
  33                                 "Not safe for work" webscripts. Not installed
  34                                 by default.
  35
  36     --enable-todo           Install (&test) webscripts marked as "TODO"
  37                                 Broken, outdated etc. webscripts. Not
  38                                 installed by default. Recommended for
  39                                 developers only.
  40
  41     --enable-nlfy           Enable *tests* for webscripts marked as "NLFY"
  42                                 "No love for you" scripts for websites that
  43                                 follow strict country policies (a.k.a.
  44                                 "Sorry, we do not accept connections from
  45                                 your country"). Not tested by default.
  46                                 See also --enable-tests above. These
  47                                 webscripts are installed *always*.
  48
  49     --disable-quvi          Do not build (&install) the quvi command
  50     --enable-examples       Build examples which are not compiled by default
  51
  52     --with-soup             Build with libsoup(-gnome)
  53                                 Required *only* by examples/callback_libsoup.c,
  54                                 ignored unless both --enable-examples and
  55                                 --with-soup are used
  56
  57     --without-manual        Do not install manual page(s).
  58
  59
  60 Installation from development code
  61 ----------------------------------
  62
  63 If you are compiling quvi from the development code, run "autogen.sh",
  64 first. This generates the configuration files that are not in the git
  65 repository. You will need:
  66
  67   * Perl (with pod2man)
  68   * GNU autoconf
  69   * GNU automake
  70   * GNU gengetopt
  71
  72 Once the files have been generated, follow the instructions in "Installation
  73 from source" above.
  74
  75
  76 C API documentation
  77 -------------------
  78
  79 "make doc" generates the C API reference documentation from the
  80 NaturalDocs tags. The same documentation is available at:
  81     <http://quvi.sourceforge.net/>
  82
  83 The documentation is not installed with quvi.
  84
  85
  86 Tests
  87 -----
  88
  89 "configure --enable-tests && make check", typically. The test suite is
  90 intended for developers only and will use the Internet. See also
  91 $top_srcdir/tests/README.