INSTALL

   1
   2
   3 Prerequisites
   4 -------------
   5
   6 * libcurl   7.18.0+  <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 (release) source tarball
  21 ------------------------------------------
  22
  23 "./configure && make install", typically. See also "./configure --help".
  24 See also "Installation from development code" further below.
  25
  26     --enable-tests          Enable tests (e.g. "make check", req. Perl)
  27     --enable-verbose-tests  Verbose tests
  28
  29     --enable-nsfw           Install (&test) webscripts marked as "NSFW" [#1]
  30     --enable-todo           Install (&test) webscripts marked as "TODO" [#2]
  31     --enable-nlfy           Enable tests for webscripts marked as "NLFY" [#3]
  32
  33     --disable-quvi          Do not build (&install) the quvi command
  34     --disable-examples      Do not build examples
  35
  36     --with-soup             Build with libsoup(-gnome) [#4]
  37     --without-man           Do not install manual page(s)
  38
  39 [1] Webscripts marked as "NSFW" ("Not Safe For Work")
  40     (installed only with --enable-nsfw)
  41
  42 [2] Broken and outdated webscripts marked as "TODO" for developers
  43     (installed only with --enable-todo)
  44
  45 [3] Webscripts marked as "NLFY" ("No Love For You") for websites
  46     that follow strict country policies, a.k.a.
  47         "Sorry we do not accept connections from your country"
  48     (installed always)
  49
  50 [4] Required currently by examples/callback_libsoup.c *only*
  51     (compiled only with --enable-examples and --with-soup)
  52
  53
  54 Installation from development code
  55 ----------------------------------
  56
  57 If you are compiling quvi from the development code, run "autogen.sh".
  58 This generates the configuration files that are not in the git
  59 repository. You will need:
  60
  61   * Perl (with pod2man)
  62   * GNU autoconf
  63   * GNU automake
  64   * gengetopt
  65
  66 Once the files have been generated, you can follow the instructions in
  67 "Installation from source tarball".
  68
  69
  70 C API documentation
  71 -------------------
  72
  73 "make doc" generates the C API reference documentation from the
  74 NaturalDocs tags. The same documentation is available at:
  75     <http://quvi.sourceforge.net/>
  76
  77
  78 Tests
  79 -----
  80
  81 Run either "make check" or "make test". Please note that in order to
  82 enable tests, you must run `configure' with `--enable-tests'. Note also
  83 that the test suite is intended for developers and *will* use the
  84 Internet. See also $top_srcdir/tests/README.