README

   1 General
   2 =======
   3
   4 libquvi-scripts contains the Lua scripts for libquvi that it uses to parse
   5 the media properties.
   6
   7 gitweb: <http://repo.or.cz/w/libquvi-scripts.git>
   8 Home  : <http://quvi.sourceforge.net/>
   9
  10
  11 Installation
  12 ============
  13
  14 Notes
  15 -----
  16
  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.
  20
  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
  24 distros already.
  25
  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.
  31
  32   * If you are building libquvi-scripts from the git repository code, run
  33 the `autogen.sh' first. This generates the configuration files. See also
  34 the -h output for any additional info.
  35
  36
  37 Simple install procedure
  38 ------------------------
  39
  40   % ./configure && make
  41
  42   [ Become root if necessary ]
  43   % make install
  44
  45 The configure script supports also the following options which are
  46 relevant to the installation:
  47
  48   --with(out)-geoblocked (default: yes)
  49
  50     Install the scripts written for websites that are known to geoblock
  51     IP addresses outside of their definition of the accepted IP ranges.
  52
  53     These are usually websites that block IPs from countries, sometimes
  54     even cities, based on the registered geological location of the IP
  55     address.
  56
  57   --with(out)-fixme (default: no)
  58
  59     Install the scripts that have been marked as "FIXME". These are
  60     known to be broken and need to be fixed. Patches welcome.
  61
  62   --with(out)-nsfw (default: no)
  63
  64     Install the scripts written for websites that host NSFW media.
  65
  66   --with(out)-manual (default:yes)
  67
  68     Install the manual page for libquvi-scripts.
  69
  70   --with(out)-tests (default: no)
  71
  72     Install with the tests. This enables the testsuite, see "Tests"
  73     for more information.
  74
  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.
  78
  79
  80 Requirements
  81 ------------
  82
  83 * LuaExpat 1.2.0  (not checked by configure)
  84   http://matthewwild.co.uk/projects/luaexpat/
  85
  86 * LuaSocket 2.0.2  (not checked by configure)
  87   http://w3.impa.br/~diego/software/luasocket/
  88
  89 * pkg-config for tracking the compilation flags needed for libraries
  90   http://www.freedesktop.org/software/pkgconfig/
  91
  92 * GNU make is recommended
  93   http://www.gnu.org/software/make
  94
  95 When the configure script is run with the `--with-tests':
  96
  97   * libquvi 0.9
  98     http://quvi.sf.net/
  99
 100   * GLib 2.24.2
 101     http://library.gnome.org/devel/glib/
 102
 103   * libcurl 7.21.0
 104     http://curl.haxx.se/
 105
 106
 107 Installation directories
 108 ------------------------
 109
 110 The location of the installed files is determined by the --prefix
 111 and the --exec-prefix options given to the configure script.
 112
 113 The .pc file for libquvi-scripts is installed in $exec_prefix/lib/pkgconfig
 114 to provide information when compiling packages that depend on libquvi-scripts.
 115
 116
 117 Tests
 118 =====
 119
 120 The tests use the GLib framework for testing. All of these tests require
 121 the presence of the libquvi and a working internet connection. The tests
 122 reside in the tests/ directory.
 123
 124 When building with GNU Autotools,
 125
 126   'make check'  will run the test programs listed in the TEST_PROGS
 127   variable in the tests/Makefile.am . It will fail if any of the
 128   tests fail. This is identical to running 'make test'.
 129
 130     NOTE: You must run `configure --with-tests' to enable the tests,
 131           they are not enabled by default.
 132
 133   'make distcheck'  will fail if any of the tests fail. Note that this
 134   would, typically, require:
 135     env DISTCHECK_CONFIGURE_FLAGS=--with-tests  make distcheck
 136
 137 The tests use the gtester(1) and gtester-report(1) commands to produce
 138 the logs. These programs are part of GLib. The test programs produce:
 139   $(top_builddir)/tests/$test_program.html  # gtester-report
 140   $(top_builddir)/tests/$test_program.xml   # gtester
 141
 142
 143 Tests: Environment variables
 144 ----------------------------
 145
 146 The testsuite supports the following environment variables:
 147
 148   TEST_VERBOSE  will enable verbose libcurl(3) output.
 149
 150   TEST_SKIP  will disable the specified tests. This list is a comma-separated
 151   list of test names. The comma-separated values are treated as regular
 152   expression patterns.
 153
 154   TEST_GEOBLOCKED  will enable the tests for the scripts that have been
 155   marked as "geoblocked". These are skipped by default.
 156
 157   TEST_FIXME  will enable the tests for the scripts that have been marked
 158   as "FIXME". These are skipped by default.
 159
 160   TEST_NSFW  will enable the tests for the scripts that have been marked
 161   as "NSFW". These are skipped by default.
 162
 163   TEST_LEVEL  will set the level ('basic', 'complete') of the tests.
 164     'complete'  - additional and mandatory script tests
 165     'basic'     - mandatory script tests only (default)
 166
 167 Example:
 168
 169   % env TEST_SKIP=test_media_,test_scan_  make test
 170
 171   % env TEST_VERBOSE=1 TEST_FIXME=1 TEST_GEOBLOCKED=1 TEST_LEVEL=complete \
 172       TEST_SKIP=test_media_vimeo,test_playlist_youtube  make test
 173
 174
 175 Tests: Scripts
 176 --------------
 177
 178 The tests/ directory contains:
 179
 180   'find_tests.sh'   will dump a list of available tests.
 181
 182   'run_tests.sh'  is a convenience script that wraps many of the
 183   testsuite features making them available via GUI. Note that
 184   this script requires zenity(1).
 185
 186 For more info, run these scripts with the '-h' switch.
 187
 188
 189 Tests: Proxy
 190 ------------
 191
 192 If you need to use a proxy, refer to the curl(1) manual page for a
 193 complete list of the supported environment variables (e.g. http_proxy).
 194
 195   libquvi (and libquvi-scripts) uses libcurl to connect to the internet.
 196
 197
 198 How to report bugs
 199 ==================
 200
 201 Please see: http://quvi.sourceforge.net/#bugs
 202
 203
 204 Patches
 205 =======
 206
 207 Please see: http://quvi.sourceforge.net/#contrib
 208
 209
 210 License
 211 =======
 212
 213 libquvi-scripts is Free Software, licensed under the LGPLv2.1+.