tm 5.9
[elisp/tm.git] / README.eng
1 [README for tm (English Version)]
2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
3 1994/10/17
4
5 1 What's tm?
6
7 Tm is a MIME package for GNU Emacs. Tm has following functions:
8
9         - MIME style multilingual header
10         - MIME message viewer (mime/viewer-mode)
11         - MIME extenders for mh-e, GNUS and RMAIL
12
13
14 2 Documents
15
16 This package includes following documents.
17
18 (1) English edition
19
20 - doc/tm-eng.tex        : tm Reference Manual (LaTeX)
21 - doc/tiny-mime-eng.ol  : tiny-mime.el Reference Manual (Emacs Outline)
22 - doc/tiny-mime-eng.tex : tiny-mime.el Reference Manual (LaTeX)
23
24 (2) Japanese edition
25
26 - doc/tm-jp.tex         : tm Reference Manual (LaTeX)
27 - doc/tiny-mime-jp.ol   : tiny-mime.el Reference Manual (Emacs Outline)
28 - doc/tiny-mime-jp.tex  : tiny-mime.el Reference Manual (LaTeX)
29 - doc/signature-jp.ol   : signature.el Reference Manual (Emacs Outline)
30 - doc/signature-jp.tex  : signature.el Reference Manual (LaTeX)
31
32
33 3 Modules
34
35 Tm has following modules:
36
37         - tiny-mime : MIME header encoder/decoder
38         - tm-view : MIME viewer
39         - tm-misc : library module for tm-MUAs
40         - tm-MUAs : MIME extender for MUAs
41                 - tm-mh-e  : tm-MUA for mh-e
42                 - tm-gnus  : tm-MUA for GNUS
43                 - tm-rmail : tm-MUA for RMAIL
44                 - tm-vm    : tm-MUA for vm
45         - tm-setup: set up module for tm-MUAs
46         - mime-setup: set up module for MIME
47
48
49 4 Install
50
51 (1) Edit Makefile for your environment.
52
53 (2) Edit methods in `methods/' directory for your environment.
54
55 (3) Run `make all'.
56
57 (4) Run `make install'.
58
59 (5) Copy *.el to your emacs lisp directory.
60
61
62 5 .emacs
63
64 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
65 you use mime-setup, you should prepare mime.el.
66
67 If you want use vm, please insert following in .vm or .emacs:
68
69         (load "tm-vm")
70
71
72 6 How to use mime/viewer-mode
73
74 In tm-MUAs, you can use mime/viewer-mode if you press `v' key in
75 Summary mode. mime/viewer-mode has following functions:
76
77         u       move to the upper content
78         p       move to the previous content
79         n       move to the next content
80         SPC     scroll up
81         M-SPC   scroll down
82         v       play the content
83         e       extract as file the content
84         C-c C-p print the content