1 [README for tm (English Version)]
2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
3 and KOBAYASHI Shuhei <shuhei-k@jaist.ac.jp>
4 $Id: README.en,v 7.19 1996/05/08 15:25:04 morioka Exp $
8 tm is a MIME package for GNU Emacs. tm has following functions:
10 - MIME style multilingual header
11 - MIME message viewer (mime/viewer-mode)
12 - MIME message composer (mime/editor-mode)
13 - MIME extenders for mh-e, GNUS, RMAIL and VM
18 This package includes following documents.
22 - tm/doc/tm_en.texi : tm Reference Manual (TeXinfo)
23 - tm/doc/tm-gnus_en.texi: tm-gnus Reference Manual (TeXinfo)
24 - tm/doc/tm-mh-e_en.texi: tm-mh-e Reference Manual (TeXinfo)
28 - tm/doc/tm_ja.tex : tm Reference Manual (TeXinfo)
29 - tm/doc/tm-gnus_ja.texi : tm-gnus Reference Manual (TeXinfo)
30 - tm/doc/tm-mh-e_ja.texi : tm-mh-e Reference Manual (TeXinfo)
31 - tm/doc/signature-jp.ol : signature.el Reference Manual (Emacs Outline)
32 - tm/doc/signature-jp.tex: signature.el Reference Manual (LaTeX)
37 tm has following modules:
39 - tm-view : MIME viewer
40 - tm-parse.el : MIME message parser
41 - tm-play.el : MIME content player
42 - tm-ew-d.el : MIME encoded-word decoder
43 - preview filter for tm-view
44 - tm-text : for text/*
45 - tm-image : for image/* and X-Face
46 - internal methods for tm-view
47 - tm-partial : automatic assembler for message/partial
48 - tm-ftp : for anonymous ftp
49 - tm-file : for file extraction
50 - tm-tar : for tar content
51 - tm-latex : for LaTeX
52 - tm-html : for text/html
54 - tm-edit : MIME composer (mime.el and tm-comp.el were merged)
55 - tm-ew-e.el : MIME encoded-word encoder
56 - tm-def : definition module for tm
57 - tm-MUAs : MIME extender for MUAs
58 - tm-mh-e : tm-MUA for mh-e
59 - tm-gnus : tm-MUA for GNUS
60 - tm-rmail : tm-MUA for RMAIL
61 - tm-vm : tm-MUA for vm
62 - tm-mail : tm-MUA library module for mail-mode
63 - mime-setup: set up module for MIME
64 - tm-setup: set up only reading
69 4.1 edit tm/TM-CFG (optional)
71 You can edit tm/TM-CFG file.
73 In default, tm is installed into /usr/local/. If you want to change,
74 please modify the variable `PREFIX'.
77 4.2 tm-gnus (optional)
79 If you use optional GNUS or Gnus, which is not included in Emacs
80 distribution, you must edit following files before make.
82 If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
84 If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
86 If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
88 If you use September Gnus, please edit tm/gnus/s-path.
91 4.3 edit external methods (optional)
93 You can edit external methods in `tm/methods/' directory for your
96 tm/methods/tm-au for audio
97 tm/methods/tm-file for file extraction
98 tm/methods/tm-image for image
99 tm/methods/tm-mpeg for MPEG
100 tm/methods/tm-plain for plain text
101 tm/methods/tm-html for HTML
102 tm/methods/tmdecode decoder
104 In default, tmdecode uses `mmencode' command. If you don't have
105 metamail package, please modify tmdecode to use decode-b instead of
113 You can specify Emacs command name, for example if you want to use
114 `mule' as Emacs command:
116 % make all EMACS=mule
123 You can specify Emacs command name, for example if you want to use
124 `xemacs' as Emacs command:
126 % make install EMACS=xemacs
131 Please insert `(load "mime-setup")' in ~/.emacs.
134 6.1 automatic MIME preview support
136 tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
137 later, Gnus 5.0.*, Gnus 5.1, and September Gnus.
139 If you don't want to use automatic MIME preview feature, please
140 insert following to ~/.emacs.
142 (setq tm-gnus/automatic-mime-preview nil)
144 In addition, September Gnus has automatic MIME preview supporting
145 feature. Of course, tm-gnus provides this feature for other GNUS and
146 Gnus, but it is unnatural.
148 When automatic MIME preview mode, GNUS and Gnus do MIME processing
149 if a message has a Mime-Version field. If it does not have, GNUS and
150 Gnus does not do MIME processing, in default.
152 Gnus 5.0.*, 5.1 and September Gnus have a variable
153 `gnus-strict-mime'. If you insert
155 (setq gnus-strict-mime nil)
157 Gnus do MIME processing even if a message does not have Mime-Version
160 In September Gnus, if `gnus-strict-mime' is not nil, variable
161 `gnus-decode-encoded-word-method' is called. tm-gnus uses it to decode
162 RFC 1522 encoded-word. So it is not necessary to reset
168 If you use vm, please insert `(require 'tm-vm)' in ~/.vm.
170 tm works well with BBDB: If you use VM, please insert
171 (require 'tm-vm) *after* (bbdb-insinuate-vm).
176 If you have PGP and Mailcrypt package, you can use PGP on
177 MIME. Currently, 2 drafts (draft-elkins-pem-pgp-02.txt and
178 draft-kazu-pgp-mime-00.txt) are proposed, so tm provides both way.
180 For decoding, please insert following into ~/.emacs:
182 ======================================================================
189 ======================================================================
191 tm-pgp.el is a internal method modules to support PGP.
193 For encoding, tm-edit provides 2 mechanism. One is for signing or
194 encrypting for message as application/pgp. There are two command
195 `mime-editor/set-sign' and `mime-editor/set-encrypt'. They set a
196 message is signed, encrypted or not.
198 Another one is for content. There are 2 kinds of enclosure for PGP:
199 ``signed'' and ``encrypted''. Their enclosure are bound to key and
200 menu. If you use this mechanism, please specify 2 variables:
201 `mime-editor/signing-type' and `mime-editor/encrypting-type'. They
202 requires following values:
204 pgp-elkins processed as draft-elkins-pem-pgp-02.txt
205 pgp-kazu processed as draft-kazu-pgp-mime-00.txt
208 If you use ``signed'' and ``encrypted'' as draft-elkins-pem-pgp-02.txt,
209 please insert following into ~/.emacs:
211 ======================================================================
212 (setq mime-editor/signing-type 'pgp-elkins)
213 (setq mime-editor/encrypting-type 'pgp-elkins)
214 ======================================================================
216 If you use ``signed'' and ``encrypted'' as draft-kazu-pgp-mime-00.txt,
217 please insert following into ~/.emacs:
219 ======================================================================
220 (setq mime-editor/signing-type 'pgp-kazu)
221 (setq mime-editor/encrypting-type 'pgp-kazu)
222 ======================================================================
225 6.4 setting sample for hilit19
227 ======================================================================
230 (let* ((csubject-patterns '(("^\\[.+\\]$" nil msg-subject)))
231 (header-patterns '(("^Subject:.*$" nil msg-subject)
232 ("^From:.*$" nil msg-from)
233 ("^--text follows this line--$"
235 ("^[A-Za-z][A-Za-z0-9-]+:" nil msg-header)
237 (body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$"
239 (message-patterns (append ;;csubject-patterns
243 (hilit-set-mode-patterns 'msg-header header-patterns)
244 (hilit-set-mode-patterns 'msg-body body-patterns)
245 (hilit-set-mode-patterns 'mime/viewer-mode
247 'hilit-rehighlight-message)
249 (add-hook 'mime-viewer/content-header-filter-hook
251 (if (not (eq mime::preview/original-major-mode
252 'gnus-original-article-mode))
253 (hilit-rehighlight-buffer-quietly)
255 (add-hook 'mime-viewer/plain-text-preview-hook
257 (if (not (eq mime::preview/original-major-mode
258 'gnus-original-article-mode))
259 (hilit-rehighlight-buffer-quietly)
262 ======================================================================
265 6.5 setting sample for browse-url
267 If you have browse-url.el (included in Gnus 5.*, September Gnus and
268 Emacs 19.30 or later), you can use URL button in
269 mime/viewer-mode. Following is setting sample:
271 ======================================================================
272 (setq browse-url-browser-function
273 (if (eq window-system 'x)
276 (autoload browse-url-browser-function "browse-url"
277 "Ask a WWW browser to show a URL." t)
278 ======================================================================
281 7 How to use mime/viewer-mode
283 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
284 `Z' key) in Summary mode. Or automatic MIME previewed buffer's
285 major-mode is mime/viewer-mode. mime/viewer-mode has following
288 q quit from mime/viewer-mode
289 u move to upper content
290 p move to previous content
291 n move to next content
292 SPC scroll up or move to next content
293 M-SPC scroll down or move to previous content
294 DEL scroll down or move to previous content
295 RET move to next line
296 M-RET move to previous line
297 < move to beginning of message
298 > move to end of message
299 v play current content
300 e extract as file current content
301 C-c C-p print current content
302 f display X-Face in current message
303 button-2 move to point under the mouse cursor and play
304 current content or browse URL
309 If you write bug-reports and/or propositions for improvement, please
310 post them to following news groups:
312 fj.editor.emacs (Japanese or English)
313 fj.editor.mule (Japanese or English; if you use Mule)
314 gnu.emacs.help (English)
316 fj.news.reader.gnus (Japanese or English; about GNUS and Gnus)
317 gnu.emacs.gnus (English; about GNUS and Gnus)
319 gnu.emacs.vm.info (English; about tm-vm)
323 bug-tm-en@chamonix.jaist.ac.jp (English)
324 bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
326 Via tm ML, You can report bugs of tm, obtain the latest release of tm
327 package, and discuss the future enhancements to tm. To join tm ML,
330 tm-admin@chamonix.jaist.ac.jp (Japanese or English)
331 tm-eng-admin@chamonix.jaist.ac.jp (English)
333 Since the user registration is manually done, please write the mail
334 body in human-recognizable language (^_^).
337 9 How to get new version
339 tm is available from following anonymous ftp site:
341 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime/ (Japan)
345 ftp://ftp.nis.co.jp/pub/gnu/emacs-lisp/tm/ (Japan)
346 ftp://ftp.nisiq.net/pub/gnu/emacs-lisp/tm/ (US)
351 - MUA specific key bind system for mime/viewer-mode
352 - better identification calculus system as successor of atype system
353 - development of internal method for message/external-body based on
355 - better automatic MIME preview support