[README for tm (English Version)]
by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-$Id: README.eng,v 7.0 1995/10/05 06:57:02 morioka Exp $
+and KOBAYASHI Shuhei <shuhei@cmpt01.phys.tohoku.ac.jp>
+$Id: README.eng,v 7.4 1995/12/06 09:21:07 morioka Exp $
1 What's tm?
-Tm is a MIME package for GNU Emacs. Tm has following functions:
+ 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
+ - MIME message composer (mime/editor-mode)
+ - MIME extenders for mh-e, GNUS, RMAIL and VM
2 Documents
-This package includes following 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/tm-gnus_en.texi : tm-gnus Reference Manual (TeXinfo)
+- 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)
(2) Japanese edition
-- doc/tm_ja.tex : tm Reference Manual (TeXinfo)
-- doc/tm-view_ja.texi : tm-view Reference Manual (TeXinfo)
-- doc/tm-eword_ja.texi : tm-eword.el Reference Manual (TeXinfo)
-- doc/tm-gnus_ja.texi : tm-gnus Reference Manual (TeXinfo)
-- doc/signature-jp.ol : signature.el Reference Manual (Emacs Outline)
-- doc/signature-jp.tex : signature.el Reference Manual (LaTeX)
+- 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/signature-jp.ol : signature.el Reference Manual (Emacs Outline)
+- tm/doc/signature-jp.tex: signature.el Reference Manual (LaTeX)
3 Modules
-Tm has following modules:
+ tm has following modules:
- tm-view : MIME viewer
- tm-parse.el : MIME message parser
- tm-play.el : MIME content player
- - tm-eword : MIME encoded-word encoder/decoder
- tm-ew-d.el : MIME encoded-word decoder
+ - preview filter for tm-view
+ - tm-rich : for text/enriched and text/richtext
+ - internal methods for tm-view
+ - tm-partial : automatic assembler for message/partial
+ - tm-ftp : for anonymous ftp
+ - tm-file : for file extraction
+ - tm-tar : for tar content
+ - tm-latex : for LaTeX
+ - tm-html : for text/html
+ - 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-gnus : tm-MUA for GNUS
- tm-rmail : tm-MUA for RMAIL
- tm-vm : tm-MUA for vm
- - preview filter for tm-view
- - tm-rich : for text/enriched and text/richtext
- - internal methods for tm-view
- - tm-partial : automatic assembler for message/partial
- - tm-ftp : for anonymous ftp
- - tm-w3 : for text/html (using w3)
- - tm-tar : for tar content
- - tm-comp : extender for mime.el (big message automatic
- splitter, previewer using tm-view, uuencode supporter)
- - tm-setup: set up module for tm-MUAs
+ - tm-mail : tm-MUA library module for mail-mode
- mime-setup: set up module for MIME
-
- +---------+-----------------+------------------+
- | tm-MUAs | preview filters | internal methods |
- +---------+-----------------+------------------+
- | tm-view |
- +-----------------------+-------+-----+--------+
- | tm-word | | | |
- +-----------------------+ | | |
- | tm-def | | |
- +-------------------------------+ MEL |external|
- | tl | | |
- +-------------------------------+ |methods |
- | emu | | |
- +-------------------------------+-----+ |
- | Emacs variants | |
- +-------------------------------------+--------+
+ - tm-setup: set up only reading
4 Install
4.2 External methods
- Please edit external methods in `methods/' directory for your
+ 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
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-18', if you use Emacs 18 (NEmacs, Mule 1.*).
- Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.
+ Run `make install-xemacs', if you use Emacs .. 19.28 (Mule 2.* based
+on), or XEmacs.
- Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).
+ Run `make install-19_29', if you use Emacs 19.29 or later (Mule 2.*
+based on).
Or copy *.el to your emacs lisp directory.
5.1 tm-gnus
-(1) Please edit tm/gnus/Makefile.
+ If you use optional GNUS or Gnus, you must edit and make manually.
- If you use GNUS 3.*, please edit tm/gnus/g3-path.
+(1) Please edit tm/gnus/Makefile.
- If you use GNUS 4.*, please edit tm/gnus/g4-path.
+ If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
- If you use (ding) Gnus, please edit tm/gnus/d-path.
+ If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
Run `make gnus4', if you use GNUS 4.*.
- Run `make dgnus', if you use (ding) GNUS.
-
Run `make gnus5', if you use Gnus 5.0.*.
Run `make sgnus', if you use September Gnus.
Run `make install-18', if you use Emacs 18.*.
- Run `make install-19', if you use Emacs 19.*.
+ Run `make install-19', if you use Emacs .. 19.28 or XEmacs.
+ Run `make install-19_29', if you use Emacs 19.29 or later.
-5.1.1 Gnus 5.0.6
- If you want to use automatic MIME preview support, please apply a
-patch to Gnus 5.*. This patch is called `with September patch'. It
-provides September Gnus like article buffer feature.
+5.1.1 automatic MIME preview support
- It is available from ftp.jaist.ac.jp:/pub/GNU/elisp/dgnus/. Current
-version is gnus-5.0.6-September.diff.
+ tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
+later, Gnus 5.0.*, Gnus 5.1, and September Gnus.
+ If you don't want to use automatic MIME preview feature, please
+insert following to ~/.emacs.
-5.1.2 September Gnus
+ (setq tm-gnus/automatic-mime-preview nil)
- For current September Gnus, automatic MIME preview feature is
-available without any patches.
+ 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.
-5.2 tm-mh-e
+ Gnus 5.0.*, 5.1 and September Gnus have a variable
+`gnus-strict-mime'. If you insert
-(1) Please edit mh-e/Makefile
+ (setq gnus-strict-mime nil)
-(2) make
+Gnus do MIME processing even if a message does not have Mime-Version
+field.
- Run `make nemacs', if you use NEmacs.
+ 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'.
- Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
- Run `make orig19', if you use Original Emacs 19.* or XEmacs.
+5.2 tm-mh-e
- Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
+ If you use optional mh-e, you must edit and make manually.
+
+(1) Please edit mh-e/Makefile
+
+(2) make
+
+ Run `make elc'.
(3) install
Run `make install-19', if you use Emacs 19.*.
+* 5.3 VM
-6 .emacs
-
-Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
-you use mime-setup, you should prepare mime.el.
+ If you use VM, please edit `mk-tm'.
-mime.el is included in emacs-mime-tools.shar written by UMEDA
-Masanobu. It is available by anonymous ftp:
- ftp.kyutech.ac.jp /pub/MultiMedia/mime/
- ftp.jaist.ac.jp /pub/GNU/elisp/mime/
+6 .emacs
-or a lot of anonymous ftp sites. Please try archie.
+ Please insert (load "mime-setup") in ~/.emacs.
6.1 VM
-If you want use vm, please insert following in .vm or .emacs:
-
- (load "tm-vm")
-
-6.2 XEmacs
+ If you use vm, please insert (require 'tm-vm) in ~/.vm.
-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:
+ tm works well with BBDB: If you use VM, please insert
+(require 'tm-vm) *after* (bbdb-insinuate-vm).
- (load "tm-setup")
- ;; (require 'mh-e) ; if you use mh-e, please use it.
- (load "mime-compose")
-6.3 setting sample for hilit19
+6.2 setting sample for hilit19
======================================================================
(cond (window-system
))
======================================================================
+6.3 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
+mime/viewer-mode. Following is setting sample:
+
+======================================================================
+(setq browse-url-browser-function
+ (if (eq window-system 'x)
+ 'browse-url-netscape
+ 'browse-url-w3))
+(autoload browse-url-browser-function "browse-url"
+ "Ask a WWW browser to show a URL." t)
+======================================================================
+
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:
+`Z' key) in Summary mode. Or automatic MIME previewed buffer's
+major-mode is mime/viewer-mode. mime/viewer-mode has following
+functions:
q quit from mime/viewer-mode
u move to upper content
e extract as file current content
C-c C-p print current content
button-2 move to point under the mouse cursor and play
- current content
+ current content or browse URL
+
8 Bug report
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:
- tm@chamonix.jaist.ac.jp (Japanese or English)
- tm-eng@chamonix.jaist.ac.jp (English)
+ bug-tm-en@chamonix.jaist.ac.jp (English)
+ bug-tm-ja@chamonix.jaist.ac.jp (Japanese)
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,
body in human-recognizable language (^_^).
-9 TODO
+9 How to get new version
+
+tm is available from following anonymous ftp site:
+
+ ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime/ (Japan)
+
+and its mirrors:
+
+ ftp://ftp.nis.co.jp/pub/gnu/emacs-lisp/tm/ (Japan)
+ ftp://ftp.nisiq.net/pub/gnu/emacs-lisp/tm/ (US)
+
+
+10 TODO
- automatic MIME preview support for another MUA
- better XEmacs support (e.g. inline image)
projects / elisp / tm.git / blobdiff