README
README.en
1;; -*- coding: utf-8; -*-
2[README for SEMI kernel package (English Version)]
3
4What's SEMI?
5============
6
7 SEMI is a library to provide MIME feature for GNU Emacs. MIME is a
8 proposed internet standard for including content and headers other
9 than (ASCII) plain text in messages.
10
11 RFC 2045 : Internet Message Bodies
12 RFC 2046 : Media Types
13 RFC 2047 : Message Header Extensions
14 RFC 2048 : MIME Registration Procedures
15 RFC 2049 : MIME Conformance
16
17 SEMI has the following features:
18
19 - MIME message viewer (mime-view-mode) (RFC 2045 .. 2049)
20 - MIME message composer (mime-edit-mode) (RFC 2045 .. 2049)
21
22 MIME message viewer and composer also support following features:
23
24 - filename handling by Content-Disposition field (RFC 1806)
25 - PGP/MIME security Multiparts (RFC 2015)
26 - application/pgp (draft-kazu-pgp-mime-00.txt; obsolete)
27 - text/richtext (RFC 1521; obsolete; preview only)
28 - text/enriched (RFC 1896)
29 - External method configuration by mailcap (RFC 1524)
30
31 Notice that this package does not contain MIME extender for any
32 MUAs. They are released as separated packages.
33
34
35Required environment
36====================
37
38 SEMI supports XEmacs 21.1 or later, and GNU Emacs 20.4 or later.
39
40 SEMI does not support anything older than GNU Emacs 19.28 or XEmacs
41 19.14. In addition, SEMI does not word with byte-indexing Mule
42 implementations, such as Mule 1, Mule 2 and GNU Emacs 20.1/20.2.
43
44 SEMI also does not support Emacs 19.29 to 19.34, XEmacs 19.15 or
45 XEmacs 20.2, but SEMI may work with them.
46
47 SEMI requires APEL (10.7 or later) and FLIM (1.14.2 or later)
48 package. Please install them before installing it. APEL package is
49 available at:
50
51 http://git.chise.org/elisp/dist/apel/
52
53 and FLIM package is available at:
54
55 http://git.chise.org/elisp/dist/flim/flim-1.14/
56
57
58Installation
59============
60
61(a) run in expanded place
62
63 If you don't want to install other directories, please do only
64 following:
65
66 % make
67
68 You can specify the emacs command name, for example
69
70 % make EMACS=xemacs
71
72 If `EMACS=...' is omitted, EMACS=emacs is used.
73
74(b) make install
75
76 If you want to install other directories, please do following:
77
78 % make install
79
80 You can specify the emacs command name, for example
81
82 % make install EMACS=xemacs
83
84 If `EMACS=...' is omitted, EMACS=emacs is used.
85
86 You can specify the prefix of the directory tree for Emacs Lisp
87 programs and shell scripts, for example:
88
89 % make install PREFIX=~/
90
91 If `PREFIX=...' is omitted, the prefix of the directory tree of the
92 specified emacs command is used (perhaps /usr/local).
93
94 For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
95 will create the following directory tree:
96
97 /usr/local/share/emacs/19.34/site-lisp/ --- emu
98 /usr/local/share/emacs/site-lisp/apel/ --- APEL
99 /usr/local/share/emacs/site-lisp/flim/ --- FLIM
100 /usr/local/share/emacs/site-lisp/semi/ --- SEMI
101
102 You can specify site-lisp directory, for example
103
104 % make install LISPDIR=~/share/emacs/lisp
105
106 If `LISPDIR=...' is omitted, site-lisp directory of the specified
107 emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
108 /usr/local/lib/xemacs/site-lisp).
109
110 If the emu modules (included in APEL package) have been installed in
111 the non-standard directory, you should specify where they will be
112 found, for example:
113
114 % make install VERSION_SPECIFIC_LISPDIR=~/elisp
115
116(c) install as a XEmacs package
117
118 If you want to install to XEmacs package directory, please do
119 following:
120
121 % make install-package
122
123 You can specify the emacs command name, for example
124
125 % make install-package XEMACS=xemacs-21
126
127 If `XEMACS=...' is omitted, XEMACS=xemacs is used.
128
129 You can specify the package directory, for example:
130
131 % make install PACKAGEDIR=~/.xemacs
132
133 If `PACKAGEDIR=...' is omitted, the first existing package
134 directory is used.
135
136 Notice that XEmacs package system requires XEmacs 21.0 or later.
137
138(a,b,c)
139
140 You can specify other optional settings by editing the file
141 ${archive}/SEMI-CFG. Please read ${archive}/README.en and comments
142 in ${archive}/SEMI-CFG.
143
144
145Initialization
146==============
147
148(a) load-path
149
150 If you are using Emacs or Mule, please add directory of emu, apel,
151 flim and semi to load-path. If you install by default setting, you
152 can write subdirs.el for example:
153
154 --------------------------------------------------------------------
155 (normal-top-level-add-to-load-path
156 '("apel" "flim" "semi"))
157 --------------------------------------------------------------------
158
159 If you are using XEmacs, there are no need of setting about
160 load-path.
161
162(b) mime-setup
163
164 Please insert the following into your ~/.emacs:
165
166 (load "mime-setup")
167
168
169Documentation
170=============
171
172 To get started, please read ${archive}/README.en.
173
174 RFC's 822, 1524, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 and
175 2049 are available via anonymous ftp:
176
177 ftp://ftp.merit.edu/internet/documents/rfc/
178
179
180Mailing lists
181=============
182
183 If you write bug-reports and/or suggestions for improvement, please
184 send them to the Emacs-MIME Mailing Lists:
185
186 emacs-mime-en@lists.chise.org (English)
187 emacs-mime-ja@lists.chise.org (Japanese)
188
189 Via the Emacs-MIME ML, you can report SEMI bugs, obtain the latest
190 release of SEMI, and discuss future enhancements to SEMI. To join
191 the Emacs-MIME ML, please see the descriptions of the following
192 pages:
193
194 http://lists.chise.org/mailman/listinfo/emacs-mime-en (English)
195 http://lists.chise.org/mailman/listinfo/emacs-mime-ja (Japanese)
196
197
198Git based development
199=====================
200
201 The SEMI development sources can be accessed via Git repository.
202 You can get the latest SEMI sources by the following:
203
204 % git clone http://git.chise.org/git/elisp/semi.git
205
206 Or you can view the SEMI repository via WWW at:
207
208 http://git.chise.org/gitweb/?p=elisp/semi.git
209
210 If you would like to join Git based development, please declare it
211 in the Emacs-MIME mailing list at first.
212
213 We hope you will join the open development.
214
215
216Authors
217=======
218
219Original authors
220
221 MORIOKA Tomohiko <morioka@jaist.ac.jp>
222 (the author of mime-view and various parts of SEMI)
223 UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
224 (the author of mime.el of emacs-mime-tools. mime.el is the
225 origin of mime-edit.el of SEMI)
226
227Other authors
228
229 Shuhei KOBAYASHI <shuhei-k@jaist.ac.jp>
230 (a major author of signature.el and a lot of codes)
231 MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
232 (anonymous ftp codes of mime-play.el)
233 OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
234 (a major author of mime-partial.el and signature.el)
235
236 Steinar Bang <sb@metis.no>
237 Steven L. Baur <steve@miranova.com>
238 Kevin Broadey <KevinB@bartley.demon.co.uk>
239 Alastair Burt <burt@dfki.uni-kl.de>
240 Eric Ding <ericding@San-Jose.ate.slb.com>
241 Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
242 Simon Josefsson <jas@pdc.kth.se>
243 Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
244 Carsten Leonhardt <leo@arioch.tng.oche.de>
245 Pekka Marjola <marjola@bilbo.ntc.nokia.com>
246 Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
247 Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
248 Alexandre Oliva <oliva@dcc.unicamp.br>
249 François Pinard <pinard@iro.umontreal.ca>
250 Artur Pioro <artur@flugor.if.uj.edu.pl>
251 Dan Rich <drich@morpheus.corp.sgi.com>
252 (contribute to evolve mime-image.el with XEmacs)
253 Katsumi Yamaoka <yamaoka@jpl.org>
254
README.ja
1[README for SEMI kernel package (日本語版)]
2
3SEMI とは?
4=========
5
6 SEMI は GNU Emacs に対して MIME 機能を提供するライブラリです。MIME は、
7 メッセージ内にプレーンテキスト (ASCII) 以外の内容やヘッダを含むものに
8 関して提案されたインターネット規格です。
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 は、以下の機能を持っています:
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 と MIME message compiser はさらに次の特徴を持って
22 います:
23
24 - filename handling by Content-Disposition field (RFC 1806)
25 - PGP/MIME security Multiparts (RFC 2015)
26 - application/pgp (draft-kazu-pgp-mime-00.txt; obsolete)
27 - text/richtext (RFC 1521; obsolete; preview only)
28 - text/enriched (RFC 1896)
29 - External method configuration by mailcap (RFC 1524)
30
31 このパッケージには MUAs に関する MIME 拡張は含まれていないことに注意
32 してください。これらは、別のパッケージとして配布されています。
33
34
35必要な環境
36==========
37
38 SEMI は、XEmacs 21.1 以降、および GNU Emacs 20.4 以降に対応しています。
39
40 SEMI は、GNU Emacs 19.28 または XEmacs 19.14 よりも古いものについては、
41 一切対応していません。加えて、SEMI は Mule 1, Mule 2 および GNU Emacs
42 20.1/20.2 などで実装されている byte-indexing では動作しません。
43
44 SEMI は、Emacs 19.29 から 19.34, XEmacs 19.15 または XEmacs 20.2 につ
45 いても対応はしていませんが、動くかもしれません。
46
47 SEMI は、APEL (10.7 以降) と FLIM (1.14.2 以降) を必要とします。 SEMI
48 をインストールする前に、これらをインストールしてください。APEL は、以
49 下で入手可能です。:
50
51 http://git.chise.org/elisp/dist/apel/
52
53 そして、FLIM は以下で入手可能です。:
54
55 http://git.chise.org/elisp/dist/flim/flim-1.14/
56
57
58インストール
59============
60
61(a) 展開した場所で実行する
62
63 もし、他のディレクトリにインストールすることを望まないならば、以下の
64 みを実行してください。:
65
66 % make
67
68 あなたは emacs コマンド名を指定することが可能です。例えば、
69
70 % make EMACS=xemacs
71
72 もし、`EMACS=...' が省略されると、EMACS=emacs が用いられます。
73
74(b) make install
75
76 もしあなたが、他のディレクトリにインストールすることを望むならば、以下
77 を実行してください。:
78
79 % make install
80
81 あなたは emacs コマンド名を指定することが可能です。例えば、
82
83 % make install EMACS=xemacs
84
85 もし、`EMACS=...' が省略されると、EMACS=emacs が用いられます。
86
87 あなたは、Emacs Lisp プログラムとシェルスクリプトに関するディレクトリ階
88 層の接頭語を指定することができます。たとえば、:
89
90 % make install PREFIX=~/
91
92 もし、`PREFIX=...' が省略されると、指定した emacs コマンドのディレク
93 トリ階層の接頭語が使用されます。(たぶん、/usr/local)
94
95 例えば、もし、PREFIX=/usr/local および、EMACS 19.34 が指定されると、
96 以下のようなディレクトリ階層が作成されるでしょう。:
97
98 /usr/local/share/emacs/19.34/site-lisp/ --- emu
99 /usr/local/share/emacs/site-lisp/apel/ --- APEL
100 /usr/local/share/emacs/site-lisp/flim/ --- FLIM
101 /usr/local/share/emacs/site-lisp/semi/ --- SEMI
102
103 あなたは、site-lisp のディレクトリを指定することができます。例えば、
104
105 % make install LISPDIR=~/share/emacs/lisp
106
107 もし、`LISPDIR=...' が省略されると、指定した emacs コマンドの
108 site-lisp ディレクトリが使用されます(たぶん、
109 /usr/local/share/emacs/site-lisp または
110 /usr/local/lib/xemacs/site-lisp)。
111
112 もし、emu モジュール (APEL に含まれている)が一般的ではないディレクト
113 リにインストールされている場合には、あなたは、これらがどこで見付けら
114 れるか指定する必要があります。:
115
116 % make install VERSION_SPECIFIC_LISPDIR=~/elisp
117
118(c) XEmacs package としてのインストール
119
120 もしあなたが、XEmacs package のディレクトリにインストールすることを望
121 むならば、以下を実行してください。:
122
123 % make install-package
124
125 あなたは、emacs command の名前を指定することができます。たとえば、:
126
127 % make install-package XEMACS=xemacs-21
128
129 もし、`XEMACS=...' が省略されると、XEMACS=xemacs が用いられます。
130
131 あなたは、package のディレクトリを指定することができます。たとえば、:
132
133 % make install PACKAGEDIR=~/.xemacs
134
135 もし、`PACKAGEDIR=...' が省略されると、最初に存在する package のディ
136 レクトリが使用されます。
137
138 XEmacs package システムは、XEmacs 21.0 以降を必要とすることに注意してく
139 ださい。
140
141(a,b,c)
142
143 あなたは、${archive}/SEMI-CFG というファイルを書き換えることにより、
144 他のオプションの設定を指定することができます。${archive}/README.en と
145 ${archive}/SEMI-CFG のコメントを読んでください。
146
147
148初期化
149======
150
151(a) load-path
152
153 あなたが XEmacs 21.1 以降あるいは GNU Emacs 20.4 以降を使用しているな
154 ら、load-path に関して必要な設定はありません。
155
156(b) mime-setup
157
158 あなたの ~/.emacs に以下の記述を追加してください。:
159
160 (load "mime-setup")
161
162
163付属資料
164========
165
166 SEMI を使い始めるために、${archive}/README.en を読んでください。
167
168 RFC 822, 1524, 1806, 1847, 1896, 2015, 2045, 2046, 2047, 2048 および
169 2049 は anonymous ftp を経由して入手可能です。:
170
171 ftp://ftp.merit.edu/internet/documents/rfc/
172
173
174メーリングリスト
175================
176
177 もし、あなたが、バグレポートおよび/または改良のための提案を書く場合には、
178 それらを Emacs-MIME メーリングリストに送ってください。
179
180 emacs-mime-en@lists.chise.org (英語)
181 emacs-mime-ja@lists.chise.org (日本語)
182
183 Emacs-MIME ML を通して、SEMI のバグを報告したり、SEMI の最新のリリー
184 スに関する情報を入手したり、SEMI の将来の拡張について議論することなど
185 ができます。Emacs-MIME ML に加入したい方は、以下の頁の記述を見て購読
186 手続きを行ってください：
187
188 http://lists.chise.org/mailman/listinfo/emacs-mime-ja （日本語）
189 http://lists.chise.org/mailman/listinfo/emacs-mime-en （英語）
190
191
192Git に基づいた開発
193==================
194
195 SEMI の開発には Git を用いており、次のような操作により SEMI の最新の
196 ソースを取得することができます。
197
198 % git clone http://git.chise.org/git/elisp/semi.git
199
200 この SEMI のリポジトリーは WWW 経由でも閲覧することができます：
201
202 http://git.chise.org/gitweb/?p=elisp/semi.git
203
204 Git に基づいた開発に参加したいときは、まず Emacs-MIME メーリングリス
205 トにてその旨を宣言してください。
206
207 我々は多くの方がこの開かれた開発に参加してくださることを望んでいます。
208
209
210作者
211====
212
213元の作者
214
215 MORIOKA Tomohiko <morioka@jaist.ac.jp>
216 (SEMI のいろいろな部分と mime-view の作者)
217 UMEDA Masanobu <umerin@mse.kyutech.ac.jp>
218 (emacs-mime-tools の mime.el の作者。mime.el は SEMI の
219 meme-edit.el の原型です)
220
221他の作者
222
223 Shuhei KOBAYASHI <shuhei-k@jaist.ac.jp>
224 (たくさんのコードと signature.el の主要な作者)
225 MASUTANI Yasuhiro <masutani@me.es.osaka-u.ac.jp>
226 (mime-play.el の anonymous ftp コード)
227 OKABE Yasuo <okabe@kudpc.kyoto-u.ac.jp>
228 (mime-partial.el と signature.el の主要な作者)
229
230 Steinar Bang <sb@metis.no>
231 Steven L. Baur <steve@miranova.com>
232 Kevin Broadey <KevinB@bartley.demon.co.uk>
233 Alastair Burt <burt@dfki.uni-kl.de>
234 Eric Ding <ericding@San-Jose.ate.slb.com>
235 Thierry Emery <Thierry.Emery@aar.alcatel-alsthom.fr>
236 Simon Josefsson <jas@pdc.kth.se>
237 Jens Lautenbacher <jtl@tkm.physik.uni-karlsruhe.de>
238 Carsten Leonhardt <leo@arioch.tng.oche.de>
239 Pekka Marjola <marjola@bilbo.ntc.nokia.com>
240 Hisashi Miyashita <himi@bird.scphys.kyoto-u.ac.jp>
241 Kazuhiro Ohta <ohta@ele.cst.nihon-u.ac.jp>
242 Alexandre Oliva <oliva@dcc.unicamp.br>
243 François Pinard <pinard@iro.umontreal.ca>
244 Artur Pioro <artur@flugor.if.uj.edu.pl>
245 Dan Rich <drich@morpheus.corp.sgi.com>
246 (XEmacs と共に mime-image.el を発展させるために寄与)
247 Katsumi Yamaoka <yamaoka@jpl.org>
248