skf README
----------

1. Introduction
   skf is an i18n-capable kanji filter. skf is designed for
  reading documents in various languages and codes using kanji
  or unicode capable display devices. Like other kanji filters,
  skf provides basic japanese kanji code conversion features, 
  include to/from JIS, EUC, Shift-JIS, UCS2, KEIS83 and UTF-7/8,
  but expanded to handle Korian and Chinese standard codesets.
   Unlike nkf, it does not provide additional fancy features
  like broken jis recovery, but it has support for ISO-8859's,
  European domestic set, JIS X-0212/X-0213 code conversion, 
  IBM gaiji support and can add other code support easily.

   skf does not depend on glibc kanji support and locales. This
  program includes everything required for conversion within it.

2. Install SKF
   Since skf depends on only basic file I/O, install should be
  fairly easy except some switches related to locale features.
  skf implements locale features using GNU gettext framework, 
  and the framework is used only to get localized messages. 
  skf does not support X11's catget features.

  Note that binary form with gettext should be distributed under
  GPL 2.0 or later, because it links the gettext library. Source 
  form still can distribute under copyright license enclosed with
  this package.

2.1 Linux, M*cOS X and Un*x-like systems
   If you are using a modern unices system, just type ./configure
  and then make, then you'll get working binary. You might need 
  the gettext package installed to compile. For debian GNU/Linux
  system, you can build package using dpkg-buildpackage with 
  debhelper (Yep. You need debhelper. See manual). For rpm based
  system, 'make srpm' creates srpm package in rpm/SRPM, though
  not fully tested.
  Compilation on M*cOS X system (>10.3) is tested and supported.
  If you are using an other kind of Un*x style system and configure
  fails, please adjust locale features (--disable-nls), external
  table features (--disable-dynamic) and CFLAGS in Makefile for 
  your system. 

2.2 Wind*ws
   For cygwin environment, you can compile either Win32-version 
  or cygwin-version binaries by switching some options in Makefile.
  Please refer description in Makefile. For cygwin-version, you
  need both gettext and gettext-dev packages for nls feature, and
  will automatically be enabled by configure. skf is also ported to 
  Microsoft SFU 3.5 environment with gcc, but only partially tested. 

   If you want some detailed or esoteric/cosmetic setting changes,
  see config.h. Common settings can be handled in Makefile.

3. Install SKF perl-plugin (will be enabled in 1.94 or later)
   Use "make skf_perl" in skf-root directory. Binary is generated
  in ./perlxs directory. Note that 1.93 doesn't include necessary
  files.

Happy Hacking!

Seiji Kaneko <skaneko@a2.mbn.or.jp>, 23 Oct 2001 23:10 +0900

