share/lua/README

   1
   2
   3 This directory contains the quvi lua scripts. If you are new to lua,
   4 <http://www.lua.org/pil/> is a good place to start.
   5
   6   website/quvi  - misc. utility scripts that the webscripts use
   7   website/      - webscripts that are used to parse the media details
   8   util/         - utility scripts that libquvi uses
   9
  10 Refer to the libquvi API documentation at <http://quvi.sourceforge.net/doc/>
  11 for a tutorial.
  12
  13
  14 Debugging tips
  15 ==============
  16
  17 Search paths
  18 ------------
  19
  20 Typical libquvi lua script search paths. Scanned in the following order:
  21
  22   1) $LIBQUVI_SCRIPTSDIR
  23
  24   2) Current working directory
  25
  26   3) $HOME/.libquvi-scripts/
  27
  28   4) $HOME/.config/libquvi-scripts/
  29
  30   5) $HOME/.local/share/libquvi-scripts/
  31
  32   6) `pkg-config --variable scriptsdir libquvi-scripts`
  33      typically this is "$prefix/share/libquvi-scripts/"
  34
  35 The library will look for the scripts under lua/ subdirectory.
  36
  37
  38 Environment variables
  39 ---------------------
  40
  41   LIBQUVI_SHOW_SCANDIR  - If set, libquvi prints out the scanned dir paths
  42   LIBQUVI_SHOW_SCRIPT   - If set, libquvi prints out the found scripts
  43   LIBQUVI_SCRIPTSDIR    - If defined, libquvi scans it for the scripts first