README

   1 This directory tree holds version 0.9 of the m17n library.      -*- text -*-
   2
   3 Copyright (C) 2003, 2004
   4   National Institute of Advanced Industrial Science and Technology (AIST)
   5   Registration Number H15PRO112
   6 See the end for copying conditions.
   7
   8 The m17n library is a multilingual text processing library for the C
   9 language.
  10
  11 (1) INSTALLATION
  12
  13 (1-1) From CVS working directory.
  14
  15 Run the script "bootstrap.sh" in this directory.  It is tested that
  16 the script run successfully with these versions of auto tools.
  17
  18         libtool-1.4
  19         automake-1.4p5
  20         autoconf-2.52
  21
  22 Then, proceed to the next step.
  23
  24 (1-2) From the tarball.
  25
  26 The m17n library utilizes these extra libraries.  It is recommened to
  27 install them before running the "configure" script.  The script will
  28 find out the existence of them automatically.
  29
  30         libxml2         -- http://xmlsoft.org/
  31         fribidi         -- http://fribidi.sourceforge.net/
  32         freetype        -- http://www.freetype.org/
  33         libotf          -- http://www.m17n.org/libotf/
  34
  35 The sample program medit utilizes this Japanese inputting system.  It
  36 is also recommened to install it.
  37
  38         anthy           -- http://anthy.sourceforge.jp/
  39
  40 The sample program medit and mdump utilize this Thai word-boundary
  41 finder.  It is also recommened to install it.
  42
  43         wordcut         -- http://thaiwordseg.sourceforge.net/
  44
  45 Then, type the followings on the command line.
  46
  47         % ./configure
  48         % make
  49         % make install
  50
  51 Note that this package assumes an ANSI C compiler such as gcc.  It
  52 will not compile with an old-style K&R compiler.
  53
  54 The default installation path is "/usr/local".
  55 Thus, these header files are installed in /usr/local/include:
  56         m17n.h, m17n-core.h, m17n-gui.h, m17n-err.h, m17n-X.h
  57 These library files are installed in /usr/local/lib:
  58         libm17n.{a,so,la}
  59         libm17n-core.{a,so,la}
  60         libm17n-X.{a,so,la}
  61         libimx-anthy.{a,so,la},
  62         libimx-ispell.{a,so,la},
  63 This shell script is installed in /usr/local/bin:
  64         m17n-config
  65 These sample programs are installed in /usr/local/bin too:
  66         mconv, mdate, mview, mdump, medit
  67
  68 This file under `example' sub-directory is a Japanese resource file
  69 for medit.  It is not installed but useful in Japanese locale.  Copy
  70 it to your home directory (or, for instance,
  71 /usr/X11R6/lib/X11/ja/app-defaults) and rename it to "MEdit" if you
  72 want to see labels in Japanese:
  73         MEdit.ja
  74
  75 These text files under `example' sub-directory are not installed but
  76 useful for testing the rendering engine of the m17n library:
  77         HELLO.utf8 HELLO.xml HELLO-ja.utf8 HELLO-ja.xml
  78 XXX.xml are generated from XXX.utf8 by attaching text property
  79 `langauge' and serializing.
  80
  81 Please read also INSTALL for the generic installation instructions.
  82
  83
  84 (2) DATABASE
  85
  86 The m17n library utilizes the m17n database avairable at:
  87         http://www.m17n.org/m17n-lib/m17n-db
  88 Without this database, the m17n library loses half its value.  Please
  89 install it too before you try the above sample programs or develop a
  90 program that uses the m17n library.
  91
  92
  93 (3) DOCUMENTATION
  94
  95 This page has a link to full documentaion of the m17n library:
  96         http://www.m17n.org/m17n-lib
  97
  98 Actually, the documentation was generated by Doxygen using comments in
  99 the source files.  There are English and Japanese comments in
 100 parallel, but plese note that Japanese comments are not updated for
 101 long.
 102
 103 (4) USAGE
 104
 105 The library provides three levels of APIs, CORE, SHELL, and GUI.  For
 106 CORE API, include <m17n-core.h>, for SHELL API, include <m17n.h>, and
 107 for GUI API, include <m17n-gui.h> and <m17n-X.h>.  See the
 108 documementation above, or the manual of m17nIntro(3) for more detail.
 109
 110 The shell script "m17n-config" helps compiling and linking of a
 111 program that uses the m17n library.  For instance this compiles PROG.c
 112 that uses SHELL API and builds executable PROG.
 113
 114         % gcc -o PROG `m17n-config --clags` `m17n-config --libs` PROG.c
 115
 116 ----------------------------------------------------------------------
 117 Copyright information
 118
 119 Copyright (C) 2003, 2004
 120   National Institute of Advanced Industrial Science and Technology (AIST)
 121   Registration Number H15PRO112
 122
 123 This file is part of the m17n library.
 124
 125 The m17n library is free software; you can redistribute it and/or
 126 modify it under the terms of the GNU Lesser General Public License
 127 as published by the Free Software Foundation; either version 2.1 of
 128 the License, or (at your option) any later version.
 129
 130 The m17n library is distributed in the hope that it will be useful,
 131 but WITHOUT ANY WARRANTY; without even the implied warranty of
 132 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 133 Lesser General Public License for more details.
 134
 135 You should have received a copy of the GNU Lesser General Public
 136 License along with the m17n library; if not, write to the Free
 137 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 138 02111-1307, USA.