Set release details for 0.2.13
[quvi.git] / INSTALL
blobf7a8d4bcb4335d36d7fc040e9f58a5d771359acc
3     Prerequisites
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/>
9   [libquvi]------\
10        |         [libcurl]
11    [liblua]         \
12                      [dragons be here]
15     Installation
17 "./configure && make install", typically. See also "./configure --help".
19     --enable-tests      Enable tests (e.g. "make check")
20     --enable-nsfw       Enable support for NSFW websites
21     --enable-broken     Enable support for broken websites
22     --disable-quvi      Do not build (and install) quvi tool
23     --disable-examples  Do not build example(s)
24     --without-man       Do not install the manual page(s)
25     --without-doc       Do not install doc/ contents
28     C API documentation
30 "make dox" generates the C API reference documentation from the doxygen
31 tags. Both, HTML and LaTeX, documentation are generated by default. These
32 are also made available at: <http://quvi.sourceforge.net/>
35     Tests
37 e.g. "make check", the following environment variables can be used:
39   NO_INTERNET         Disable all tests that require internet connection
40   TEST_RESTRICTED     Enable website rule tests known for country restrictions
41   QUVI_TEST_OPTIONS   Additional options to pass to quvi when the tests are run
43 Note that only the HTTP tests are run.
45 Examples:
46     QUVI_TEST_OPTIONS="--debug -n" make check     # See --enable-tests