[README for tm (English Version)]
by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-and KOBAYASHI Shuhei <shuhei@cmpt01.phys.tohoku.ac.jp>
-$Id: README.en,v 7.5 1995/12/07 11:24:57 morioka Exp $
+and KOBAYASHI Shuhei <shuhei-k@jaist.ac.jp>
+$Id: README.en,v 7.25 1996/12/02 16:07:55 morioka Exp $
1 What's tm?
- MIME style multilingual header
- MIME message viewer (mime/viewer-mode)
- MIME message composer (mime/editor-mode)
- - MIME extenders for mh-e, GNUS, RMAIL and VM
+ - MIME extenders for mh-e, GNUS, Gnus, RMAIL and VM
2 Documents
- This package includes following documents.
+ This package includes the following documents.
(1) English edition
- tm/doc/tm_en.texi : tm Reference Manual (TeXinfo)
-- tm/doc/tm-view_en.texi: tm-view Reference Manual (TeXinfo)
- tm/doc/tm-gnus_en.texi: tm-gnus Reference Manual (TeXinfo)
+- tm/doc/tm-mh-e_en.texi: tm-mh-e Reference Manual (TeXinfo)
(2) Japanese edition
- tm/doc/tm_ja.tex : tm Reference Manual (TeXinfo)
-- tm/doc/tm-view_ja.texi : tm-view Reference Manual (TeXinfo)
- tm/doc/tm-gnus_ja.texi : tm-gnus Reference Manual (TeXinfo)
+- tm/doc/tm-mh-e_ja.texi : tm-mh-e Reference Manual (TeXinfo)
- tm/doc/signature-jp.ol : signature.el Reference Manual (Emacs Outline)
- tm/doc/signature-jp.tex: signature.el Reference Manual (LaTeX)
- tm-play.el : MIME content player
- tm-ew-d.el : MIME encoded-word decoder
- preview filter for tm-view
- - tm-rich : for text/enriched and text/richtext
+ - tm-text : for text/*
+ - tm-image : for image/* and X-Face
- internal methods for tm-view
- tm-partial : automatic assembler for message/partial
- tm-ftp : for anonymous ftp
- tm-tar : for tar content
- tm-latex : for LaTeX
- tm-html : for text/html
+ - tm-pgp : for PGP
- tm-edit : MIME composer (mime.el and tm-comp.el were merged)
- tm-ew-e.el : MIME encoded-word encoder
- tm-def : definition module for tm
- - tm-nemacs.el : NEmacs depended part of tm
- - tm-orig.el : FSF original Emacs and XEmacs
- depended part of tm
- - tm-mule.el : Mule depended part of tm
- tm-MUAs : MIME extender for MUAs
- - tm-mh-e : tm-MUA for mh-e
- - tm-gnus : tm-MUA for GNUS
- - tm-rmail : tm-MUA for RMAIL
- - tm-vm : tm-MUA for vm
- - tm-mail : tm-MUA library module for mail-mode
+ - tm-mh-e : tm-MUA for mh-e
+ - gnus-mime : tm-MUA for Gnus
+ - tm-gnus : tm-MUA for GNUS
+ - tm-rmail : tm-MUA for RMAIL
+ - tm-vm : tm-MUA for vm
+ - tm-mail : tm-MUA library module for mail-mode
- mime-setup: set up module for MIME
- tm-setup: set up only reading
4 Install
-4.1 tm/config.tm
+4.1 edit tm/TM-CFG (optional)
- Please edit tm/config.tm file.
+ You can edit tm/TM-CFG file.
+ By default, tm is installed into /usr/local/. If you want to change this,
+please modify the variables `PREFIX' and `EXEC_PREFIX'.
-4.2 External methods
- Please edit external methods in `tm/methods/' directory for your
+4.2 edit external methods (optional)
+
+ You can edit external methods in `tm/methods/' directory for your
environment.
tm/methods/tm-au for audio
tm/methods/tm-html for HTML
tm/methods/tmdecode decoder
+ By default, tmdecode uses the `mmencode' command, which is part of
+the metamail package (available by anonymous ftp from
+ftp://thumper.bellcore.com/pub/nsb). If you don't have the metamail
+package, please modify tmdecode to use decode-b instead of mmencode.
+
4.3 make
Run `make all'.
+ You can specify the Emacs command name, for example if you want to use
+`mule' as the Emacs command:
-4.4 install
-
- Run `make install'.
-
-
-4.5 Emacs Lisp modules
-
- Run `make install-18', if you use Emacs 18 (NEmacs, Mule 1.*).
-
- Run `make install-xemacs', if you use Emacs .. 19.28 (Mule 2.* based
-on), or XEmacs.
-
- Run `make install-19_29', if you use Emacs 19.29 or later (Mule 2.*
-based on).
+ % make all EMACS=mule
- Or copy *.el to your emacs lisp directory.
+4.4 install
-5 tm-MUA
+ Run `make install'.
-5.1 tm-gnus
+ You can specify the Emacs command name, for example if you want to use
+`xemacs' as the Emacs command:
- If you use optional GNUS or Gnus, you must edit and make manually.
+ % make install EMACS=xemacs
-(1) Please edit tm/gnus/Makefile.
- If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
+6 .emacs
- If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
+ Please insert `(load "mime-setup")' in ~/.emacs.
- If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
- If you use September Gnus, please edit tm/gnus/s-path.
+6.1 gnus-mime
-(2) make
+ gnus-mime provides automatic MIME preview feature for Gnus.
- Run `make gnus3', if you use GNUS 3.*.
+ If you don't want to use automatic MIME preview feature, please
+insert in ~/.emacs:
- Run `make gnus4', if you use GNUS 4.*.
+ (setq gnus-show-mime nil)
- Run `make gnus5', if you use Gnus 5.0.*.
+ In addition, Gnus 5.2 is designed to support automatic MIME preview
+feature. Of course, gnus-mime provides this feature for Gnus 5.0.*
+and Gnus 5.1.*, but it is unnatural.
- Run `make sgnus', if you use September Gnus.
+ When automatic MIME preview mode, Gnus do MIME processing if a
+message has a Mime-Version field. If it does not have one, Gnus does
+not do MIME processing, in default.
-(3) install
+ Gnus 5.0.*, 5.1 and Gnus 5.2 have a variable `gnus-strict-mime'. If
+you insert
- Run `make install-18', if you use Emacs 18.*.
+ (setq gnus-strict-mime nil)
- Run `make install-19', if you use Emacs .. 19.28 or XEmacs.
+Gnus does MIME processing even if a message does not have a
+Mime-Version field.
- Run `make install-19_29', if you use Emacs 19.29 or later.
+ In Gnus 5.2, if `gnus-strict-mime' is not nil, variable
+`gnus-decode-encoded-word-method' is called. gnus-mime uses it to
+decode RFC 2047 encoded-words. So it is not necessary to reset
+`gnus-strict-mime'.
-5.1.1 automatic MIME preview support
+6.2 tm-gnus
tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
-later, Gnus 5.0.*, Gnus 5.1, and September Gnus.
+later.
If you don't want to use automatic MIME preview feature, please
-insert following to ~/.emacs.
+insert in ~/.emacs:
(setq tm-gnus/automatic-mime-preview nil)
- In addition, September Gnus has automatic MIME preview supporting
-feature. Of course, tm-gnus provide this feature for other GNUS and
-Gnus, but it is unnatural.
-
- When automatic MIME preview mode, GNUS and Gnus do MIME processing
-if a message has a Mime-Version field. If it does not have, GNUS and
-Gnus does not do MIME processing, in default.
-
- Gnus 5.0.*, 5.1 and September Gnus have a variable
-`gnus-strict-mime'. If you insert
-
- (setq gnus-strict-mime nil)
-
-Gnus do MIME processing even if a message does not have Mime-Version
-field.
-
- In September Gnus, if `gnus-strict-mime' is not nil, variable
-`gnus-decode-encoded-word-method' is called. tm-gnus uses it to decode
-RFC 1522 encoded-word. So it is not necessary to reset
-`gnus-strict-mime'.
+6.3 VM
-5.2 tm-mh-e
+ If you use vm, please insert `(require 'tm-vm)' in ~/.vm.
- If you use optional mh-e, you must edit and make manually.
-
-(1) Please edit mh-e/Makefile
+ tm works well with BBDB: If you use VM, please insert
+(require 'tm-vm) *after* (bbdb-insinuate-vm).
-(2) make
- Run `make elc'.
+6.4 PGP
-(3) install
+ If you have the PGP and Mailcrypt packages, you can use PGP with
+MIME. Currently, PGP/MIME (RFC 2015) and draft-kazu-pgp-mime-00.txt
+are proposed, so tm provides both ways.
- Run `make install-18', if you use Emacs 18.*.
+ For decoding, please insert the following into ~/.emacs:
- Run `make install-19', if you use Emacs 19.*.
+======================================================================
+(call-after-loaded
+ 'tm-view
+ (function
+ (lambda ()
+ (require 'tm-pgp)
+ )))
+======================================================================
-5.3 VM
+tm-pgp.el is an internal method module to support PGP.
- If you use VM, please edit `mk-tm'.
+ For encoding, tm-edit provides 2 mechanisms. One is for signing or
+encrypting for message as application/pgp. There are two commands,
+`mime-editor/set-sign' and `mime-editor/set-encrypt'. They set a
+message as signed, encrypted or not.
+ Another one is for content. There are 2 kinds of enclosures for PGP:
+``signed'' and ``encrypted''. Their enclosure are bound to key and
+menu. If you use this mechanism, please specify 2 variables:
+`mime-editor/signing-type' and `mime-editor/encrypting-type'. They
+requires following values:
-6 .emacs
+ pgp-elkins processed as PGP/MIME (RFC 2015)
+ pgp-kazu processed as draft-kazu-pgp-mime-00.txt
+ nil not processed
- Please insert (load "mime-setup") in ~/.emacs.
+If you use ``signed'' and ``encrypted'' as PGP/MIME, please insert
+into ~/.emacs:
-6.1 VM
+======================================================================
+(setq mime-editor/signing-type 'pgp-elkins)
+(setq mime-editor/encrypting-type 'pgp-elkins)
+======================================================================
- If you use vm, please insert (require 'tm-vm) in ~/.vm.
+If you use ``signed'' and ``encrypted'' as draft-kazu-pgp-mime-00.txt,
+please insert into ~/.emacs:
- tm works well with BBDB: If you use VM, please insert
-(require 'tm-vm) *after* (bbdb-insinuate-vm).
+======================================================================
+(setq mime-editor/signing-type 'pgp-kazu)
+(setq mime-editor/encrypting-type 'pgp-kazu)
+======================================================================
-6.2 setting sample for hilit19
+6.5 code sample for hilit19
======================================================================
(cond (window-system
- (let* ((header-patterns '(("^Subject:.*$" nil msg-subject)
+ (require 'hilit19)
+ (let* ((csubject-patterns '(("^\\[.+\\]$" nil msg-subject)))
+ (header-patterns '(("^Subject:.*$" nil msg-subject)
("^From:.*$" nil msg-from)
("^--text follows this line--$"
nil msg-separator)
))
(body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$"
nil msg-quote)))
- (message-patterns (append header-patterns body-patterns))
+ (message-patterns (append ;;csubject-patterns
+ header-patterns
+ body-patterns))
)
(hilit-set-mode-patterns 'msg-header header-patterns)
(hilit-set-mode-patterns 'msg-body body-patterns)
'hilit-rehighlight-message)
)
(add-hook 'mime-viewer/content-header-filter-hook
- (function hilit-rehighlight-buffer-quietly))
+ (lambda ()
+ (if (not (eq mime::preview/original-major-mode
+ 'gnus-original-article-mode))
+ (hilit-rehighlight-buffer-quietly)
+ )))
(add-hook 'mime-viewer/plain-text-preview-hook
- (function hilit-rehighlight-buffer-quietly))
+ (lambda ()
+ (if (not (eq mime::preview/original-major-mode
+ 'gnus-original-article-mode))
+ (hilit-rehighlight-buffer-quietly)
+ )))
))
======================================================================
-6.3 setting sample for browse
+
+6.6 code sample for browse-url
If you have browse-url.el (included in Gnus 5.*, September Gnus and
Emacs 19.30 or later), you can use URL button in
-mime/viewer-mode. Following is setting sample:
+mime/viewer-mode. Sample code follows:
======================================================================
(setq browse-url-browser-function
7 How to use mime/viewer-mode
-In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
-`Z' key) in Summary mode. Or automatic MIME previewed buffer's
+In tm-MUAs, you can use mime/viewer-mode if you press the `v' key (in
+VM, `Z' key) in Summary mode. Or automatic MIME previewed buffer's
major-mode is mime/viewer-mode. mime/viewer-mode has following
functions:
DEL scroll down or move to previous content
RET move to next line
M-RET move to previous line
+ < move to beginning of message
+ > move to end of message
v play current content
e extract as file current content
C-c C-p print current content
+ f display X-Face in current message
button-2 move to point under the mouse cursor and play
current content or browse URL
8 Bug report
If you write bug-reports and/or propositions for improvement, please
-post them to following news groups:
-
- fj.editor.emacs (Japanese or English)
- fj.editor.mule (Japanese or English; if you use Mule)
- gnu.emacs.help (English)
-
- fj.news.reader.gnus (Japanese or English; about GNUS and Gnus)
- gnu.emacs.gnus (English; about GNUS and Gnus)
-
- gnu.emacs.vm.info (English; about tm-vm)
-
-or send to tm ML:
+send to tm ML:
bug-tm-en@chamonix.jaist.ac.jp (English)
bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
package, and discuss the future enhancements to tm. To join tm ML,
send a mail to
- tm-admin@chamonix.jaist.ac.jp (Japanese or English)
- tm-eng-admin@chamonix.jaist.ac.jp (English)
+ tm-ja-admin@chamonix.jaist.ac.jp (Japanese)
+ tm-en-admin@chamonix.jaist.ac.jp (English)
Since the user registration is manually done, please write the mail
body in human-recognizable language (^_^).
-9 How to get new version
+9 How to get the latest version
tm is available from following anonymous ftp site:
10 TODO
-- automatic MIME preview support for another MUA
-- better XEmacs support (e.g. inline image)
+- better identification calculus system as successor of atype system
- development of internal method for message/external-body based on
tm-ftp
-- development good MIME composer
+- better automatic MIME preview support
- etc.
projects / elisp / tm.git / blobdiff