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 `bootstrap.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 * LuaSocket 2.0.2
  84   http://w3.impa.br/~diego/software/luasocket/
  85
  86   e.g.
  87     $ aptitude install liblua5.1-socket2
  88
  89 * LuaExpat 1.2.0
  90   http://matthewwild.co.uk/projects/luaexpat/
  91
  92   e.g.
  93     $ aptitude install liblua5.1-expat
  94
  95 * Lua bitop 1.0.1
  96   http://bitop.luajit.org/
  97
  98   e.g.
  99     $ aptitude install liblua5.1-bitop0
 100
 101 * pkg-config for tracking the compilation flags needed for libraries
 102   http://www.freedesktop.org/software/pkgconfig/
 103
 104 * GNU make is recommended
 105   http://www.gnu.org/software/make
 106
 107 * asciidoc (a2x) for producing the manual pages
 108   http://www.methods.co.nz/asciidoc/
 109
 110       See also "Documentation".
 111
 112 When the configure script is run with the `--with-tests':
 113
 114   * libquvi 0.9
 115     http://quvi.sf.net/
 116
 117   * GLib 2.24.2
 118     http://library.gnome.org/devel/glib/
 119
 120   * libcurl 7.21.0
 121     http://curl.haxx.se/
 122
 123
 124 Installation directories
 125 ------------------------
 126
 127 The location of the installed files is determined by the --prefix
 128 and the --exec-prefix options given to the configure script.
 129
 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.
 132
 133
 134 Documentation
 135 =============
 136
 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
 140 more information.
 141
 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.
 145
 146 Make targets:
 147
 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
 152
 153
 154 Tests
 155 =====
 156
 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.
 160
 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'.
 164
 165     NOTE: You must run `configure --with-tests' to enable the tests,
 166           they are not enabled by default.
 167
 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
 171
 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
 176
 177
 178 Tests: Environment variables
 179 ----------------------------
 180
 181 The testsuite supports the following environment variables:
 182
 183   TEST_VERBOSE  will enable verbose libcurl(3) output.
 184
 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
 187   expression patterns.
 188
 189   TEST_GEOBLOCKED  will enable the tests for the scripts that have been
 190   marked as "geoblocked". These are skipped by default.
 191
 192   TEST_FIXME  will enable the tests for the scripts that have been marked
 193   as "FIXME". These are skipped by default.
 194
 195   TEST_NSFW  will enable the tests for the scripts that have been marked
 196   as "NSFW". These are skipped by default.
 197
 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)
 201
 202 Example:
 203
 204   % env TEST_SKIP=test_media_,test_scan_  make test
 205
 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
 208
 209
 210 Tests: Scripts
 211 --------------
 212
 213 The tests/ directory contains:
 214
 215   'find_tests.sh'   will dump a list of available tests.
 216
 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).
 220
 221 For more info, run these scripts with the '-h' switch.
 222
 223
 224 Tests: Proxy
 225 ------------
 226
 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).
 229
 230   libquvi (and libquvi-scripts) uses libcurl to connect to the internet.
 231
 232
 233 How to report bugs
 234 ==================
 235
 236 Please see: http://quvi.sourceforge.net/#bugs
 237
 238
 239 Patches
 240 =======
 241
 242 Please see: http://quvi.sourceforge.net/contrib/
 243
 244
 245 License
 246 =======
 247
 248 libquvi-scripts is Free Software licensed under the GNU Affero GPLV3+