From 54e2bf3276a727a947a718026390e85b813dd5d6 Mon Sep 17 00:00:00 2001 From: Alexandre Erwin Ittner Date: Sun, 5 Sep 2010 23:49:14 -0300 Subject: [PATCH] Regenarate index page --- index.html | 101 ++++++++++++++++++++++++++++------------------------- 1 file changed, 53 insertions(+), 48 deletions(-) diff --git a/index.html b/index.html index 54ba95b..24948c1 100644 --- a/index.html +++ b/index.html @@ -46,21 +46,25 @@ use the first release (lua-iconv-r1).

Download and installation

Lua-iconv can be obtained from its LuaForge project page -(http://luaforge.net/projects/lua-iconv/) or from some Linux distributions -which already provide it (eg. Debian). +(http://luaforge.net/projects/lua-iconv/), from a LuaRocks server or from +some Linux distributions which already provide it (eg. Debian).

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: +your system. If you have LuaRocks installed, all the process is automatic; +just fire up your favourite shell and type, as root: +

+
    luarocks install lua-iconv
+
+

and the package will be downloaded from a rock server, installed and +configured. Otherwise, you must compile and install the package. In a system +with pkg-config (as many Linux distributions and Unix flavors) open a shell, +untar the distribution package and, within the program directory, type: 

    make install
-
-

The library will be compiled and installed on the in the correct path (which -is defined in lua5.1.pc). -

-

Compiling on systems without pkg-config requires manual changes in the -Makefile. + +

as root. The library will be compiled and installed on the in the correct +path (which is defined in lua5.1.pc). Compiling on systems without pkg-config +requires manual changes in the Makefile (this includes Windows).

@@ -70,79 +74,80 @@ Makefile. before use. From Lua 5.1 and later, you can simply do a 

    require "iconv"
-
-

call to load up the library (that, of course, must be installed in a + +

call to load up the library (that, of course, must be installed in a directory from package.cpath).

API documentation

-

iconv.new(to, from)

-

iconv.open(to, from)

+
  cd = iconv.new(to, from)
+  cd = iconv.open(to, from)
 
-
    Opens a new conversion descriptor, from the 'from' charset to the
+    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.
-

-
    This function returns a new converter or nil on error.
-

 
-
cd:iconv(str)

+    This function returns a new converter or nil on error.
 
-
    Converts the 'str' string to the desired charset. This method always
+
+  nstr, err = cd:iconv(str)
+
+    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:
-

-
    nil
-        No error. Conversion was successful.
-

-
    iconv.ERROR_NO_MEMORY
-        Failed to allocate enough memory in the conversion process.
-

-
    iconv.ERROR_INVALID
-        An invalid character was found in the input sequence.
-

-
    iconv.ERROR_INCOMPLETE
-        An incomplete character was found in the input sequence.
-

-
    iconv.ERROR_UNKNOWN
-        There was an unknown error.
-

 
-
License

+    nil
+        No error. Conversion was successful.
+
+    iconv.ERROR_NO_MEMORY
+        Failed to allocate enough memory in the conversion process.
+
+    iconv.ERROR_INVALID
+        An invalid character was found in the input sequence.
+
+    iconv.ERROR_INCOMPLETE
+        An incomplete character was found in the input sequence.
+
+    iconv.ERROR_UNKNOWN
+        There was an unknown error.
+
+
+

License

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: 

   Lua-iconv is (c) 2005-10 Alexandre Erwin Ittner
-
-
   Permission is hereby granted, free of charge, to any person obtaining
+
+   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:
-
-
   The above copyright notice and this permission notice shall be
+
+   The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
-
-
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+
+   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.
-
-
   If you use this package in a product, an acknowledgment in the product
-   documentation would be greatly appreciated (but it is not required).
-
+ If you use this package in a product, an acknowledgment in the product + documentation would be greatly appreciated (but it is not required). + + +

Contact