1#
2#   $Id: INSTALL.en,v 1.4 2004/05/21 16:39:31 aono Exp $
3#
4
5#
6# FreeWnn is a network-extensible Kana-to-Kanji conversion system.
7# This file is part of FreeWnn.
8#
9# Copyright Kyoto University Research Institute for Mathematical Sciences
10#                 1987, 1988, 1989, 1990, 1991, 1992
11# Copyright OMRON Corporation. 1987, 1988, 1989, 1990, 1991, 1992, 1999
12# Copyright ASTEC, Inc. 1987, 1988, 1989, 1990, 1991, 1992
13# Copyright FreeWnn Project 1999, 2000, 2002
14#
15# Maintainer:  FreeWnn Project   <freewnn@tomo.gr.jp>
16#
17# This program is free software; you can redistribute it and/or modify
18# it under the terms of the GNU General Public License as published by
19# the Free Software Foundation; either version 2 of the License, or
20# (at your option) any later version.
21#
22# This program is distributed in the hope that it will be useful,
23# but WITHOUT ANY WARRANTY; without even the implied warranty of
24# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25# GNU General Public License for more details.
26#
27# You should have received a copy of the GNU General Public License
28# along with this program; if not, write to the Free Software
29# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30#
31
32        How to install FreeWnn
33
34
35[Basic Method of Installation]
36
371. expand FreeWnn tarball.
38
39        $ gzcat FreeWnn-*.tar.gz | tar xvf -
40
41        *1: You should use appropriate filename depending the FreeWnn version.
42
432. change directory to FreeWnn-*/
44
45        $ cd FreeWnn-*
46
473. run configure
48
49        $ ./configure
50
51	*2: For configure options, see below or type `./configure --help'.
52
534. run make
54
55        $ make
56
575. To install commands, libraries, dictionaries and so on,
58   run make install as a superuser(*3).
59
60        $ su
61        # make install
62
63	*3: Currently, install target does not work well for other user.
64
656. To install manuals, you should do the following as a superuser
66
67        # make install.man
68
69   *4: You can ommit this if you do not want manuals installed.
70
71[Configure options]
72
73Typing
74
75        $ ./configure --help
76
77will give you list of options that configure accepts.
78For example, changing install directory from the default /usr/local to
79/opt/freewnn, use --prefix option:
80
81	$ ./configure --prefix=/opt/freewnn
82
83Below are the main configure option of FreeWnn.
84
85  enabled by default:
86  --enable-libraries    compile and install FreeWnn libraries.
87  --enable-server       compile and install FreeWnn servers.
88  --enable-Wnn          compile and install Wnn (Japanese).
89  --enable-cWnn         compile and install cWnn (Chinese).
90  --enable-kWnn         compile and install kWnn (Korean).
91
92  disabled by default:
93  --enable-ipv6         enable IPv6 feature.
94  --enable-unsafe-path  allow creating files in jserver_dir (*5).
95  --enable-client	compile and install uum (*6).
96  --with-libwrap	use libwrap (in TCP wrapper) for jserver
97			to enable connection-based access control (*7).
98
99*5: If the option --enable-unsafe-path is enabled, the [cjkt]server
100  daemons accept creation of an FreeWnn dictionary file in an arbitrary
101  path, and they accept request from client of any hosts.
102  This feature may be a security hole.
103  Unless you used to place FreeWnn dictionary files in a path other than
104  jserver_dir (lib/wnn/$LANG/dic/usr), you should not enable this feature.
105
106*6: cuum cannot be compiled yet.
107
108*7: If you specify --enable-ipv6, libwrap need to support IPv6 also.
109