4 libquvi-scripts contains the Lua scripts for libquvi that it uses to parse
7 gitweb: <http://repo.or.cz/w/libquvi-scripts.git>
8 Home : <http://quvi.sourceforge.net/>
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 libquvi-scripts using a
23 binary package, instead. You can find libquvi-scripts packaged for many
26 * If you have previously installed libquvi-scripts from the source code
27 to your system, the recommended practice is to uninstall the previous
28 installation first, before you continue with the new one. You would,
29 typically, run "make uninstall" (as root if necessary) from the same
30 directory you ran "make install" from.
32 * If you are building libquvi-scripts from the git repository code, run
33 the `bootstrap.sh' first. This generates the configuration files. See also
34 the -h output for any additional info.
37 Simple install procedure
38 ------------------------
42 [ Become root if necessary ]
45 The configure script supports also the following options which are
46 relevant to the installation:
48 --with(out)-geoblocked (default: yes)
50 Install the scripts written for websites that are known to geoblock
51 IP addresses outside of their definition of the accepted IP ranges.
53 These are usually websites that block IPs from countries, sometimes
54 even cities, based on the registered geological location of the IP
57 --with(out)-fixme (default: no)
59 Install the scripts that have been marked as "FIXME". These are
60 known to be broken and need to be fixed. Patches welcome.
62 --with(out)-nsfw (default: no)
64 Install the scripts written for websites that host NSFW media.
66 --with(out)-manual (default:yes)
68 Install the manual page for libquvi-scripts.
70 --with(out)-tests (default: no)
72 Install with the tests. This enables the testsuite, see "Tests"
75 Note that the --with(out)-* options are ignored by the testsuite.
76 If you need more control over which of the tests should be run,
77 see the "Tests: Environment variables" for more information.
84 http://w3.impa.br/~diego/software/luasocket/
87 $ aptitude install liblua5.1-socket2
90 http://matthewwild.co.uk/projects/luaexpat/
93 $ aptitude install liblua5.1-expat
96 http://bitop.luajit.org/
99 $ aptitude install liblua5.1-bitop0
101 * pkg-config for tracking the compilation flags needed for libraries
102 http://www.freedesktop.org/software/pkgconfig/
104 * GNU make is recommended
105 http://www.gnu.org/software/make
107 * asciidoc (a2x) for producing the manual pages
108 http://www.methods.co.nz/asciidoc/
110 See also "Documentation".
112 When the configure script is run with the `--with-tests':
118 http://library.gnome.org/devel/glib/
124 Installation directories
125 ------------------------
127 The location of the installed files is determined by the --prefix
128 and the --exec-prefix options given to the configure script.
130 The .pc file for libquvi-scripts is installed in $exec_prefix/lib/pkgconfig
131 to provide information when compiling packages that depend on libquvi-scripts.
137 To build the documentation suite, you need to have asciidoc. Because
138 not all users are inclined to install this tool, the default build
139 target does not build the documentation. See "make doc" below for
142 Installation: The libquvi-scripts dist tarball contains prebuilt
143 manual pages, and are installed by default. See `--with(out)-manual'
144 above. See also "make doc" below.
148 'make doc' builds the manual pages for libquvi-scripts if a2x(1) was
149 found by configure. The manual page files can be found at:
150 $top_srcdir/doc/man7/ -- input
151 $top_builddir/doc/man7/ -- output
157 The tests use the GLib framework for testing. All of these tests require
158 the presence of the libquvi and a working internet connection. The tests
159 reside in the tests/ directory.
161 'make check' will run the test programs listed in the TEST_PROGS
162 variable in the tests/Makefile.am . It will fail if any of the
163 tests fail. This is identical to running 'make test'.
165 NOTE: You must run `configure --with-tests' to enable the tests,
166 they are not enabled by default.
168 'make distcheck' will fail if any of the tests fail. Note that this
169 would, typically, require:
170 env DISTCHECK_CONFIGURE_FLAGS=--with-tests make distcheck
172 The tests use the gtester(1) and gtester-report(1) commands to produce
173 the logs. These programs are part of GLib. The test programs produce:
174 $(top_builddir)/tests/$test_program.html # gtester-report
175 $(top_builddir)/tests/$test_program.xml # gtester
178 Tests: Environment variables
179 ----------------------------
181 The testsuite supports the following environment variables:
183 TEST_VERBOSE will enable verbose libcurl(3) output.
185 TEST_SKIP will disable the specified tests. This list is a comma-separated
186 list of test names. The comma-separated values are treated as regular
189 TEST_GEOBLOCKED will enable the tests for the scripts that have been
190 marked as "geoblocked". These are skipped by default.
192 TEST_FIXME will enable the tests for the scripts that have been marked
193 as "FIXME". These are skipped by default.
195 TEST_NSFW will enable the tests for the scripts that have been marked
196 as "NSFW". These are skipped by default.
198 TEST_LEVEL will set the level ('basic', 'complete') of the tests.
199 'complete' - additional and mandatory script tests
200 'basic' - mandatory script tests only (default)
204 % env TEST_SKIP=test_media_,test_scan_ make test
206 % env TEST_VERBOSE=1 TEST_FIXME=1 TEST_GEOBLOCKED=1 TEST_LEVEL=complete \
207 TEST_SKIP=test_media_vimeo,test_playlist_youtube make test
213 The tests/ directory contains:
215 'find_tests.sh' will dump a list of available tests.
217 'run_tests.sh' is a convenience script that wraps many of the
218 testsuite features making them available via GUI. Note that
219 this script requires zenity(1).
221 For more info, run these scripts with the '-h' switch.
227 If you need to use a proxy, refer to the curl(1) manual page for a
228 complete list of the supported environment variables (e.g. http_proxy).
230 libquvi (and libquvi-scripts) uses libcurl to connect to the internet.
236 Please see: http://quvi.sourceforge.net/#bugs
242 Please see: http://quvi.sourceforge.net/contrib/
248 libquvi-scripts is Free Software licensed under the GNU Affero GPLV3+