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   [libquvi]------\
  10        |         [libcurl]
  11    [liblua]         \
  12                      [dragons be here]
  13
  14
  15     Installation
  16
  17 "./configure && make install", typically. See also "./configure --help".
  18
  19     --enable-tests          Enable tests (e.g. "make check")
  20     --enable-verbose-tests  Verbose tests
  21     --enable-nsfw           Install (&test) website scripts marked as "NSFW"
  22     --enable-todo           Install (&test) w. scripts marked as "TODO" [1]
  23     --enable-nlfy           Test website scripts marked as "NLFY" [2]
  24     --disable-quvi          Do not build (/install) quvi(1) command
  25     --disable-examples      Do not build examples
  26     --without-man           Do not install manual pages
  27     --without-doc           Do not install doc/ contents
  28
  29 [1] These may be broken scripts that need fixing, not recommended unless
  30     you are a developer/contributor
  31
  32 [2] These may be scripts for websites that are known to block IPs from
  33     outside of their "world of view"; note that this switch affects
  34     the tests only -- these scripts are installed nonetheless
  35
  36
  37     C API documentation
  38
  39 "make dox" generates the C API reference documentation from the doxygen
  40 tags. Both, HTML and LaTeX, documentation are generated by default. These
  41 are also made available at: <http://quvi.sourceforge.net/>
  42
  43
  44     Tests
  45
  46 e.g. "make check", the following environment variables can be used:
  47
  48   NO_INTERNET         Disable all tests that require internet connection
  49   TEST_RESTRICTED     Enable website rule tests known for country restrictions
  50   QUVI_TEST_OPTIONS   Additional options to pass to quvi when the tests are run
  51
  52 Note that only the HTTP tests are run.
  53
  54 Examples:
  55     QUVI_TEST_OPTIONS="--debug -n" make check     # See --enable-tests