[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 $
+$Id: README.en,v 7.15 1996/03/06 02:12:36 morioka Exp $
1 What's tm?
(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-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
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.
+ In default, tm is installed into your home directory. If you want to
+install into /usr/local/, please modify the variable `PREFIX'.
-4.2 External methods
- Please edit external methods in `tm/methods/' directory for your
-environment.
-
- tm/methods/tm-au for audio
- tm/methods/tm-file for file extraction
- tm/methods/tm-image for image
- tm/methods/tm-mpeg for MPEG
- tm/methods/tm-plain for plain text
- tm/methods/tm-html for HTML
- tm/methods/tmdecode decoder
-
-
-4.3 make
-
- Run `make all'.
+4.2 tm-gnus (optional)
+ If you use optional GNUS or Gnus, which is not included in Emacs
+distribution, you must edit following files before make.
-4.4 install
-
- Run `make install'.
-
-
-4.5 Emacs Lisp modules
-
- Run `make install-18', if you use Emacs 18 (NEmacs, Mule 1.*).
+ If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
- Run `make install-xemacs', if you use Emacs .. 19.28 (Mule 2.* based
-on), or XEmacs.
+ If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
- Run `make install-19_29', if you use Emacs 19.29 or later (Mule 2.*
-based on).
+ If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
- Or copy *.el to your emacs lisp directory.
+ If you use September Gnus, please edit tm/gnus/s-path.
-5 tm-MUA
+4.3 edit external methods (optional)
-5.1 tm-gnus
+ You can edit external methods in `tm/methods/' directory for your
+environment.
- If you use optional GNUS or Gnus, you must edit and make manually.
+ tm/methods/tm-au for audio
+ tm/methods/tm-file for file extraction
+ tm/methods/tm-image for image
+ tm/methods/tm-mpeg for MPEG
+ tm/methods/tm-plain for plain text
+ tm/methods/tm-html for HTML
+ tm/methods/tmdecode decoder
-(1) Please edit tm/gnus/Makefile.
+ In default, tmdecode uses `mmencode' command. If you don't have
+metamail package, please modify tmdecode to use decode-b instead of
+mmencode.
- If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
- If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
+4.4 make
- If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
+ Run `make all'.
- If you use September Gnus, please edit tm/gnus/s-path.
+ You can specify Emacs command name, for example if you want to use
+`mule' as Emacs command:
-(2) make
+ % make all EMACS=mule
- Run `make gnus3', if you use GNUS 3.*.
- Run `make gnus4', if you use GNUS 4.*.
+4.5 install
- Run `make gnus5', if you use Gnus 5.0.*.
+ Run `make install'.
- Run `make sgnus', if you use September Gnus.
+ You can specify Emacs command name, for example if you want to use
+`xemacs' as Emacs command:
-(3) install
+ % make all EMACS=xemacs
- Run `make install-18', if you use Emacs 18.*.
- Run `make install-19', if you use Emacs .. 19.28 or XEmacs.
+6 .emacs
- Run `make install-19_29', if you use Emacs 19.29 or later.
+ Please insert (load "mime-setup") in ~/.emacs.
-5.1.1 automatic MIME preview support
+6.1 automatic MIME preview support
tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
later, Gnus 5.0.*, Gnus 5.1, and September Gnus.
(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
+feature. Of course, tm-gnus provides this feature for other GNUS and
Gnus, but it is unnatural.
When automatic MIME preview mode, GNUS and Gnus do MIME processing
`gnus-strict-mime'.
-5.2 tm-mh-e
+6.2 VM
- If you use optional mh-e, you must edit and make manually.
+ If you use vm, please insert `(require 'tm-vm)' in ~/.vm.
-(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.3 PGP
-(3) install
+ If you have PGP and Mailcrypt package, you can use PGP on
+MIME. Currently, 2 drafts (draft-elkins-pem-pgp-02.txt and
+draft-kazu-pgp-mime-00.txt) are proposed, so tm provides both way.
- Run `make install-18', if you use Emacs 18.*.
+ For decoding, please insert 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 a internal method modules to support PGP.
- If you use VM, please edit `mk-tm'.
+ For encoding, tm-edit provides 2 mechanism. One is for signing or
+encrypting for message as application/pgp. There are two command
+`mime-editor/set-sign' and `mime-editor/set-encrypt'. They set a
+message is signed, encrypted or not.
+ Another one is for content. There are 2 kinds of enclosure 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 draft-elkins-pem-pgp-02.txt
+ 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 draft-elkins-pem-pgp-02.txt,
+please insert following 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 following 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.4 setting 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.5 setting sample for browse
If you have browse-url.el (included in Gnus 5.*, September Gnus and
Emacs 19.30 or later), you can use URL button in
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
10 TODO
-- automatic MIME preview support for another MUA
-- better XEmacs support (e.g. inline image)
+- MUA specific key bind system for mime/viewer-mode
+- 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