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 * pkg-config for tracking the compilation flags needed for libraries
  84   http://www.freedesktop.org/software/pkgconfig/
  85
  86 * GNU make is recommended
  87   http://www.gnu.org/software/make
  88
  89 When the configure script is run with the `--with-tests':
  90
  91   * libquvi 0.9
  92     http://quvi.sf.net/
  93
  94   * GLib 2.24.2
  95     http://library.gnome.org/devel/glib/
  96
  97   * libcurl 7.21.0
  98     http://curl.haxx.se/
  99
 100
 101 Installation directories
 102 ------------------------
 103
 104 The location of the installed files is determined by the --prefix
 105 and the --exec-prefix options given to the configure script.
 106
 107 The .pc file for libquvi-scripts is installed in $exec_prefix/lib/pkgconfig
 108 to provide information when compiling packages that depend on libquvi-scripts.
 109
 110
 111 Tests
 112 =====
 113
 114 The tests use the GLib framework for testing. All of these tests require
 115 the presence of the libquvi and a working internet connection. The tests
 116 reside in the tests/ directory.
 117
 118 When building with GNU Autotools,
 119
 120   'make check'  will run the test programs listed in the TEST_PROGS
 121   variable in the tests/Makefile.am . It will fail if any of the
 122   tests fail. This is identical to running 'make test'.
 123
 124     NOTE: You must run `configure --with-tests' to enable the tests,
 125           they are not enabled by default.
 126
 127   'make distcheck'  will fail if any of the tests fail. Note that this
 128   would, typically, require:
 129     env DISTCHECK_CONFIGURE_FLAGS=--with-tests  make distcheck
 130
 131 The tests use the gtester(1) and gtester-report(1) commands to produce
 132 the logs. These programs are part of GLib. The test programs produce:
 133   $(top_builddir)/tests/$test_program.html  # gtester-report
 134   $(top_builddir)/tests/$test_program.xml   # gtester
 135
 136
 137 Tests: Environment variables
 138 ----------------------------
 139
 140 The testsuite supports the following environment variables:
 141
 142   TEST_VERBOSE  will enable verbose libcurl(3) output.
 143
 144   TEST_SKIP  will disable the specified tests. This list is a comma-separated
 145   list of test names. The comma-separated values are treated as regular
 146   expression patterns.
 147
 148   TEST_GEOBLOCKED  will enable the tests for the scripts that have been
 149   marked as "geoblocked". These are skipped by default.
 150
 151   TEST_FIXME  will enable the tests for the scripts that have been marked
 152   as "FIXME". These are skipped by default.
 153
 154   TEST_NSFW  will enable the tests for the scripts that have been marked
 155   as "NSFW". These are skipped by default.
 156
 157   TEST_LEVEL  will set the level ('basic', 'complete') of the tests.
 158     'complete'  - additional and mandatory script tests
 159     'basic'     - mandatory script tests only (default)
 160
 161 Example:
 162
 163   % env TEST_SKIP=test_media_,test_scan_  make test
 164
 165   % env TEST_VERBOSE=1 TEST_FIXME=1 TEST_GEOBLOCKED=1 TEST_LEVEL=complete \
 166       TEST_SKIP=test_media_vimeo,test_playlist_youtube  make test
 167
 168
 169 Tests: Scripts
 170 --------------
 171
 172 The tests/ directory contains:
 173
 174   'find_tests.sh'   will dump a list of available tests.
 175
 176   'run_tests.sh'  is a convenience script that wraps many of the
 177   testsuite features making them available via GUI. Note that
 178   this script requires zenity(1).
 179
 180 For more info, run these scripts with the '-h' switch.
 181
 182
 183 Tests: Proxy
 184 ------------
 185
 186 If you need to use a proxy, refer to the curl(1) manual page for a
 187 complete list of the supported environment variables (e.g. http_proxy).
 188
 189   libquvi (and libquvi-scripts) uses libcurl to connect to the internet.
 190
 191
 192 How to report bugs
 193 ==================
 194
 195 Please see: http://quvi.sourceforge.net/#bugs
 196
 197
 198 Patches
 199 =======
 200
 201 Please see: http://quvi.sourceforge.net/#contrib
 202
 203
 204 License
 205 =======
 206
 207 libquvi-scripts is Free Software, licensed under the LGPLv2.1+.