INSTALL

   1
   2
   3     Prerequisites
   4
   5 * libcurl   7.18.0+  <http://curl.haxx.se/>
   6 * libiconv  1.12.0+  <http://www.gnu.org/software/libiconv/>
   7 * (lib)lua  5.1+     <http://lua.org/>
   8
   9          [quvi]
  10           /
  11          /
  12   [libquvi]-----[libcurl]
  13        |   \       \
  14    [liblua] \       \
  15             |    [dragons be here]
  16       [libiconv]
  17
  18
  19     Installation
  20
  21 "./configure && make install", typically. See also "./configure --help".
  22
  23     --enable-tests          Enable tests (e.g. "make check")
  24     --enable-verbose-tests  Verbose tests
  25
  26     --enable-nsfw           Install (&test) webscripts marked as "NSFW" [#1]
  27     --enable-todo           Install (&test) webscripts marked as "TODO" [#2]
  28     --enable-nlfy           Enable tests for webscripts marked as "NLFY" [#3]
  29
  30     --disable-quvi          Do not build (&install) the quvi command
  31     --disable-examples      Do not build examples
  32
  33     --with-soup             Build with libsoup(-gnome) [#4]
  34     --without-man           Do not install manual pages
  35     --without-doc           Do not install doc/ contents
  36
  37 [1] Webscripts marked as "NSFW" ("Not Safe For Work")
  38     (installed only with --enable-nsfw)
  39
  40 [2] Broken and outdated webscripts marked as "TODO" for developers
  41     (installed only with --enable-todo)
  42
  43 [3] Webscripts marked as "NLFY" ("No Love For You") for websites
  44     that follow strict country policies, a.k.a.
  45         "Sorry we do not accept connections from your country"
  46     (installed always)
  47
  48 [4] Required currently by examples/callback_libsoup.c *only*
  49     (compiled only with --enable-examples and --with-soup)
  50
  51
  52     C API documentation
  53
  54 "make dox" generates the C API reference documentation from the doxygen
  55 tags. Both, HTML and LaTeX, documentation are generated by default. These
  56 are also made available at: <http://quvi.sourceforge.net/>
  57
  58
  59     Tests
  60
  61 Run either "make check" or "make test". Please note that in order to
  62 enable tests, you must run `configure' with `--enable-tests'. Note also
  63 that the test suite is intended for developers and *will* use the
  64 Internet. See also $top_srcdir/tests/README.