*** empty log message ***
[m17n/m17n-docs.git] / data-usr / mainpage.c
1 /***en
2     @mainpage The m17n library documentation
3
4     @section what What is the m17n library?
5
6     The @e m17n @e library is a multilingual text processing library
7     for the C language.
8
9     <ul>
10
11     <li> It is an open source software.
12
13     <li> It is for any GNU/Linux and Unix applications/libraries.
14
15     <li> It realizes multilingualization of many aspects of
16     applications/libraries.
17  
18     </ul> 
19
20     The word "m17n" is an abbreviation of "multilingualization".
21
22     The m17n library provides following facilities to handle
23     multilingual text.
24
25     <ul>
26
27     <li> @e M-text: A data structure for a multilingual text.  It is
28     basically a string but with attributes called text property, and
29     is designed to substitute for the C string.
30
31     <li> Functions for creating and processing M-texts.
32
33     <li> Functions for converting M-texts from/to strings encoded in
34     various existing formats.
35
36     <li> A huge character space, which contains all the Unicode
37     characters and more non-Unicode characters.
38
39     <li> @e Chartable: A data structure that contains per-character
40     information efficiently.
41
42     <li> Functions for inputting and displaying M-text on a window
43     system.
44
45     </ul>
46
47     @section usage How to use it?
48
49     Just include <m17n.h> in your program, and link it with the m17n
50     library by -lm17n.  See the documentation of the module \link
51     m17nIntro Introduction \endlink for the detail.
52
53     @section contact Contact us:
54
55     Global IT Security Group\n
56     Information Technology Research Institute\n
57     Institute of Advanced Industrial Science and Technology
58
59     E-mail: mule-aist@m17n.org 
60
61 */
62 ////