INSTALL for yudit version 1.2

Prerequisites:
=============
--needed: g++ 2.7.2 or similar c++ compiler (GNU: ftp prep.ai.mit.edu)
  Important (if you are using g++ 2.8.0 or later skip this message):
             If you are using egcs compiler you need to rebuild qt with 
             egcs. Qt libraries built with old versions of g++ are not 
             compatible with egcs. 
             ftp://prep.ai.mit.edu/
--needed: gmake 3.75 or greater
             ftp://prep.ai.mit.edu/
--needed: perl - any version 
             http://www.perl.org/
--needed: flex 2.5.4 or greater 
             ftp://prep.ai.mit.edu/
--needed: X11R5 or greater (www.xfree86.org)
--optional: motif 1.2 or greater for myudit 
	     motif 2.0: http://www.redhat.com/ -$$
             lesstif: http://www.hungry.com/ -free
--optional: qt 1.2 or greater for qyudit 
             http://www.troll.no/
--optional: kde development libraries for kyudit (kdecore and kdeui)
             http://www.kde.org/
--recommended: If you need True Type font rendering under X11 you need 
  the freetype engine
             http://www.freetype.org/
  If you dont have it yudit still compiles.
--recommended:  For multi-language message support you need GNU 
  gettext 0.10 or better.  If you use gnu libc, gettext is usually included.
  Read "Possible Problems" section at the end of this document.
--optional: a lot of True Type fonts are available for free:
  From www.microsoft.com you can get gulim (Hangul), msgothic (Japanese) for
       IE. 
  From www.bitstream.com you can get cyberbit that contains a lot of glyphs.
  From ftp://ftp.cs.indiana.edu/pub/fidel/fonts/ you can get Ethiopic
       fonts (gfzemenu).
--recommended: 
  Several UCS fonts:
	http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html
  Unifont:
        http://www.czyborra.com/unifont/

For kanji input:
o canna32p2 from ftp.x.org
o kinput-2.0.pl2 from ftp.x.org

Installation:
=============
Yudit is a successor of yutex, so if you have yutex you should remove
it with rpm manager or if you did not installed it with rpm:

   cd your-prefix
   rm -f bin/uniconv bin/myutex bin/kyutex bin/stripumap
   rm -f man/uniconv.1 man/yutex.1 man/makeumap.1 man/stripumap.1
   cd share
   rm -rf yutex
   
During the installation process make sure your environment is not localized.

    set LANG=
    export LANG

This is necessary, because if the language is set certain string substitutions
may fail during configuration.

Untar the distribution and go into the toplevel directory.
It is usually enough to type:

    ./configure

To see all options type

    ./configure --help

If you want to use the freetype rendering library from 

    http://www.freetype.org/

You should get the latest distribution, compile it and install it.
If you installed the library with /usr or /usr/local prefix you
don't need to do anything specific - configure will find it.
If you have installed freetype somewhere else, or you compiled it but 
did not install it you need to tell configure where to find it:

    ./configure --with-freetype-includes=/home/gsinai/I18N/freetype-1.0/lib \
	--with-freetype-libraries=/home/gsinai/I18N/freetype-1.0/lib/.libs


The most commonly used command is  './configure --prefix=/my/install/dir'
configure tries to determine the location of Qt anbd KDE libraries, but
you can help it byt setting QTDIR and KDEDIR environment variables.  (khmm;)

After configuring type:

    make

will build the libraries, utilities and GUIs . Now to install the
whole package you should type:

    make install

You need to set QTDIR or KDEDIR environment before you configure  if 
you want to use qt and kde.

Previously the installation script stried to create the following links:

    kyudit -> yudit
    qyudit -> yudit
    myudit -> yudit

From version 0.99 the yudit became available, so none of these links are 
created. Yudit uses only X11 library for the gui.

From version 1.1 yudit default package does not come with motif/qt/kde.
The package that contains motif/qt/kde support should be untarred into
yudit-version directory before running 'configure'. 

Please read 'README.yudit-motif' or 'README.yudit-mqt' for details.

Adding new messages
===================
If you want to see the menu and system messages in your own language you can
add it dynamically. Please translate the

    gui/src/your.utf8/messages.po

file and make another install. You also need to modify the .yuditrc file
to have the fonts set up correctly. 

Japanese Input
==============
If you have built the Motif version you can also use Kinput2 to input Japanese.

If you want to use free packages and you have an English environment 
you need to do the following:

o Get a conversion server, 'canna' from X11 contrib directory.
  This server can be built in Linux. It is usually started when the machine
  boots and keeps running. Make sure it uses its own wide text library.
  No Japanese environment is needed.

o Get a 'kinput2' X front-end for X11 from the same place you got canna.
  If you don not have Japanese environment, make sure it links with libcanna16.
  Kinput is started after X in .xinitrc and it provides the input windows
  for the applications.

  The current version of kinput2 has a bug - it thinks that long is 32 bit, 
  which is true on a pentium machine. On an alpha machine you should make
  sure you have a version number set to less than 2.02 in your .yuditrc so
  that yudit knows that it should deal with a buggy kinput2. If you have a 
  value of zero, yudit tries to determine the version number itself.

Hangul Input
============
Yudit comes with kmap files for Roman transliteration, 2-set and 3-set 
keyboards. I expect yudit to improve on this area.

Adding New Mappings
===================
Please read the man page for makeumap. The on-line manual also has some info.

Possible Problems
=================
o You may have problem with gettext:
  - Ususally gnu gettext is installed but a different library gets linked from 
    libc, libintl - somewhere, libttf. You may need to recompile libttf.
  - In gnu libc gettext is usually included. Do not try to compile it 
    seperatelly.
  - The gettext package should be configured and conpiled with:
            --with-gnu-gettext
    configure option.
o There are new config parameters (new compared to version 0.97).
  If you want to see them it is advisable to move your existing ~/.yuditrc 
  away and let yudit copy the default one.
o Only the menus and one help page (Hungarian config help) is translated 
  as of 1.0. The languages are: English, Hungarian, Russian, Japanese.
o Installation of yudit fails. It failed when it could not find tupdate 
  which was part of gnu gettext. From verison 1.0 I check for it so it
  should be OK.
  
  
Copyright:
Freely distributable. Please read the file COPYING. (GNU)

Enjoy,

Gaspar Sinai <gsinai@iname.com> 

Tokyo, 10 December, 1998. 
