AC_CONFIG_FILES: Add doc/man5/Makefile
[quvi-tool.git] / README
blob89c7f6a6072b41ee5beefe8619ab3a1ca3a52e7e
1 General
2 =======
4 quvi is the command line tool for developing the libquvi scripts and
5 parsing the media properties.
7 gitweb: <http://repo.or.cz/w/quvi-tool.git>
8 Home  : <http://quvi.sourceforge.net/>
11 Installation
12 ============
14 Notes
15 -----
17   * This document does not cover how to use GNU Autotools for building
18 and installing software, instead, refer to the GNU Autotools documentation,
19 the INSTALL file and the "configure --help" output for more information.
21   * If you're not familiar with GNU Autotools and/or installing software
22 from the source code, you may prefer to install quvi using a binary
23 package, instead. You can find quvi packaged for many distros already.
25   * If you have previously installed quvi from the source code to your
26 system, the recommended practice is to uninstall the previous installation
27 first, before you continue with the new one. You would, typically, run
28 "make uninstall" (as root if necessary) from the same directory you ran
29 "make install" from.
31   * If you are building quvi from the git repository code, run the
32 `bootstrap.sh' first. This generates the configuration files. See also
33 the -h output for any additional info.
36 Simple install procedure
37 ------------------------
39   % ./configure && make
41   [ Become root if necessary ]
42   % make install
44 The configure script supports also the following options which are
45 relevant to the installation:
47   --with(out)-manual
49     Install the manual page for quvi.
51 Requirements
52 ------------
54 * libquvi 0.9
55   http://quvi.sf.net/
57 * libcurl 7.21.0
58   http://curl.haxx.se/
60 * GLib 2.24.2
61   http://library.gnome.org/devel/glib/
63 * JsonGlib 0.12
64   http://live.gnome.org/JsonGlib
65   NOTE: builds without: JSON output will be disabled
67 * libxml 2.7.8
68   http://www.xmlsoft.org/
69   NOTE: builds without: XML output will be disabled
71 * pkg-config for tracking the compilation flags needed for libraries
72   http://www.freedesktop.org/software/pkgconfig/
74 * GNU gettext is recommended
75   http://www.gnu.org/software/gettext/
77 * GNU make is recommended
78   http://www.gnu.org/software/make/
81 How to report bugs
82 ==================
84 Please see: http://quvi.sourceforge.net/#bugs
87 Patches
88 =======
90 Please see: http://quvi.sourceforge.net/contrib/
93 License
94 =======
96 quvi is Free Software, licensed under the GNU Affero GPLv3+.