xklu - Kanji Lookup (v0.1)
==========================

-- xklu is beta --
XKlu is a beta product. This means xklu hasn't been thoroughly tested,
documented or optimized. Optimization at all levels needs refinement from
coding (portability, conformity, security, performance) to details of the
package itself (autoconf and friends). Any comments would be appreciated
(email to `dun_roamin@yahoo.com'). Bug fixes, enhancements etc in diff format
is appreciated. 

XKlu was developed on Linux (x86) kernel 2.0.18, gtk+1.1.3, glib-1.1.4.
Any results of other tested configurations would be appreciated.
-- xklu is beta --

Introduction
============

XKlu is a small program for looking up information about Japanese Kanji.
A search can be performed in a number of ways:

  Kanji Lookup 
     * Character Recognition 
     * Lookup by encoding/kanji (EUC/SJIS/JIS/KUTEN) 
     * File kanji scan (EUC) 

Details concerning a selected kanji are also shown:

  Kanji Details 
     * Kanji Character 
     * Stroke Count 
     * English Meaning(s) 
     * Japanese Reading(s) 
     * Compound Characters/Reading/English Meaning 
     * Encoding (EUC/KUTEN/JIS/SJIS/Unicode) 

XKlu was inspired by Owen Taylor's kanjipad program. 
     http://www.gtk.org/~otaylor/

XKlu is under the terms of the GNU General Public License, see the
file `COPYING' for more information.

Availability
============

Latest version currently available at:
    http://www.geocities.com/SiliconValley/Sector/1057/xklu.html


Prerequisites
=============

XKlu runs under the X Window system and uses gtk+ as a windowing
toolkit. 

  - Jim Breen's KANJIDIC and EDICT Japanese dictionary files (optional)
	ftp://ftp.cc.monash.edu.au/pub/nihongo/edict.gz    
	ftp://ftp.cc.monash.edu.au/pub/nihongo/kanjidic.gz 

  - Perl is required to build `jdata.dat' 
	www.perl.com

  - Japanese fonts and ja_JP.ujis locale.

  - X Window kanji FEP and kana-kanji conversion server (optional).


Installation
============

XKlu binary will be stored in the autoconf default installation
directories. That is, the binary will be placed in `/usr/local/bin'
and the related reference files will be in `/usr/local/share/xklu'.
These settings can be changed when running `./configure'. Type
`./configure --help' for more information. 

  - Ensure that the fontset in `src/klugtkrc' is available on
    your system. If not, edit this file to point to a `jisx0208-1983'
    fontset.

  - Configure the package for your system. Type `./configure'

  - Type `make' to compile the package.

  - Type `make install' to install the package.

  - You can remove the binaries and object files from the source tree
    by typing `make clean'.


Running
=======

XKlu requires that the Japanese locale be set to Japanese EUC, unsure
your environment is set appropriately. On most Linux installations,
the following setting would suffice:

  - LANG=ja_JP.ujis; export LANG

You can tell xklu where to look for the KANJIDIC and EDICT files on
the command line or with the environment variable `KLULIBDIR' pointing
to the directory where the files are.
XKlu will look for dictionary files in the following order:
    * The directory indicated by KLULIBDIR environment variable.
    * xklu's data directory set at compile time (`/usr/local/share/xklu').
    * The current directory.

XKlu can run without these files. Without `edict' compound kanji information
will not be shown. Without `kanjidic' kanji details (such as stroke count,
readings and english meanings) will not be shown. You can use xklu without
either of these files to display the chosen kanji only. This can be useful
for cutting and pasting selected kanji into other apps from any of the 
lookup methods.

In order to display Japanese characters, a font is needed. This is set
using a gtkrc file called `klugtkrc' in the KLULIBDIR directory, or 
`$HOME/.klugtkrc' in your home directory. This file not only indicates which 
fonts xklu will use but can also be used to define other GUI attributes.
Read GTK+ documentation for more information. 

It is recommended to copy `klugtkrc' in the `src' directory to `$HOME/.klugtkrc'
so you can edit the fontset to your liking.