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/http/cookie::
  25   A set of functions that wrap most of the quvi.http.cookie function
  26   features. See '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
  43   the 'quvi/html' module).
  44
  45 quvi/hash::
  46   Wrapper functions for some of the common hash (message digest)
  47   functions provided by the 'quvi-object(7)'. Note that these functions
  48   convert the given data into hexadecimal form before passing it to the
  49   hash functions.
  50
  51 quvi/hex::
  52   Functions for converting values from and to hexadecimal form. These are
  53   typically used together with the 'quvi-object(7)' crypto functions.
  54
  55 quvi/html::
  56   Converts numeric HTML entities to UTF-8. See also 'quvi/entity', which
  57   uses this module.
  58
  59 quvi/lxph::
  60   LuaExpat wrapper/utility functions for parsing XML, see also
  61   'quvi-modules-3rdparty(7)'.
  62
  63 quvi/stream::
  64   Media stream related functions.
  65
  66 quvi/util::
  67   Misc. utility functions.
  68
  69 quvi/youtube::
  70   Functions common to YouTube.
  71
  72 Authors
  73 -------
  74 Toni Gundogdu <legatvs@gmail.com>::
  75   Author.
  76
  77 Reporting bugs
  78 --------------
  79 Report bugs to the quvi-devel mailing list
  80 <quvi-devel@lists.sourceforge.net> where the development and the
  81 maintenance is primarily done.  You do not have to be subscribed
  82 to the list to send a message there.
  83
  84 LICENSE
  85 -------
  86 libquvi is Free Software licensed under the GNU Affero GPLv3+
  87
  88 SEE ALSO
  89 --------
  90 'libquvi-scripts(7)', 'libquvi(3)', 'quvi-object(7)',
  91 'quvi-modules-3rdparty(7)'
  92
  93 LIBQUVI-SCRIPTS
  94 ---------------
  95 Part of the 'libquvi-scripts(7)' suite