02e391562dfa054482f50b27f8114ec9a2ea1fa0
[m17n/m17n-pango.git] / README
1 This directory tree holds version 0.9.0 of m17n-pango.  -*- text -*-
2
3 Copyright (C) 2006
4   National Institute of Advanced Industrial Science and Technology (AIST)
5   Registration Number H15PRO112
6 See the end for copying conditions.
7
8 This package "m17n-pango" provides a Pango shaping module for various
9 scripts that requires CTL (Complex Text Layout) language.  It utilizes
10 the rendering capability of the m17n library.
11
12
13 (1) INSTALLATION
14
15 (1-1) From CVS working directory.
16
17 Run the script "bootstrap.sh" in this directory.  It is tested that
18 the script run successfully with these versions of autotools.
19
20         libtool-1.5.6
21         automake-1.9.5
22         autoconf-2.59
23
24 Then, proceed to the next step.
25
26 (1-2) From the tarball.
27
28 It requires Pango (ver.1.4 or the later) and the m17n library
29 (ver.1.3.3 or the later).
30
31 Type the followings on the command line.
32
33         % ./configure
34         % make
35         % make install
36
37 The default installation path is "/usr/local".
38 Thus, this loadable module is installed in /usr/local/lib/m17n-pango/1.4.0/modules
39         m17n-core.h, m17n.h, m17n-gui.h, m17n-err.h, m17n-X.h
40 These library files are installed in /usr/local/lib:
41         libm17n-core.{a,so*,la}
42         libm17n.{a,so*,la}
43         libm17n-gui.{a,so*,la}
44         libm17n-X.{a,so*,la}
45         libm17n-gd.{a,so*,la}
46         libimx-anthy.{a,so*,la},
47         libimx-ispell.{a,so*,la},
48 This shell script is installed in /usr/local/bin:
49         m17n-config
50 These sample programs are installed in /usr/local/bin too:
51         m17n-conv, m17n-date, m17n-view, m17n-dump, m17n-edit
52
53 If you don't need GUI libraries (libm17n-gui.so and etc.), you can
54 instruct the `configure' script not to build them as below:
55
56         % ./configure --without-gui
57
58 This file under `example' sub-directory is a Japanese resource file
59 for m17n-edit.  It is not installed but useful in Japanese locale.  Copy
60 it to your home directory (or, for instance,
61 /usr/X11R6/lib/X11/ja/app-defaults) and rename it to "M17NEdit" if you
62 want to see labels in Japanese:
63         M17NEdit.ja
64
65 These text files under `example' sub-directory are not installed but
66 useful for testing the rendering engine of the m17n library:
67         HELLO.utf8 HELLO.xml HELLO-ja.utf8 HELLO-ja.xml HELLO.html
68 XXX.xml are generated from XXX.utf8 by attaching text property
69 `language' and serializing.
70
71 Please read also INSTALL for the generic installation instructions.
72
73
74 (2) DATABASE
75
76 The m17n library utilizes the m17n database available at:
77         http://www.m17n.org/m17n-lib/m17n-db
78 Without this database, the m17n library loses half its value.  Please
79 install it (Ver.1.3.3 or the later is required) too before you try the
80 above sample programs or develop a program that uses the m17n library.
81
82
83 (3) DOCUMENTATION
84
85 This page has a link to full documentation of the m17n library:
86         http://www.m17n.org/m17n-lib
87
88 Actually, the documentation was generated by Doxygen using comments in
89 the source files.  There are English and Japanese comments in
90 parallel.
91
92
93 (4) USAGE
94
95 The library provides three levels of APIs, CORE, SHELL, and GUI.  For
96 CORE API, include <m17n-core.h>, for SHELL API, include <m17n.h>, and
97 for GUI API, include <m17n-gui.h >.  See the documentation above, or
98 the manual of m17nIntro(3) for more detail.
99
100 The shell script "m17n-config" helps compiling and linking of a
101 program that uses the m17n library.  For instance this compiles PROG.c
102 that uses SHELL API and builds executable PROG.
103
104         % gcc -o PROG `m17n-config --cflags` `m17n-config --libs` PROG.c
105
106 This compiles PROX.c that uses GUI API and builds executable PROX.
107
108         % gcc -o PROX `m17n-config GUI --cflags` `m17n-config GUI --libs` PROX.c
109
110
111 ----------------------------------------------------------------------
112 Copyright information
113
114 Copyright (C) 2006
115   National Institute of Advanced Industrial Science and Technology (AIST)
116   Registration Number H15PRO112
117
118 This file is part of m17n-pango; a sub-part of the m17n library.
119
120 The m17n library is free software; you can redistribute it and/or
121 modify it under the terms of the GNU Lesser General Public License
122 as published by the Free Software Foundation; either version 2.1 of
123 the License, or (at your option) any later version.
124
125 The m17n library is distributed in the hope that it will be useful,
126 but WITHOUT ANY WARRANTY; without even the implied warranty of
127 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
128 Lesser General Public License for more details.
129
130 You should have received a copy of the GNU Lesser General Public
131 License along with the m17n library; if not, write to the Free
132 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
133 02111-1307, USA.