[README for tm (English Version)] by MORIOKA Tomohiko $Id: README.eng,v 6.8 1995/09/04 00:53:42 morioka Exp $ 1 What's tm? Tm is a MIME package for GNU Emacs. Tm has following functions: - MIME style multilingual header - MIME message viewer (mime/viewer-mode) - MIME extenders for mh-e, GNUS, RMAIL and vm 2 Documents This package includes following documents. (1) English edition - doc/tm_en.texi : tm Reference Manual (TeXinfo) - doc/tm-view_en.texi : tm-view Reference Manual (TeXinfo) - doc/tiny-mime-eng.ol : tiny-mime.el Reference Manual (Emacs Outline) - doc/tiny-mime-eng.tex : tiny-mime.el Reference Manual (LaTeX) - rel-6eng.ol : notice about major changes of tm 6.* (Emacs Outline) (2) Japanese edition - doc/tm_ja.tex : tm Reference Manual (TeXinfo) - doc/tm-view_ja.tex : tm-view Reference Manual (TeXinfo) - doc/tm-eword_ja.texi : tiny-mime.el Reference Manual (TeXinfo) - doc/signature-jp.ol : signature.el Reference Manual (Emacs Outline) - doc/signature-jp.tex : signature.el Reference Manual (LaTeX) - rel-6jp.ol : notice about major changes of tm 6.* (Emacs Outline) 3 Modules Tm has following modules: - tiny-mime : MIME header encoder/decoder - tm-view : MIME viewer - tm-def : definition module for 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 - extender for tm-view - tm-partial : automatic assembler for message/partial - tm-ftp : for anonymous ftp - tm-rich : for text/enriched and text/richtext - tm-comp : extender for mime.el (big message automatic splitter, previewer using tm-view, uuencode supporter) - tm-setup: set up module for tm-MUAs - mime-setup: set up module for MIME 4 Install 4.0 install tl Tm uses Emacs Lisp library ``tl'', so, at first, you install tl. Please read tl/README.eng. 4.1 Makefile Please edit Makefile. 4.1.1 specify Emacs executables Please specify Emacs executable file name. NEMACS = for NEMACS (or NEpoch) MULE1 = for Mule 1.* (based on Emacs 18.*) ORIG19 = for Emacs 19.* (FSF original or XEmacs) MULE2 = for MULE 2.* (based on Emacs 19.*) 4.1.2 specify Emacs Lisp install path Please specify Emacs Lisp install path. TLDIR18 = for Emacs 18.* (NEMACS, NEpoch or MULE 1) TLDIR19 = for Emacs 19.* (FSF original, XEmacs or MULE 2) 4.2 External methods Edit external methods in `methods/' directory for your environment. 4.3 make Run `make all'. 4.4 install Run `make install'. 4.5 Emacs Lisp modules Run `make install-nemacs', if you use NEmacs. Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*). Run `make install-orig19', if you use Original Emacs 19.* or XEmacs. Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*). Or copy *.el to your emacs lisp directory. 5 tm-MUA 5.1 tm-gnus (1) Please edit gnus/Makefile. If you use GNUS 3.*, please edit gnus/g3-path. If you use GNUS 4.*, please edit gnus/g4-path. If you use (ding) GNUS, please edit gnus/d-path. If you use GNUS 5.*, please edit gnus/g5-path. (2) make Run `make gnus3', if you use GNUS 3.*. Run `make gnus4', if you use GNUS 4.*. Run `make dgnus', if you use (ding) GNUS. Run `make gnus5', if you use GNUS 5.*. (3) install Run `make install-18', if you use Emacs 18.*. Run `make install-19', if you use Emacs 19.*. 5.1.1 (ding) GNUS or GNUS 5.* If you want to use automatic MIME preview support, please apply a patch to (ding) GNUS or GNUS 5.*. This patch is called `with tm patch'. It is available from ftp.jaist.ac.jp:/pub/GNU/elisp/dgnus/. Current version is dgnus-0.99.23-tm.diff. 5.1 tm-mh-e (1) Please edit mh-e/Makefile (2) make Run `make nemacs', if you use NEmacs. Run `make mule1', if you use Mule 1.* (based on Emacs 18.*). Run `make orig19', if you use Original Emacs 19.* or XEmacs. Run `make mule2', if you use Mule 2.* (based on Emacs 19.*). (3) install Run `make install-18', if you use Emacs 18.*. Run `make install-19', if you use Emacs 19.*. 6 .emacs Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If you use mime-setup, you should prepare mime.el. 6.1 VM If you want use vm, please insert following in .vm or .emacs: (load "tm-vm") 6.2 XEmacs In XEmacs, current mime.el can not work, so you should use tm-setup.el and another MIME composer, such as mime-compose.el. Following is a example: (load "tm-setup") ;; (require 'mh-e) ; if you use mh-e, please use it. (load "mime-compose") 6.3 setting sample for hilit19 ====================================================================== (cond (window-system (let* ((header-patterns '(("^Subject:.*$" nil msg-subject) ("^From:.*$" nil msg-from) ("^--text follows this line--$" nil msg-separator) ("^[A-Za-z][A-Za-z0-9-]+:" nil msg-header) )) (body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$" nil msg-quote))) (message-patterns (append header-patterns body-patterns)) ) (hilit-set-mode-patterns 'msg-header header-patterns) (hilit-set-mode-patterns 'msg-body body-patterns) (hilit-set-mode-patterns 'mime/viewer-mode message-patterns 'hilit-rehighlight-message) ) (add-hook 'mime-viewer/content-header-filter-hook (function hilit-rehighlight-buffer-quietly)) (add-hook 'mime-viewer/plain-text-preview-hook (function hilit-rehighlight-buffer-quietly)) )) ====================================================================== 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. mime/viewer-mode has following functions: q quit from mime/viewer-mode u move to the upper content p move to the previous content n move to the next content SPC scroll up M-SPC scroll down v play the content e extract as file the content C-c C-p print the content 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) gnu.emacs.vm.info (English; about tm-vm) or send to tm ML: tm@chamonix.jaist.ac.jp (Japanese or English) tm-eng@chamonix.jaist.ac.jp (English) Via tm ML, You can report bugs of tm, obtain the latest release of tm 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) Since the user registration is manually done, please write the mail body in human-recognizable language (^_^). 9 TODO - better XEmacs support (i.e. richtext filter or inline image) - multi frame support - improvement of tiny-mime - better uuencode support - development of internal method for message/external-body based on tm-ftp - development good MIME composer