README

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