comparison mule-doc/README.Mule @ 70:131b0175ea99 r20-0b30

Import from CVS: tag r20-0b30
author cvs
date Mon, 13 Aug 2007 09:02:59 +0200
parents
children
comparison
equal deleted inserted replaced
69:804d1389bcd6 70:131b0175ea99
1 1989.12.15: Nemacs Ver.3.2.1 (MUSUME-DOUJOUJI version)
2 1989.12.17: Nemacs Ver.3.2.1A (MUSUME-DOUJOUJI version with ANCHIN patch)
3 1989.12.22: Nemacs Ver.3.2.3 (YUMENO-AWAYUKI version)
4 1990.3.3: Nemacs Ver.3.3.1 (HINAMATSURI version)
5 1990.6.6: Nemacs Ver.3.3.2 (FUJIMUSUME version)
6 1992.3.4: Mule Ver.0.9.0 Beta
7 1992.3.23: Mule Ver.0.9.1 Beta
8 1992.4.6: Mule Ver.0.9.2 Beta
9 1992.4.18: Mule Ver.0.9.3 Beta
10 1992.5.28: Mule Ver.0.9.4 Beta
11 1992.7.31: Mule Ver.0.9.5 Beta
12 1992.8.5: Mule Ver.0.9.5.1 Beta
13 1992.10.27: Mule Ver.0.9.6 Beta
14 1992.12.28: Mule Ver.0.9.7 Beta
15 1993.1.22: Mule Ver.0.9.7.1 Beta
16 1993.6.14: Mule Ver.0.9.8 Beta
17 1993.8.1: Mule Ver.1.0 (KIRITSUBO) based on GNU Emacs 18.59
18 1994.2.8: Mule Ver.1.1 (HAHAKIGI) based on GNU Emacs 18.59
19 1994.8.6: Mule Ver.2.0 (UTSUSEMI) based on GNU Emacs 19.25
20 1994.11.2: Mule Ver.2.1 (YUUGAO) based on GNU Emacs 19.27
21 1994.12.28: Mule Ver.2.2 (WAKAMURASAKI) based on GNU Emacs 19.28
22 1995.7.24: Mule Ver.2.3 (SUETSUMUHANA) based on GNU Emacs 19.28
23
24 ############################################################
25 0. INTRODUCTION
26 1. WHAT IS MULE
27 2. SUPPORTED LANGUAGES
28 3. SUPPORTED SYSTEMS
29 4. INSTALLATION
30 5. DOCUMENTS
31 6. DISTRIBUTION
32 7. NEWS GROUP AND MAILING LIST
33 8. MAIL SERVICE
34 9. MISC
35 ############################################################
36
37 0. INTRODUCTION
38
39 This directory contains the distribution of Mule Ver.2.3.
40
41 Mule is free software distributed either as patches to GNU Emacs
42 (19.28) or as a complete tar file. You can redistribute it and/or
43 modify it under the terms of the GNU General Public License as
44 published by the Free Software Foundation; either version 2, or (at
45 your option) any later version.
46
47 Mule is distributed in the hope that it will be useful, but WITHOUT
48 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
49 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
50 for more details.
51
52 You should have received a copy of the GNU General Public License
53 along with GNU Emacs; see the file COPYING. If not, write to the Free
54 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
55
56
57 1. WHAT IS MULE?
58
59 Mule is a MULtilingual Enhancement to GNU Emacs. It can
60 handle not only ASCII characters (7 bits) and ISO Latin-1 (8
61 bits), but also Japanese, Chinese, Korean (16 bits) coded in
62 the ISO2022 standard and its variants (e.g. EUC, Compound
63 Text). For Chinese there is support for both GB and Big5.
64 In addition, Thai (based on TIS620), Vietnamese (based on
65 VISCII and VSCII), Arabic, and Ethiopic are also supported.
66
67 A text buffer in Mule can contain a mixture of characters
68 from these languages. To input any of these characters, you
69 can use various input methods provided by Mule itself. In
70 addition, if you use Mule under some terminal emulator
71 (kterm, mterm, cxterm, or exterm), you can use any input
72 methods supported by the emulator.
73
74
75 2. SUPPORTED LANGUAGES
76
77 2.0 ENGLISH
78
79 Just type in. :-)
80
81 2.1 JAPANESE
82
83 It is strongly recommended to install Wnn4.108 or later.
84 EGG system bundled with Mule can communicate with jserver of
85 Wnn and provide you a very convenient Japanese inputting
86 method. Read `EGG (mule)' node in Info for the usage of
87 this system. You can run Mule as a client of X window, or
88 run it under some Japanese terminal (including such emulators
89 as kterm and mterm and exterm). In the latter case, you can
90 use any inputting methods supported by the terminal. Among
91 other inputting methods are:
92 EGG-SJ3, CANNA (bundled with Mule)
93 SKK, boiled-egg, mlh, tcode (in 'contrib' directory)
94
95 2.2 CHINESE
96
97 It is strongly recommended to install Wnn4.108 or later.
98 EGG system bundled with Mule can communicate with cserver of
99 cWnn and provide you a very convenient Chinese (GB)
100 inputting method. Read `EGG (mule)' node in Info for the
101 usage of this system. You can run Mule as a client of X
102 window, or run it under some Chinese terminal (including
103 such emulators as cxterm and mterm and exterm). In the
104 latter case, you can use any inputting methods supported by
105 the terminal.
106
107 QUAIL system (bundled with Mule) also provides several
108 inputting methods for:
109 GB: PINYIN, PINYIN_with_TONE, CCDOSPY, SW
110 Big5: PINYIN, ETZY, ZOZY
111 Read `Quail (mule)' node in Info for the usage of this system.
112
113 Subscribers of alt.chinese.text and alt.chinese.text.big
114 will find it very useful to use GNUS (news reader written in
115 Emacs lisp) with gnusutil.el (bundled with Mule). It
116 encodes/decodes HZ/zW encoding or Big5 to/from Mule internal
117 code automatically.
118
119 2.3 KOREAN
120
121 Korean inputting method is provided by QUAIL system (bundled
122 with Mule). Read `Quail (mule)' node in Info for the usage
123 of this system. The name of quail-package for Hangul is
124 `hangul' or `handle3'. You can run Mule as a client of X
125 window, or run it under Hangul terminal or mterm or exterm.
126
127 2.4 EUROPEAN
128
129 Many kinds of European character inputting methods are
130 provided by QUAIL system (bundled with Mule). For the
131 moment, QUAIL provides inputting methods for:
132 Latin1, Latin2,.. Latin5, Greek (ISO8859-7),
133 Hebrew (ISO8859-8), Cyrillic (ISO8859-5)
134
135 Read `Quail (mule)' node in Info for the usage of this
136 system. As for Hebrew, right-to-left writing is supported.
137 Consult `R2L (mule)' in Info.
138
139 The `lisp/iso-*.el' files have not been modified yet for
140 this version of Mule. Please use quail system instead.
141
142 2.5 THAI
143
144 Thai support based on TIS620 character set. The inputting
145 method is also provided by QUAIL system (bundled with Mule).
146 Read `quail (mule)' node in Info for the usage of this
147 system. The name of quail-package for Thai is `thai'. A
148 free font for TIS620 (12x29 dots) is also available in
149 `fonts/ETL.tar.gz'. To use the font with 12x24 ASCII font,
150 you should increase upper line-space by a command line
151 argument of "-lsp". Specify "5+0" as the argument.
152
153 2.6 VIETNAMESE
154
155 Vietnamese support is based on two-table-VISCII methods,
156 which divide VISCII's code table into two, lower-case and
157 upper-case. Mule can read/write any of VISCII, VIQR, VSCII.
158 The inputting method is also provided by QUAIL system
159 (bundled with Mule). Read `Quail (mule)' node in Info for
160 the usage of this system. The name of quail-package for
161 Vietnamese is `viet'. For X, you can use both VISCII and
162 VSCII fonts. A free font for VISCII is available in
163 `fonts/ETL.tar.gz' which is designed suitable for the use
164 with other ETL fonts.
165
166 2.7 ARABIC
167
168 Arabic and Persian are supported, but it uses special code
169 and fonts proper to Mule. To read and write Arabic text,
170 you need three fonts: etl16-arabic0.bdf (Arabic digits),
171 etl16-arabic1.bdf (narrow characters) and etl16-arabic2.bdf
172 (wide characters). These fonts are available in
173 `fonts/ETL.tar.gz' which is designed suitable for the use
174 with other ETL fonts. Read `Mule/Languages/Arabic Script
175 Languages' node in Info for the usage of arabic-mode.
176
177 2.8 IPA (International Phonetic Alphabet)
178
179 A subset of IPA is available in Mule. You can use IPA
180 symbols by loading `lisp/quail/ipa.el'. The name of the
181 quail package for IPA is `ipa'. The file `fonts/ETL.tar.gz'
182 contains BDF files of IPA in 14, 16 and 24 dot. For the
183 usage of quail, read `Quail (mule)' node in Info.
184
185 2.9 ETHIOPIC
186
187 Ge'ez script (used in Ethiopic) is supported by the latest
188 release. Use Quail package `ethio' for inputting.
189
190
191 2.10 OTHER LANGUAGES
192
193 We are willing to support Devanagali as soon as we get
194 enough information on how they are supported in the other
195 softwares.
196
197
198 3. SUPPORTED SYSTEMS
199
200 Basically, Mule runs on any systems (and machines) on which
201 GNU Emacs runs. In addition, several systems (including
202 DOS, NT) are supported. See etc/MACHINES.
203
204
205 4. INSTALLATION
206
207 To install Mule, see INSTALL. Mule specific notices are surrounded by
208 lines <MULE> and </MULE>.
209
210
211 5. DOCUMENTS
212
213 For the moment, we have the following documents.
214 `etc' directory contains:
215 FAQ (for original GNU Emacs in English)
216 FAQ-NEW (new FAQ for original GNU Emacs in English)
217 FAQ-Mule (for Mule specific items in English)
218 FAQ-Mule.jp, FAQ-Mule.kr, FAQ-Mule.th
219 emacs.1 (man file for original GNU Emacs in English)
220 mule.1 (man file for Mule in English)
221 m2ps.1 (man file for m2ps -- Mule's text to PostScritp converter)
222 coco.1 (man file for coco -- Code converter)
223 `info' directory contains:
224 emacs (for original GNU Emacs in English)
225 mule (for Mule in English)
226 mule-jp (for Mule in Japanese)
227 egg-jp (for EGG in Japanese)
228 canna-jp (for CANNA in Japanese)
229 You may also find various documents under `doc' directory.
230
231 The file NEWFEATURE of the top directory is also very
232 important.
233
234 Since many of these documents (including this file) were
235 written by a non-native speaker of English (it's me), you
236 may find many curious expressions. Please correct them. In
237 addition, we are looking for volunteers who translate the
238 documents to Chinese, Korean, and the other languages.
239
240 For Vietnamese, the Viet-Std Group has kindly translated
241 some of these documents. Those are under the directory
242 `doc/viet', but not updated..
243
244
245 6. DISTRIBUTION
246
247 Mule is available by anonymous ftp from:
248
249 Japanese sites:
250 etlport.etl.go.jp [192.31.197.99]:/pub/mule
251 Manager: Ken'ichi HANDA <handa@etl.go.jp>
252 ftp.mei.co.jp [202.13.88.131]: /archive/free/gnu/emacs/Mule
253 Manager: Motohide Murakami <murakami@msr.mei.co.jp>
254 ftp.iij.ad.jp [192.244.176.50]:/pub/misc/mule
255 Manager: Takamichi MIYOSHI <miyoshi@iij.ad.jp>
256 U.S. sites:
257 ftp.cs.buffalo.edu [128.205.32.9]:/pub/mule
258 Manager: Rafhael Cedeno <cedeno@cs.Buffalo.EDU>
259 Other foreign sites:
260 sh.wide.ad.jp [133.4.11.11]:/JAPAN/mule
261 Manager: Akira KATO <kato@wide.ad.jp>
262 ftp.funet.fi [128.214.248.6]:/index/mule
263 Manager: Hannu Aronsson <haa@ftp.funet.fi>
264 cs.huji.ac.il [132.65.16.10]:/pub/gnu/mule
265 Manager: The System Group <system@cs.huji.ac.il>
266
267 As for a mail service, read the section 8.
268
269 Either ftp the complete tar file (mule-2.3.tar.gz), *or* if
270 you have an unmodified GNU Emacs 19.28 you can ftp just the
271 patch file (diff-19.28-2.3.gz) and apply that. If you find
272 a patch with version number higher than 2.3, apply that
273 also.
274
275 These directories contain several other useful files such as
276 X's fonts and contributed softwares. See the file `00README'.
277
278 We are looking for more ftp sites. If you can kindly
279 provide this service, please send mail to
280 mule-request@etl.go.jp.
281
282
283 7. NEWS GROUP AND MAILING LIST
284
285 Mule's main discussion is done on the newsgroup
286 fj.editor.mule in Japanese. For those who can't subscribe
287 this newsgroup, we provide mail<->news gateway service.
288 Please send request of this service to mule-request@etl.go.jp.
289
290 For those who don't speak Japanese, we are running two
291 mailing lists:
292 mule@etl.go.jp (for general discussion)
293 mule-vn@etl.go.jp (for Vietnamese)
294 In both of them, main language is English, but you can
295 send/receive any multilingual text supported by mule.
296
297 Before sending mails to the above addresses, you should join
298 the corresponding mailing list. Please send requests of
299 subscribing/unsubscribing to:
300 mule-request@etl.go.jp
301 saying which mailing list you want to join.
302 We are willing to create mailing lists specific to the other
303 languages if there are many requests.
304
305 We are running one more mailing list to test new version of
306 Mule on various platforms before the official release:
307 mule-jp@etl.go.jp (main language: Japanese)
308 All mails to the above mailing lists are also sent to
309 the members of this mailing list.
310
311
312 8. MAIL SERVICE
313
314 You can get Mule by sending request to:
315 mule-by-mail@etl.go.jp
316 This system analyzes only the Subject field of a mail header.
317 The acceptable format of Subject is:
318 Subject: filename mail-address
319 send the specified file to <mail-address>,
320 The acceptable `filename' is one of the followings:
321 ------------------------------------------------------------
322 diff-19.28-2.3 -- Patch for GNU Emacs 19.28, 36 files
323 diff-19.28-2.3.N -- Nth part of diff-19.28-2.3
324 -- N should be one of 01, 02 .. 36
325 patch-2.2.1 -- The 1st patch for Mule Ver.2.2.
326 ETL.tar -- Fonts for Laint1,Cyrillic,Greek,Thai,Viet..., 3 files
327 Chinese.tar -- Fonts for Chinese-GB (16/24) , 20 files
328 Japanese.tar -- Fonts for Japanese-JIS (14/16/24), 25 files
329 Korean.tar -- Fonts for Korean-KSC (16/24), 18 files
330 READMEDIR.tar -- Several documents about Mule, 3 files
331 lisp.tar -- Useful ELISP libraries in contrib directory, 5 files
332 HELP -- This message
333 ------------------------------------------------------------
334 For instance, a mail with 'Subject: Chinese.tar me@etl.go.jp'
335 will send Chinese fonts divided into 20 files to <me@etl.go.jp>.
336
337 The description alters on version up of Mule. You'd better
338 check the correct format by requesting HELP.
339 ------------------------------------------------------------
340
341 Russian or Ukrainian sites should ask mail service to
342 postmaster@ts.kiev.ua, or
343 nib@ts.kiev.ua,
344 however, as far as I know, their system is not yet
345 automated.
346
347
348 9. MISC
349
350 9.1 PRINTING UTILITY
351
352 To print various characters supported by Mule, we provide a
353 program `m2ps' which will be installed automatically while
354 installing mule (just as etags, emacsclient). `m2ps'
355 converts Mule's text (*internal* coding-system) to
356 PostScript by using BDF files for getting glyphs of
357 characters. For more detail, try "man m2ps". If you want
358 to print a file of other coding-system (e.g. *junet*),
359 please use `any2ps' which is a front-end of `coco' and
360 `m2ps' and can handle a text of any coding-system. Read the
361 first two lines of `any2ps' for the usage.
362
363 9.2 CODE CONVERSION LIBRARY
364
365 To convert any codes supported by Mule, we provide a program
366 `coco' which will be installed automatically while
367 installing mule (just as etags, emacsclient). For more
368 detail, try "man coco".
369
370 9.2 CODE TRANSLATION LIBRARY
371
372 Translate character code of Chinese letters among GB, JIS,
373 KSC, Big5, CNS. Not yet supported.
374
375
376 ---
377 Ken'ichi HANDA Electrotechnical Lab., JAPAN. <handa@etl.go.jp>
378 Satoru TOMURA Electrotechnical Lab., JAPAN. <tomura@etl.go.jp>
379 Mikiko NISIKIMI Electrotechnical Lab., JAPAN. <nisikimi@etl.go.jp>
380 Naoto TAKAHASHI Electrotechnical Lab., JAPAN. <ntakahas@etl.go.jp>