INSTALL

   1
   2
   3 Prerequisites
   4 =============
   5
   6   * libquvi-scripts   0.4.0+      <http://quvi.sourceforge.net/>
   7   * libcurl           7.18.2+     <http://curl.haxx.se/>
   8   * libiconv          1.12.0+     <http://www.gnu.org/software/libiconv/>
   9   * (lib)lua          5.1+        <http://lua.org/>
  10
  11
  12 Installation from source
  13 ========================
  14
  15 REMINDER: Run "make uninstall" if you have installed libquvi from the
  16 source previously.
  17
  18   * How to use GNU Autotools build system falls outside of the scope of
  19   this documentation, refer to the appropriate sources instead
  20
  21   * IF you are unsure, THEN do not install from the source
  22     - libquvi is available to many distros as a precompiled package
  23
  24     - Precompiled packages (ideally) make sure that no old files are
  25       left behind when the software is upgraded or uninstalled
  26
  27     - Any old files left behind on your system may potentially interfere
  28       with the new version of libquvi
  29
  30   * Consider yourself reminded
  31
  32 "./configure && make install", typically. See also "./configure --help".
  33 If you are compiling libquvi from the development code from the git
  34 repository, see "Installation from development code", instead.
  35
  36   --with-examples         Build examples which are not compiled by default,
  37                             No real value to the users, developers
  38                             may want to use this switch
  39
  40   --with-soup             Build with libsoup(-gnome) examples
  41                             Required *only* by examples/callback_libsoup.c,
  42                             ignored unless both --with-examples and
  43                             --with-soup are used. No real value to the
  44                             users, recommended for developers only
  45
  46   --with-nd-output =arg   Where arg can be either "HTML" or "FramedHTML"
  47                             May be used to define the output format
  48                             for the API documentation produced by
  49                             NaturalDocs
  50
  51   --without-manual        Do not install manual page(s)
  52
  53
  54 Installation from development code
  55 ==================================
  56
  57 If you are compiling libquvi from the development code, run "autogen.sh",
  58 first. This generates the configuration files that are not in the git
  59 repository. You will need:
  60
  61   * GNU Autotools (autoconf, automake, etc.)
  62   * GNU libiconv (for AM_ICONV macro, in configure.ac)
  63
  64 Once the files have been generated, follow the instructions in "Installation
  65 from source" above.
  66
  67
  68 API documentation
  69 =================
  70
  71 "make doc" generates the C API reference documentation from the
  72 NaturalDocs tags. The same documentation is available at:
  73   <http://quvi.sourceforge.net/>
  74
  75 The documentation is *not* installed with libquvi. Additional make target
  76 "make distdoc" exists that creates a tarball from the generated HTML.