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 linkman: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/http/cookie::
  25   A set of functions that wrap most of the quvi.http.cookie function
  26   features. See linkman:quvi-object[7].
  27
  28 quvi/const::
  29   Constants. Technically, (due to Lua language specification) these are
  30   not immutable values. The 'constants' are used to interact with
  31   libquvi, e.g. specifying function operation modes and checking for
  32   returned libquvi return codes.
  33
  34 quvi/debug::
  35   An message output facility intended to be used for debugging purposes.
  36   By 'default', all output from scripts using this facility remain
  37   'disabled'. To enable the output, define the LIBQUVI_SCRIPTS_VERBOSE
  38   environment variable.
  39
  40 quvi/entity::
  41   HTML entity conversion module. Converts the 'standard HTML entities'
  42   (to ASCII), and any numeric HTML entities to UTF-8 (using the
  43   'quvi/html' module).
  44
  45 quvi/hash::
  46   Wrapper functions for some of the common hash (message digest)
  47   functions provided by the linkman:quvi-object[7]. Note that these
  48   functions convert the given data into hexadecimal form before passing
  49   it to the hash functions.
  50
  51 quvi/hex::
  52   Functions for converting values from and to hexadecimal form. These
  53   are typically used together with the linkman:quvi-object[7] crypto
  54   functions.
  55
  56 quvi/html::
  57   Converts numeric HTML entities to UTF-8. See also 'quvi/entity', which
  58   uses this module.
  59
  60 quvi/lxph::
  61   LuaExpat wrapper/utility functions for parsing XML, see also
  62   linkman:quvi-modules-3rdparty[7].
  63
  64 quvi/stream::
  65   Media stream related functions.
  66
  67 quvi/time::
  68   Time related functions.
  69
  70 quvi/util::
  71   Misc. utility functions.
  72
  73 quvi/youtube::
  74   Functions common to YouTube.
  75
  76 SEE ALSO
  77 --------
  78 linkman:libquvi-scripts[7], linkman:libquvi[3], linkman:quvi-object[7],
  79 linkman:quvi-modules-3rdparty[7]
  80
  81 include::footer.txt[]