Use -x none when using gcc.
[libiconv.git] / README
blobade2c477305aad8af7076a0357bc702cbe3f54e7
1             GNU LIBICONV - character set conversion library
3 This library provides an iconv() implementation, for use on systems which
4 don't have one, or whose implementation cannot convert from/to Unicode.
6 It provides support for the encodings:
8     European languages
9         ASCII, ISO-8859-{1,2,3,4,5,7,9,10,13,14,15,16},
10         KOI8-R, KOI8-U, KOI8-RU,
11         CP{1250,1251,1252,1253,1254,1257}, CP{850,866},
12         Mac{Roman,CentralEurope,Iceland,Croatian,Romania},
13         Mac{Cyrillic,Ukraine,Greek,Turkish},
14         Macintosh
15     Semitic languages
16         ISO-8859-{6,8}, CP{1255,1256}, CP862, Mac{Hebrew,Arabic}
17     Japanese
18         EUC-JP, SHIFT-JIS, CP932, ISO-2022-JP, ISO-2022-JP-2, ISO-2022-JP-1
19     Chinese
20         EUC-CN, HZ, GBK, GB18030, EUC-TW, BIG5, CP950, BIG5-HKSCS,
21         ISO-2022-CN, ISO-2022-CN-EXT
22     Korean
23         EUC-KR, CP949, ISO-2022-KR, JOHAB
24     Armenian
25         ARMSCII-8
26     Georgian
27         Georgian-Academy, Georgian-PS
28     Thai
29         TIS-620, CP874, MacThai
30     Laotian
31         MuleLao-1, CP1133
32     Vietnamese
33         VISCII, TCVN, CP1258
34     Platform specifics
35         HP-ROMAN8, NEXTSTEP
36     Full Unicode
37         UTF-8
38         UCS-2, UCS-2BE, UCS-2LE
39         UCS-4, UCS-4BE, UCS-4LE
40         UTF-16, UTF-16BE, UTF-16LE
41         UTF-32, UTF-32BE, UTF-32LE
42         UTF-7
43         JAVA
44     Full Unicode, in terms of `uint16_t' or `uint32_t'
45         (with machine dependent endianness and alignment)
46         UCS-2-INTERNAL, UCS-4-INTERNAL
47     Locale dependent, in terms of `char' or `wchar_t'
48         (with machine dependent endianness and alignment, and with OS and
49         locale dependent semantics)
50         char, wchar_t
51         The empty encoding name "" is equivalent to "char": it denotes the
52         locale dependent character encoding.
54 It can convert from any of these encodings to any other, through Unicode
55 conversion.
57 It has also some limited support for transliteration, i.e. when a character
58 cannot be represented in the target character set, it can be approximated
59 through one or several similarly looking characters. Transliteration is
60 activated when "//TRANSLIT" is appended to the target encoding name.
62 libiconv is for you if your application needs to support multiple character
63 encodings, but that support lacks from your system.
65 Installation:
67 As usual for GNU packages:
69     $ ./configure --prefix=/usr/local
70     $ make
71     $ make install
73 This library can be built and installed in two variants:
75   - The library mode. This works on all systems, and uses a library
76     `libiconv.so' and a header file `<iconv.h>'. (Both are installed
77     through "make install".)
79     To use it, simply #include <iconv.h> and use the functions.
81     To use it in an autoconfiguring package:
82     - If you don't use automake, append extras/iconv.m4 to your aclocal.m4
83       file.
84     - If you do use automake, add extras/iconv.m4 to your m4 macro repository.
85     Note that 'iconv.m4' is also part of the GNU gettext package, which
86     installs it in /usr/local/share/aclocal/iconv.m4.
88   - The libc plug/override mode. This works on GNU/Linux, Solaris and OSF/1
89     systems only. It is a way to get good iconv support without having
90     glibc-2.1.
91     It installs a library `libiconv_plug.so'. This library can be used with
92     LD_PRELOAD, to override the iconv* functions present in the C library.
94     On GNU/Linux and Solaris:
95         $ export LD_PRELOAD=/usr/local/lib/libiconv_plug.so
97     On OSF/1:
98         $ export _RLD_LIST=/usr/local/lib/libiconv_plug.so:DEFAULT
100     A program's source need not be modified, the program need not even be
101     recompiled. Just set the LD_PRELOAD environment variable, that's it!
104 Distribution:
105     ftp://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.7.tar.gz
106     ftp://ftp.ilog.fr/pub/Users/haible/gnu/libiconv-1.7.tar.gz
108 Homepage:
109     http://clisp.cons.org/~haible/packages-libiconv.html
111 Bug reports to:
112     <bug-gnu-libiconv@gnu.org>
115 Bruno Haible <haible@clisp.cons.org>