1 [README for tm (English Version)]
2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
3 and KOBAYASHI Shuhei <shuhei@cmpt01.phys.tohoku.ac.jp>
4 $Id: README.en,v 7.5 1995/12/07 11:24:57 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-view_en.texi: tm-view Reference Manual (TeXinfo)
24 - tm/doc/tm-gnus_en.texi: tm-gnus Reference Manual (TeXinfo)
28 - tm/doc/tm_ja.tex : tm Reference Manual (TeXinfo)
29 - tm/doc/tm-view_ja.texi : tm-view Reference Manual (TeXinfo)
30 - tm/doc/tm-gnus_ja.texi : tm-gnus 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-rich : for text/enriched and text/richtext
45 - internal methods for tm-view
46 - tm-partial : automatic assembler for message/partial
47 - tm-ftp : for anonymous ftp
48 - tm-file : for file extraction
49 - tm-tar : for tar content
50 - tm-latex : for LaTeX
51 - tm-html : for text/html
52 - tm-edit : MIME composer (mime.el and tm-comp.el were merged)
53 - tm-ew-e.el : MIME encoded-word encoder
54 - tm-def : definition module for tm
55 - tm-nemacs.el : NEmacs depended part of tm
56 - tm-orig.el : FSF original Emacs and XEmacs
58 - tm-mule.el : Mule depended part of tm
59 - tm-MUAs : MIME extender for MUAs
60 - tm-mh-e : tm-MUA for mh-e
61 - tm-gnus : tm-MUA for GNUS
62 - tm-rmail : tm-MUA for RMAIL
63 - tm-vm : tm-MUA for vm
64 - tm-mail : tm-MUA library module for mail-mode
65 - mime-setup: set up module for MIME
66 - tm-setup: set up only reading
73 Please edit tm/config.tm file.
78 Please edit external methods in `tm/methods/' directory for your
81 tm/methods/tm-au for audio
82 tm/methods/tm-file for file extraction
83 tm/methods/tm-image for image
84 tm/methods/tm-mpeg for MPEG
85 tm/methods/tm-plain for plain text
86 tm/methods/tm-html for HTML
87 tm/methods/tmdecode decoder
100 4.5 Emacs Lisp modules
102 Run `make install-18', if you use Emacs 18 (NEmacs, Mule 1.*).
104 Run `make install-xemacs', if you use Emacs .. 19.28 (Mule 2.* based
107 Run `make install-19_29', if you use Emacs 19.29 or later (Mule 2.*
110 Or copy *.el to your emacs lisp directory.
117 If you use optional GNUS or Gnus, you must edit and make manually.
119 (1) Please edit tm/gnus/Makefile.
121 If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
123 If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
125 If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
127 If you use September Gnus, please edit tm/gnus/s-path.
131 Run `make gnus3', if you use GNUS 3.*.
133 Run `make gnus4', if you use GNUS 4.*.
135 Run `make gnus5', if you use Gnus 5.0.*.
137 Run `make sgnus', if you use September Gnus.
141 Run `make install-18', if you use Emacs 18.*.
143 Run `make install-19', if you use Emacs .. 19.28 or XEmacs.
145 Run `make install-19_29', if you use Emacs 19.29 or later.
148 5.1.1 automatic MIME preview support
150 tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
151 later, Gnus 5.0.*, Gnus 5.1, and September Gnus.
153 If you don't want to use automatic MIME preview feature, please
154 insert following to ~/.emacs.
156 (setq tm-gnus/automatic-mime-preview nil)
158 In addition, September Gnus has automatic MIME preview supporting
159 feature. Of course, tm-gnus provide this feature for other GNUS and
160 Gnus, but it is unnatural.
162 When automatic MIME preview mode, GNUS and Gnus do MIME processing
163 if a message has a Mime-Version field. If it does not have, GNUS and
164 Gnus does not do MIME processing, in default.
166 Gnus 5.0.*, 5.1 and September Gnus have a variable
167 `gnus-strict-mime'. If you insert
169 (setq gnus-strict-mime nil)
171 Gnus do MIME processing even if a message does not have Mime-Version
174 In September Gnus, if `gnus-strict-mime' is not nil, variable
175 `gnus-decode-encoded-word-method' is called. tm-gnus uses it to decode
176 RFC 1522 encoded-word. So it is not necessary to reset
182 If you use optional mh-e, you must edit and make manually.
184 (1) Please edit mh-e/Makefile
192 Run `make install-18', if you use Emacs 18.*.
194 Run `make install-19', if you use Emacs 19.*.
198 If you use VM, please edit `mk-tm'.
203 Please insert (load "mime-setup") in ~/.emacs.
207 If you use vm, please insert (require 'tm-vm) in ~/.vm.
209 tm works well with BBDB: If you use VM, please insert
210 (require 'tm-vm) *after* (bbdb-insinuate-vm).
213 6.2 setting sample for hilit19
215 ======================================================================
217 (let* ((header-patterns '(("^Subject:.*$" nil msg-subject)
218 ("^From:.*$" nil msg-from)
219 ("^--text follows this line--$"
221 ("^[A-Za-z][A-Za-z0-9-]+:" nil msg-header)
223 (body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$"
225 (message-patterns (append header-patterns body-patterns))
227 (hilit-set-mode-patterns 'msg-header header-patterns)
228 (hilit-set-mode-patterns 'msg-body body-patterns)
229 (hilit-set-mode-patterns 'mime/viewer-mode
231 'hilit-rehighlight-message)
233 (add-hook 'mime-viewer/content-header-filter-hook
234 (function hilit-rehighlight-buffer-quietly))
235 (add-hook 'mime-viewer/plain-text-preview-hook
236 (function hilit-rehighlight-buffer-quietly))
238 ======================================================================
240 6.3 setting sample for browse
242 If you have browse-url.el (included in Gnus 5.*, September Gnus and
243 Emacs 19.30 or later), you can use URL button in
244 mime/viewer-mode. Following is setting sample:
246 ======================================================================
247 (setq browse-url-browser-function
248 (if (eq window-system 'x)
251 (autoload browse-url-browser-function "browse-url"
252 "Ask a WWW browser to show a URL." t)
253 ======================================================================
256 7 How to use mime/viewer-mode
258 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
259 `Z' key) in Summary mode. Or automatic MIME previewed buffer's
260 major-mode is mime/viewer-mode. mime/viewer-mode has following
263 q quit from mime/viewer-mode
264 u move to upper content
265 p move to previous content
266 n move to next content
267 SPC scroll up or move to next content
268 M-SPC scroll down or move to previous content
269 DEL scroll down or move to previous content
270 RET move to next line
271 M-RET move to previous line
272 v play current content
273 e extract as file current content
274 C-c C-p print current content
275 button-2 move to point under the mouse cursor and play
276 current content or browse URL
281 If you write bug-reports and/or propositions for improvement, please
282 post them to following news groups:
284 fj.editor.emacs (Japanese or English)
285 fj.editor.mule (Japanese or English; if you use Mule)
286 gnu.emacs.help (English)
288 fj.news.reader.gnus (Japanese or English; about GNUS and Gnus)
289 gnu.emacs.gnus (English; about GNUS and Gnus)
291 gnu.emacs.vm.info (English; about tm-vm)
295 bug-tm-en@chamonix.jaist.ac.jp (English)
296 bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
298 Via tm ML, You can report bugs of tm, obtain the latest release of tm
299 package, and discuss the future enhancements to tm. To join tm ML,
302 tm-admin@chamonix.jaist.ac.jp (Japanese or English)
303 tm-eng-admin@chamonix.jaist.ac.jp (English)
305 Since the user registration is manually done, please write the mail
306 body in human-recognizable language (^_^).
309 9 How to get new version
311 tm is available from following anonymous ftp site:
313 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime/ (Japan)
317 ftp://ftp.nis.co.jp/pub/gnu/emacs-lisp/tm/ (Japan)
318 ftp://ftp.nisiq.net/pub/gnu/emacs-lisp/tm/ (US)
323 - automatic MIME preview support for another MUA
324 - better XEmacs support (e.g. inline image)
325 - development of internal method for message/external-body based on
327 - development good MIME composer