doc/man7/libquvi-scripts.7.txt

   1 libquvi-scripts(7)
   2 ==================
   3
   4 NAME
   5 ----
   6 libquvi-scripts - Overview of the library scripts
   7
   8 DESCRIPTION
   9 -----------
  10 libquvi-scripts contains the Lua scripts for libquvi that it uses to parse
  11 the different properties, such as the media properties.
  12
  13 TYPES
  14 -----
  15
  16 Common scripts
  17 ~~~~~~~~~~~~~~
  18
  19 The common scripts are modules that may be loaded from other scripts,
  20 e.g. the 'quvi-modules(7)'.
  21
  22 These scripts are typically installed at::
  23   $prefix/share/libquvi-scripts/$major_ver.$minor_ver/common/
  24
  25 Media scripts
  26 ~~~~~~~~~~~~~
  27
  28 The media scripts are responsible for parsing the media properties,
  29 e.g. the media stream URLs. There is usually a media script for
  30 each supported website.
  31
  32 These scripts are typically installed at::
  33   $prefix/share/libquvi-scripts/$major_ver.$minor_ver/media/
  34
  35 Playlist scripts
  36 ~~~~~~~~~~~~~~~~
  37
  38 The playlist scripts are responsible for parsing the playlist
  39 properties. There is usually a playlist script for each supported
  40 website.
  41
  42 These scripts are typically installed at::
  43   $prefix/share/libquvi-scripts/$major_ver.$minor_ver/playlist/
  44
  45 Scan scripts
  46 ~~~~~~~~~~~~
  47
  48 The scan scripts are used to scan an URL for embedded media URLs.
  49
  50 These scripts are typically installed at::
  51   $prefix/share/libquvi-scripts/$major_ver.$minor_ver/scan/
  52
  53 Subtitlte scripts
  54 ~~~~~~~~~~~~~~~~~
  55
  56 The subtitle scripts are responsible for retrieving subtitle data for
  57 the media as well as exporting the data to another format, e.g. SubRip.
  58
  59 These scripts are typically installed at::
  60   $prefix/share/libquvi-scripts/$major_ver.$minor_ver/subtitle/
  61   $prefix/share/libquvi-scripts/$major_ver.$minor_ver/subtitle/export/
  62
  63 Utility scripts
  64 ~~~~~~~~~~~~~~~
  65
  66 The utility scripts are used by libquvi to perform misc. tasks, such as
  67 parsing file extension from a content-type, or converting HTML entities
  68 to UTF-8 characters.
  69
  70 These scripts are typically installed at::
  71   $prefix/share/libquvi-scripts/$major_ver.$minor_ver/util/
  72
  73 ENVIRONMENT
  74 -----------
  75
  76 LIBQUVI_SCRIPTS_VERBOSE::
  77   When defined, enables the output from any libquvi scripts using the
  78   debug facility ('quvi/debug' module).
  79
  80 SEE ALSO
  81 --------
  82 linkman:libquvi[3], linkman:quvi[1]
  83
  84 include::footer.txt[]