1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
'\" t
.\" Title: quvi-modules
.\" Author: [see the "Authors" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/30/2013
.\" Manual: libquvi-scripts Manual
.\" Source: libquvi-scripts 0.9.20131130
.\" Language: English
.\"
.TH "QUVI\-MODULES" "7" "11/30/2013" "libquvi\-scripts 0\&.9\&.20131" "libquvi\-scripts Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
quvi-modules \- Overview of the loadable quvi modules
.SH "DESCRIPTION"
.sp
\fIquvi\-modules\fR are a selection of importable modules implemented in Lua\&. These modules are intended to be loaded (\fIrequire\fR) from the \fBlibquvi-scripts\fR(7)\&.
.sp
Many of the modules are documented within the code\&. Refer to the individual modules for their detailed description of different available functions\&.
.PP
The modules are usually installed at
.RS 4
$prefix/share/libquvi\-scripts/$major_ver\&.$minor_ver/common/quvi/
.RE
.SH "MODULES"
.PP
quvi/http/cookie
.RS 4
A set of functions that wrap most of the quvi\&.http\&.cookie function features\&. See
\fBquvi-object\fR(7)\&.
.RE
.PP
quvi/const
.RS 4
Constants\&. Technically, (due to Lua language specification) these are not immutable values\&. The
\fIconstants\fR
are used to interact with libquvi, e\&.g\&. specifying function operation modes and checking for returned libquvi return codes\&.
.RE
.PP
quvi/debug
.RS 4
An message output facility intended to be used for debugging purposes\&. By
\fIdefault\fR, all output from scripts using this facility remain
\fIdisabled\fR\&. To enable the output, define the LIBQUVI_SCRIPTS_VERBOSE environment variable\&.
.RE
.PP
quvi/entity
.RS 4
HTML entity conversion module\&. Converts the
\fIstandard HTML entities\fR
(to ASCII), and any numeric HTML entities to UTF\-8 (using the
\fIquvi/html\fR
module)\&.
.RE
.PP
quvi/hash
.RS 4
Wrapper functions for some of the common hash (message digest) functions provided by the
\fBquvi-object\fR(7)\&. Note that these functions convert the given data into hexadecimal form before passing it to the hash functions\&.
.RE
.PP
quvi/hex
.RS 4
Functions for converting values from and to hexadecimal form\&. These are typically used together with the
\fBquvi-object\fR(7)
crypto functions\&.
.RE
.PP
quvi/html
.RS 4
Converts numeric HTML entities to UTF\-8\&. See also
\fIquvi/entity\fR, which uses this module\&.
.RE
.PP
quvi/lxph
.RS 4
LuaExpat wrapper/utility functions for parsing XML, see also
\fBquvi-modules-3rdparty\fR(7)\&.
.RE
.PP
quvi/stream
.RS 4
Media stream related functions\&.
.RE
.PP
quvi/time
.RS 4
Time related functions\&.
.RE
.PP
quvi/util
.RS 4
Misc\&. utility functions\&.
.RE
.PP
quvi/youtube
.RS 4
Functions common to YouTube\&.
.RE
.SH "SEE ALSO"
.sp
\fBlibquvi-scripts\fR(7), \fBlibquvi\fR(3), \fBquvi-object\fR(7), \fBquvi-modules-3rdparty\fR(7)
.SH "FURTHER RESOURCES"
.PP
Home
.RS 4
http://quvi\&.sourceforge\&.net/
.RE
.PP
Development code
.RS 4
git://repo\&.or\&.cz/libquvi\-scripts\&.git
.RE
.PP
gitweb
.RS 4
http://repo\&.or\&.cz/w/libquvi\-scripts\&.git
.RE
.SH "AUTHORS"
.PP
Toni Gundogdu <legatvs@gmail\&.com>
.RS 4
Author\&.
.RE
.SH "REPORTING BUGS"
.sp
Report bugs to the quvi\-devel mailing list <quvi\-devel@lists\&.sourceforge\&.net> where the development and the maintenance is primarily done\&. You do not have to be subscribed to the list to send a message there\&.
.SH "LICENSE"
.sp
libquvi\-scripts is Free Software licensed under the GNU Affero GPLv3+
.SH "LIBQUVI-SCRIPTS"
.sp
Part of the \fIlibquvi\-scripts(7)\fR suite
|