cgit.sxemacs.org Git - packages/blob - mule-packages/mule-ucs/lisp/README

   1 --------------------------------------------------------------
   2 Mule-UCS(Universal enCoding System)
   3 Written by MIYASHITA Hisashi <himi@m17n.org>
   4
   5        About any question, problem, suggesions, and so on,
   6        please discuss at MULE ML <mule@m17n.org>
   7                       or MULE Japanese ML <mule-ja@m17n.org>.
   8
   9        reviced on 2001/4/13.
  10 --------------------------------------------------------------
  11
  12 o ... License
  13
  14   Mule-UCS is free software; you can redistribute it and/or modify
  15 it under the terms of the GNU General Public License as published by
  16 the Free Software Foundation; either version 2, or (at your option)
  17 any later version.
  18
  19   You should have received a copy of the GNU General Public License
  20 along with Mule-UCS; see the file COPYING.  If not, write to
  21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 Boston, MA 02111-1307, USA.
  23
  24 o ... Introduction
  25
  26   Mule-UCS is an Emacs Lisp library to define encoding/decoding schemes by
  27 rather simple translation rules.
  28
  29   Emacs prepares encoding/decoding schemes in the following 2 mechanisms.
  30
  31   (A) ... built-in ISO/IEC 2022 encoder/decoder
  32   (B) ... Code Conversion Language(CCL) engine
  33
  34   Although (A) provides powerful encoding/decoding schemes as to ISO/IEC 2022,
  35 we cannot utilize this for any other encoding schemes.
  36 (B) is a simple register machine.  However, CCL is an arcane language
  37 because it is mysterious and obscure:-P.
  38
  39   Mule-UCS provides flexible and complehensible encoding mechanism to Emacs.
  40 Currently, Mule-UCS generates CCL program from the translation rule, but
  41 in the future, Mule-UCS may support another conversion engine on Emacs.
  42
  43   And we prepared 3 predefined conversions for Mule-UCS.
  44
  45   (1) ... Unicode(UTF-7/8/16) support.
  46   (2) ... Big5 <-> CNS conversion support.
  47   (3) ... JIS X 0213 support. (Kawabata-san contributed almost all of the works.)
  48
  49   These are included in this package.
  50
  51   This version supports Emacs 20.6 or later; XEmacs 21.2.37 or later; and
  52 Meadow 1.12 Beta 1 or later.
  53 If your Emacs have Mule 4.1(AOI) or later features, you can utilize UTF-8/16
  54 autodetection facility.  You can upgrade your Emacs to Mule 4.1 by applying
  55 the patch(emacs-20.7-mule-4.1.patch.txt) included in this package.
  56
  57 This manual corresponds to Mule-UCS 0.84 (KOUGETSUDAI).
  58
  59 --------------------------------------------------------------------------------
  60 VERY IMPORTANT NOTICE!!!
  61
  62   If your Emacs is earlier than 20.6, it contains the fatal bug
  63 on CCL interpreter, Please update to 20.6, which is bug fixed-version
  64 of 20.5.
  65
  66   Owing to this bug, Emacs may cause wrong
  67 encoding or decoding if the encoded or decoded data was
  68 too much.  This problem is NOT limited to Mule-UCS.
  69
  70   However, also on Emacs 20.6, its CCL interpretor have some faults on
  71 MapMultiple instruction.  Therefore, Mule-UCS CCL manager(MUCS-CCL)
  72 disables some features if it detects the faults on MapMultiple
  73 instruction.  Without such features, you cannot use COMPOSITE(`|') and
  74 AND(`&') operations in translation rules.  But you will use other
  75 features correctly.  If you'd like to use such features, please
  76 apply the patch, which is put in the top directory of Mule-UCS and
  77 named `emacs-20.7-mule-4.1.patch.txt', to your Emacs.
  78 This patch is maintained by Satoshi Yatagawa <yatagawa@cc.teu.ac.jp>.
  79 For detail, please refer to http://www.teu.ac.jp/nsit/~yatagawa/comp/emacs/
  80 I appreciate his contribution.
  81 By applying this patch, not only this problem is fixed, but also
  82 Emacs will have Mule 4.1 features, which mainly consist of
  83 UTF-8/16 automatic detection facility.
  84
  85   I ask Emacs developpers to correct this problem and to adopt Mule 4.1
  86 features in the future versions of Emacs.  That will be applied to
  87 Emacs 21.
  88
  89   If you use Meadow, please update to 1.13 Beta 1 or later.
  90 They have no known faults on CCL also on MapMultiple instruction.
  91
  92 --------------------------------------------------------------------------------
  93
  94 o ... Installation.
  95
  96   Since Mule-UCS is only an Emacs Lisp library, you have only to
  97 byte-compile *.el files and install them to the location refered by
  98 load-path.
  99
 100   You can use mucs-comp.el at the top directory.
 101 Enter the following command line:
 102
 103   emacs(xemacs) -q --no-site-file -batch -l mucs-comp.el
 104
 105 If you use Meadow, enter the following:
 106
 107   Meadow95(NT) -q --no-site-file -batch -l mucs-comp.el
 108
 109 And then, you will obtain byte-compiled emacs-lisp files.
 110 Finally, you should install lisp directory to your site-lisp directory.(*1)
 111
 112 Please read README.Unicode if you want to use Unicode.
 113
 114 o ... and then...
 115
 116   If you want to configure your own encoding, please read another
 117   documentations.(Not yet written. sorry.)
 118
 119
 120
 121