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     --with-soup             Build with libsoup(-gnome) [3]
  27     --without-man           Do not install manual pages
  28     --without-doc           Do not install doc/ contents
  29
  30 [1] These may be broken scripts that need fixing, not recommended unless
  31     you are a developer/contributor
  32
  33 [2] These may be scripts for websites that are known to block IPs from
  34     outside of their "world of view"; note that this switch affects
  35     the tests only -- these scripts are installed nonetheless
  36
  37 [3] Needed by examples/callback_soup.c which is not compiled by default.
  38     You have to specify both `--enable-examples' and `--with-soup' to
  39     compile this example with quvi.
  40
  41
  42     C API documentation
  43
  44 "make dox" generates the C API reference documentation from the doxygen
  45 tags. Both, HTML and LaTeX, documentation are generated by default. These
  46 are also made available at: <http://quvi.sourceforge.net/>
  47
  48
  49     Tests
  50
  51 Run either "make check" or "make test". Please note that in order to
  52 enable tests, you must run `configure' with `--enable-tests'. Note also
  53 that the test suite is intended for developers and *will* use the
  54 Internet. See also $top_srcdir/tests/README.