$Header: /data/cvsroot/mail/elmme+/shared_libs/iconv/README.ME+,v 1.5 2001/10/31 18:23:34 hurtta Exp $

Shared library
==============

Shared library libelmme-iconv.so provides interface to GNU LIBICONV 
(character set conversion library). Library libelmme-iconv.so defines
charset type with name "iconv". Charset type "iconv" uses unicode
internally (on most of times) as representation of string.

Functions iconv_open(), iconv() and iconv_close() can be used. 
If system library provides these functions, it is possible to compile 
libelmme-tls.so without GNU LIBICONV library. However that does not
work if implementation does not able convert from/to Unicode (namely
UCS-2BE or UCS-2 charset -- UCS-2 is assumed to be same as UCS-2BE).

System libary implementation works on IRIX 6.5 and Linux with some
glibc.

To use that library add "iconv" to "use-library" -elmrc option. For example

use-library = iconv

"use-library" keyword may also list other librariers. If there is any other
library and you just give

use-library = iconv

that removes other libraries from use.

elm.mimecharsets Config file
============================

Files libdir/elm.mimecharsets and ~/.elm/mime.charsets can be used
to define that define that some MIME charset should be handled with
libelmme-tls.so library. On that case define that charset to have
type iconv.

For example

-       KOI8-RU;type=iconv

If MIME-name and name used by GNU LIBICONV library is different, name
used by GNU LIBICONV library can be given with map -argument.

For example

-	KOI8-RU;type=iconv;map=KOI8-RU


Shared library libelmme-tls.so requires that for given
charset iconv() routine is able to do conversion

WARNING: Do not define system or display charset to have type "iconv".
         Shared library libelmme-tls.so does not able to provide
         necessary functionality for cahrsets which are used as
         keyboard input.

elm.rc Config file
==================

Files libdir/elm.rc and ~/.elm/.elmrc
can be used specify some libelmme-iconv.so parameters.
These is ince such parameter

    auto-charset

"rand-charset" paramater tells  that library should automatically
define charset, if librray knows conversion from that charset name
to Unicode (namely UCS-2BE (or UCS-2) charset).

Section of these paramaters names to be prefixed with library
tag (ie. "iconv:"). Shared library specific parameters go after
other parameters on config file.  For example

iconv:
auto-charset = ON

WARNING: Some care should be taken so that system or display charset
         does not result to have type "iconv".



