This directory tree holds version 0.9 of the m17n library. -*- text -*- Copyright (C) 2003, 2004 National Institute of Advanced Industrial Science and Technology (AIST) Registration Number H15PRO112 See the end for copying conditions. The m17n library is a multilingual text processing library for the C language. (1) INSTALLATION (1-1) From CVS working directory. Run the script "bootstrap.sh" in this directory. It is tested that the script run successfully with these versions of auto tools. libtool-1.4 automake-1.4p5 autoconf-2.52 Then, proceed to the next step. (1-2) From the tarball. The m17n library utilizes these extra libraries. It is recommened to install them before running the "configure" script. The script will find out the existence of them automatically. libxml2 -- http://xmlsoft.org/ fribidi -- http://fribidi.sourceforge.net/ freetype -- http://www.freetype.org/ libotf -- http://www.m17n.org/libotf/ The sample program medit utilizes this Japanese inputting system. It is also recommened to install it. anthy -- http://anthy.sourceforge.jp/ The sample program medit and mdump utilize this Thai word-boundary finder. It is also recommened to install it. wordcut -- http://thaiwordseg.sourceforge.net/ Then, type the followings on the command line. % ./configure % make % make install Note that this package assumes an ANSI C compiler such as gcc. It will not compile with an old-style K&R compiler. The default installation path is "/usr/local". Thus, these header files are installed in /usr/local/include: m17n.h, m17n-core.h, m17n-gui.h, m17n-err.h, m17n-X.h These library files are installed in /usr/local/lib: libm17n.{a,so,la} libm17n-core.{a,so,la} libm17n-X.{a,so,la} libimx-anthy.{a,so,la}, libimx-ispell.{a,so,la}, This shell script is installed in /usr/local/bin: m17n-config These sample programs are installed in /usr/local/bin too: mconv, mdate, mview, mdump, medit This file under `example' sub-directory is a Japanese resource file for medit. It is not installed but useful in Japanese locale. Copy it to your home directory (or, for instance, /usr/X11R6/lib/X11/ja/app-defaults) and rename it to "MEdit" if you want to see labels in Japanese: MEdit.ja These text files under `example' sub-directory are not installed but useful for testing the rendering engine of the m17n library: HELLO.utf8 HELLO.xml HELLO-ja.utf8 HELLO-ja.xml XXX.xml are generated from XXX.utf8 by attaching text property `langauge' and serializing. Please read also INSTALL for the generic installation instructions. (2) DATABASE The m17n library utilizes the m17n database avairable at: http://www.m17n.org/m17n-lib/m17n-db Without this database, the m17n library loses half its value. Please install it too before you try the above sample programs or develop a program that uses the m17n library. (3) DOCUMENTATION This page has a link to full documentaion of the m17n library: http://www.m17n.org/m17n-lib Actually, the documentation was generated by Doxygen using comments in the source files. There are English and Japanese comments in parallel, but plese note that Japanese comments are not updated for long. (4) USAGE The library provides three levels of APIs, CORE, SHELL, and GUI. For CORE API, include , for SHELL API, include , and for GUI API, include and . See the documementation above, or the manual of m17nIntro(3) for more detail. The shell script "m17n-config" helps compiling and linking of a program that uses the m17n library. For instance this compiles PROG.c that uses SHELL API and builds executable PROG. % gcc -o PROG `m17n-config --clags` `m17n-config --libs` PROG.c ---------------------------------------------------------------------- Copyright information Copyright (C) 2003, 2004 National Institute of Advanced Industrial Science and Technology (AIST) Registration Number H15PRO112 This file is part of the m17n library. The m17n library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. The m17n library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with the m17n library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.