doc/man7/quvi-modules.7.txt

   1 quvi-modules(7)
   2 ===============
   3
   4 NAME
   5 ----
   6 quvi-modules - Overview of the loadable quvi modules
   7
   8 DESCRIPTION
   9 -----------
  10 'quvi-modules' are a selection of importable modules implemented in Lua.
  11 These modules are intended to be loaded ('require') from the
  12 'libquvi-scripts(7)'.
  13
  14 Many of the modules are documented within the code. Refer to the
  15 individual modules for their detailed description of different
  16 available functions.
  17
  18 The modules are usually installed at::
  19   $prefix/share/libquvi-scripts/$major_ver.$minor_ver/common/quvi/
  20
  21 MODULES
  22 -------
  23
  24 quvi/const::
  25   Constants. Technically, (due to Lua language specification) these
  26   are not immutable values. These constants are used widely for
  27   interacting with libquvi.
  28
  29 quvi/debug::
  30   An message output facility intended to be used for debugging purposes.
  31   By 'default', all output from scripts using this facility remain
  32   'disabled'. To enable the output, define the LIBQUVI_SCRIPTS_VERBOSE
  33   environment variable.
  34
  35 quvi/entity::
  36   HTML entity conversion module. Converts the 'standard HTML entities'
  37   (to ASCII), and any numeric HTML entities to UTF-8 (using
  38   the 'quvi/html' module).
  39
  40 quvi/hash::
  41   Wrapper functions for some of the common hash (message digest)
  42   functions provided by the 'quvi-object(7)'. Note that these functions
  43   convert the given data into hexadecimal form before passing it to the
  44   hash functions.
  45
  46 quvi/hex::
  47   Functions for converting values from and to hexadecimal form. These are
  48   typically used together with the 'quvi-object(7)' crypto functions.
  49
  50 quvi/html::
  51   Converts numeric HTML entities to UTF-8. See also 'quvi/entity', which
  52   uses this module.
  53
  54 quvi/lxph::
  55   LuaExpat wrapper/utility functions for parsing XML, see also
  56   'quvi-modules-3rdparty(7)'.
  57
  58 quvi/stream::
  59   Media stream related functions.
  60
  61 quvi/util::
  62   Misc. utility functions.
  63
  64 quvi/youtube::
  65   Functions common to YouTube.
  66
  67 Authors
  68 -------
  69 Toni Gundogdu <legatvs@gmail.com>::
  70   Author.
  71
  72 Reporting bugs
  73 --------------
  74 Report bugs to the quvi-devel mailing list
  75 <quvi-devel@lists.sourceforge.net> where the development and the
  76 maintenance is primarily done.  You do not have to be subscribed
  77 to the list to send a message there.
  78
  79 LICENSE
  80 -------
  81 libquvi is Free Software licensed under the GNU Affero GPLv3+
  82
  83 SEE ALSO
  84 --------
  85 'libquvi-scripts(7)', 'libquvi(3)', 'quvi-object(7)',
  86 'quvi-modules-3rdparty(7)'
  87
  88 LIBQUVI-SCRIPTS
  89 ---------------
  90 Part of the 'libquvi-scripts(7)' suite