dany/lua-iconv
1
0
Fork 0
mirror of https://github.com/lunarmodules/lua-iconv.git synced 2025-06-23 04:34:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Import GitHub pages

Browse Source
This commit is contained in:
Alexandre Erwin Ittner 2010-09-05 22:03:26 -03:00
commit 8a60d39ece
3 changed files with 251 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

164
index.html Normal file
View File

@ -0,0 +1,164 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<!-- Generated code, do not edit! -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" >
<head>
<title>Lua-iconv, Lua bindings for the iconv library</title>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
<meta name="Language" content="en" />
<meta name="Author" content="Alexandre Erwin Ittner" />
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<h1> Lua iconv </h1>
<div id="menu">
<h2>Contents</h2>
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#download-and-installation">Download and installation</a></li>
<li><a href="#loading-and-initialization">Loading and initialization</a></li>
<li><a href="#api-documentation">API</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
</ul>
</div>
<!-- Begin of HTML generated from README -->
<h2 id="introduction">Introduction</h2>
<p>Lua-iconv is POSIX 'iconv' binding for the Lua Programming Language. The
iconv library converts a sequence of characters from one codeset into a
sequence of corresponding characters in another codeset. The codesets
are those specified in the iconv.new() call that returned the conversion
descriptor, cd.
</p>
<p>Lua-iconv 6 and later *requires* Lua 5.1. If you are using Lua 5.0, please
use the first release (lua-iconv-r1).
</p>
<p>Details on iconv may be obtained in the Open Group's interface definition
(<a href="http://www.opengroup.org/onlinepubs/007908799/xsh/iconv.h.html">http://www.opengroup.org/onlinepubs/007908799/xsh/iconv.h.html</a>).
</p>
<h2 id="download-and-installation">Download and installation</h2>
<p>Lua-iconv can be obtained from its LuaForge project page
(<a href="http://luaforge.net/projects/lua-iconv/">http://luaforge.net/projects/lua-iconv/</a>) or from some Linux distributions
which already provide it (eg. Debian).
</p>
<p>Unless you downloaded a compiled package, you must build the library for
your system. If you are using a system with pkg-config (as many Linux
distributions and Unix flavors) just fire up your favourite shell, untar
the distribution package and type, as root, within the program directory:
</p>
<pre> make install
</pre>
<p>The library will be compiled and installed on the in the correct path (which
is defined in lua5.1.pc).
</p>
<p>Compiling on systems without pkg-config requires manual changes in the
Makefile.
</p>
<h2 id="loading-and-initialization">Loading and initialization</h2>
<p>Lua-iconv is a shared library that must be loaded in the Lua interpreter
before use. From Lua 5.1 and later, you can simply do a
</p>
<pre> require "iconv"
</pre>
<p>call to load up the library (that, of course, must be installed in a
directory from package.cpath).
</p>
<h2 id="api-documentation">API documentation</h2>
<h4 id="iconvnewto-from">iconv.new(to, from)</h4>
<h4 id="iconvopento-from">iconv.open(to, from)</h4>
<pre> Opens a new conversion descriptor, from the 'from' charset to the
'to' charset. Concatenating "//TRANSLIT" to the first argument will
enable character transliteration and concatenating "//IGNORE" to
the first argument will cause iconv to ignore any invalid characters
found in the input string.
</pre>
<pre> This function returns a new converter or nil on error.
</pre>
<h4 id="cdiconvstr">cd:iconv(str)</h4>
<pre> Converts the 'str' string to the desired charset. This method always
returns two arguments: the converted string and an error code, which
may have any of the following values:
</pre>
<pre> nil
No error. Conversion was successful.
</pre>
<pre> iconv.ERROR_NO_MEMORY
Failed to allocate enough memory in the conversion process.
</pre>
<pre> iconv.ERROR_INVALID
An invalid character was found in the input sequence.
</pre>
<pre> iconv.ERROR_INCOMPLETE
An incomplete character was found in the input sequence.
</pre>
<pre> iconv.ERROR_UNKNOWN
There was an unknown error.
</pre>
<h2 id="license">License</h2>
<p>Lua-iconv is copyrighted free software: it can be used for both academic
and commercial purposes at absolutely no cost. There are no royalties
or GNU-like "copyleft" restrictions. The legal details are below:
</p>
<pre> Lua-iconv is (c) 2005-10 Alexandre Erwin Ittner
</pre>
<pre> Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject
to the following conditions:
</pre>
<pre> The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
</pre>
<pre> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHOR OR COPYRIGHT HOLDER BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
</pre>
<pre> If you use this package in a product, an acknowledgment in the product
documentation would be greatly appreciated (but it is not required).
</pre>
<!-- End of HTML generated from README -->
<h2 id="contact">Contact</h2>
<dl class="prop-list">
<dt>Author:</dt>
<dd>Alexandre Erwin Ittner</dd>
<dt>E-mail:</dt>
<dd><a href="mailto:alexandre#ittner.com.br">alexandre<strong>#</strong>ittner.com.br</a> (e-mail obfuscated to avoid spam-bots. Please replace the "#" with an "@")</dd>
<dt>PGP Key:</dt>
<dd><a href="http://www.ittner.com.br/AlexandreErwinIttner.pub.asc">0x0041A1FB</a> (key fingerprint: <code>9B49 FCE2 E6B9 D1AD 6101 29AD 4F6D F114 0041 A1FB</code>)</dd>
<dt>Homepage:</dt>
<dd><a href="http://www.ittner.com.br/">http://www.ittner.com.br/</a></dd>
</dl>
</body>
</html>

BIN
lua-iconv-logo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

87
style.css Normal file
View File

@ -0,0 +1,87 @@
body {
background: #ffffff;
font-size: 10pt;
color: #000000;
font-family: "Bitstream Vera Sans", "DejaVu Sans", Verdana, sans-serif;
margin: 1em;
}
kbd, code {
font-family: "Bitstream Vera Sans Mono", "DejaVu Sans Mono", monospaced;
}
kbd {
background-color: #dddddd;
}
a {
text-decoration: none;
}
a:link {
color: #0000ff;
}
a:visited {
color: #aa00aa;
}
a:hover {
text-decoration: underline;
color: #ff0000;
}
img {
border: none;
}
#menu {
text-align: center;
}
#menu h2 {
display: none;
}
#menu ul {
list-style-type: none;
}
#menu ul li {
display: inline;
margin-left: 1em;
margin-right: 1em;
}
h1 {
background: url(lua-iconv-logo.png) no-repeat center bottom;
height: 160px;
text-align: center;
font-size: 2em;
}
h2, h3 {
font-weight: bold;
}
h2 {
margin-top: 2em;
font-size: 1.5em;
width: 100%;
border-bottom: 1px solid #cacaea;
}
h3 {
font-size: 1.15em;
}
dl.prop-list dt {
float: left;
width: 6em;
}
dl.prop-list dd {
margin-left: 7em;
}