README

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