« back to all changes in this revision
Viewing changes to README.en
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Tatsuya Kinoshita
- Date: 2004-05-23 00:54:01 UTC
- Revision ID: james.westby@ubuntu.com-20040523005401-0216ggl5q8ibm9ni
Tags: upstream-1.14.6+0.20040418
Import upstream version 1.14.6+0.20040418
- files added:
added
removed
README.en
1
[README for SEMI kernel package (English Version)]
2
3
What's SEMI?
4
============
5
6
SEMI is a library to provide MIME feature for GNU Emacs. MIME is a
7
proposed internet standard for including content and headers other
8
than (ASCII) plain text in messages.
9
10
RFC 2045 : Internet Message Bodies
11
RFC 2046 : Media Types
12
RFC 2047 : Message Header Extensions
13
RFC 2048 : MIME Registration Procedures
14
RFC 2049 : MIME Conformance
15
16
SEMI has the following features:
17
18
- MIME message viewer (mime-view-mode) (RFC 2045 .. 2049)
19
- MIME message composer (mime-edit-mode) (RFC 2045 .. 2049)
20
21
MIME message viewer and composer also support following features:
22
23
- filename handling by Content-Disposition field (RFC 1806)
24
- PGP/MIME security Multiparts (RFC 2015)
25
- application/pgp (draft-kazu-pgp-mime-00.txt; obsolete)
26
- text/richtext (RFC 1521; obsolete; preview only)
27
- text/enriched (RFC 1896)
28
- External method configuration by mailcap (RFC 1524)
29
30
Notice that this package does not contain MIME extender for any
31
MUAs. They are released as separated packages.
32
33
34
Required environment
35
====================
36
37
SEMI supports XEmacs 21.1 or later, and GNU Emacs 20.4 or later.
38
39
SEMI does not support anything older than GNU Emacs 19.28 or XEmacs
40
19.14. In addition, SEMI does not word with byte-indexing Mule
41
implementations, such as Mule 1, Mule 2 and GNU Emacs 20.1/20.2.
42
43
SEMI also does not support Emacs 19.29 to 19.34, XEmacs 19.15 or
44
XEmacs 20.2, but SEMI may work with them.
45
46
SEMI requires APEL (9.22 or later) and FLIM (1.14.2 or later)
47
package. Please install them before installing it. APEL package is
48
available at:
49
50
ftp://ftp.m17n.org/pub/mule/apel/
51
52
and FLIM package is available at:
53
54
http://www.kanji.zinbun.kyoto-u.ac.jp/~tomo/comp/emacsen/lisp/
55
flim/flim-1.14/
56
57
Installation
58
============
59
60
(a) run in expanded place
61
62
If you don't want to install other directories, please do only
63
following:
64
65
% make
66
67
You can specify the emacs command name, for example
68
69
% make EMACS=xemacs
70
71
If `EMACS=...' is omitted, EMACS=emacs is used.
72
73
(b) make install
74
75
If you want to install other directories, please do following:
76
77
% make install
78
79
You can specify the emacs command name, for example
80
81
% make install EMACS=xemacs
82
83
If `EMACS=...' is omitted, EMACS=emacs is used.
84
85
You can specify the prefix of the directory tree for Emacs Lisp
86
programs and shell scripts, for example:
87
88
% make install PREFIX=~/
89
90
If `PREFIX=...' is omitted, the prefix of the directory tree of the
91
specified emacs command is used (perhaps /usr/local).
92
93
For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
94
will create the following directory tree:
95
96
/usr/local/share/emacs/19.34/site-lisp/ --- emu
97
/usr/local/share/emacs/site-lisp/apel/ --- APEL
98
/usr/local/share/emacs/site-lisp/flim/ --- FLIM
99
/usr/local/share/emacs/site-lisp/semi/ --- SEMI
100
101
You can specify site-lisp directory, for example
102
103
% make install LISPDIR=~/share/emacs/lisp
104
105
If `LISPDIR=...' is omitted, site-lisp directory of the specified
106
emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
107
/usr/local/lib/xemacs/site-lisp).
108
109
If the emu modules (included in APEL package) have been installed in
110
the non-standard directory, you should specify where they will be
111
found, for example:
112
113
% make install VERSION_SPECIFIC_LISPDIR=~/elisp
114
115
(c) install as a XEmacs package
116
117
If you want to install to XEmacs package directory, please do
118
following:
119
120
% make install-package
121
122
You can specify the emacs command name, for example
123
124
% make install-package XEMACS=xemacs-21
125
126
If `XEMACS=...' is omitted, XEMACS=xemacs is used.
127
128
You can specify the package directory, for example:
129
130
% make install PACKAGEDIR=~/.xemacs
131
132
If `PACKAGEDIR=...' is omitted, the first existing package
133
directory is used.
134
135
Notice that XEmacs package system requires XEmacs 21.0 or later.
136
137
(a,b,c)
138
139
You can specify other optional settings by editing the file
140
${archive}/SEMI-CFG. Please read ${archive}/README.en and comments
141
in ${archive}/SEMI-CFG.
142
143
144
Initialization
145
==============
146
147
(a) load-path
148
149
If you are using Emacs or Mule, please add directory of emu, apel,
150
flim and semi to load-path. If you install by default setting, you
151
can write subdirs.el for example:
152
153
--------------------------------------------------------------------
154
(normal-top-level-add-to-load-path
155
'("apel" "flim" "semi"))
156
--------------------------------------------------------------------
157
158
If you are using XEmacs, there are no need of setting about
159
load-path.
160
161
(b) mime-setup
162
163
Please insert the following into your ~/.emacs:
164
165
(load "mime-setup")
166
167
168
Documentation
169
=============
170
171
To get started, please read ${archive}/README.en.
172
173
RFC's 822, 1524, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and
174
2049 are available via anonymous ftp:
175
176
ftp://ftp.merit.edu/internet/documents/rfc/
177
178
179
Mailing lists
180
=============
181
182
If you write bug-reports and/or suggestions for improvement, please
183
send them to the EMACS-MIME Mailing List:
184
185
emacs-mime-en@m17n.org (English)
186
emacs-mime-ja@m17n.org (Japanese)
187
188
Via the EMACS-MIME ML, you can report SEMI bugs, obtain the latest
189
release of SEMI, and discuss future enhancements to SEMI. To join
190
the EMACS-MIME ML, send an e-mail to
191
192
emacs-mime-en-ctl@m17n.org (English)
193
emacs-mime-ja-ctl@m17n.org (Japanese)
194
195
containing
196
197
subscribe YOUR NAME
198
199
in its contents.
200
201
Notice that you should not send mail to author(s), such as
202
morioka@jaist.ac.jp, directly. Because your problem may occur in
203
other environments (if not, it might be your problem, not bug of
204
SEMI). We should discuss in the EMACS-MIME mailing lists. Anyway
205
direct-mail for authors might be ignored. Please send mail to the
206
EMACS-MIME mailing lists.
207
208
209
CVS based development
210
=====================
211
212
If you would like to join CVS based development, please send mail to
213
214
cvs@cvs.m17n.org
215
216
with your account name and your public key for ssh. cvsroot is
217
:ext:cvs@cvs.m17n.org:/cvs/root.
218
219
If you cannot use ssh, please send UNIX /etc/passwd style crypted
220
password. you can commit with the cvsroot
221
:pserver:<accountname>@cvs.m17n.org:/cvs/root.
222
223
We hope you will join the open development.
224
225
226
Authors
227
=======
228
229
Original authors
230
231
MORIOKA Tomohiko <morioka@jaist.ac.jp>
232
(the author of mime-view and various parts of SEMI)
233
UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
234
(the author of mime.el of emacs-mime-tools. mime.el is the
235
origin of mime-edit.el of SEMI)
236
237
Other authors
238
239
Shuhei KOBAYASHI <shuhei-k@jaist.ac.jp>
240
(a major author of signature.el and a lot of codes)
241
MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
242
(anonymous ftp codes of mime-play.el)
243
OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
244
(a major author of mime-partial.el and signature.el)
245
246
Steinar Bang <sb@metis.no>
247
Steven L. Baur <steve@miranova.com>
248
Kevin Broadey <KevinB@bartley.demon.co.uk>
249
Alastair Burt <burt@dfki.uni-kl.de>
250
Eric Ding <ericding@San-Jose.ate.slb.com>
251
Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
252
Simon Josefsson <jas@pdc.kth.se>
253
Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
254
Carsten Leonhardt <leo@arioch.tng.oche.de>
255
Pekka Marjola <marjola@bilbo.ntc.nokia.com>
256
Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
257
Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
258
Alexandre Oliva <oliva@dcc.unicamp.br>
259
Fran�ois Pinard <pinard@iro.umontreal.ca>
260
Artur Pioro <artur@flugor.if.uj.edu.pl>
261
Dan Rich <drich@morpheus.corp.sgi.com>
262
(contribute to evolve mime-image.el with XEmacs)
263
Katsumi Yamaoka <yamaoka@jpl.org>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1