README.eng

   1 [README for tm (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.eng,v 1.1 1995/01/12 17:23:45 morioka Exp $
   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 4.0 install tl
  52
  53 Tm uses Emacs Lisp library ``tl'', so, at first, you install
  54 tl. Please read tl/README.eng.
  55
  56
  57 4.1 Makefile
  58
  59   Please edit Makefile.
  60
  61 4.1.1 specify Emacs executables
  62
  63   Please specify Emacs executable file name.
  64
  65         NEMACS  = for NEMACS (or NEpoch)
  66         MULE1   = for Mule 1.* (based on Emacs 18.*)
  67         ORIG19  = for Emacs 19.* (FSF original or XEmacs)
  68         MULE2   = for MULE 2.* (based on Emacs 19.*)
  69
  70 4.1.2 specify Emacs Lisp install path
  71
  72   Please specify Emacs Lisp install path.
  73
  74         TLDIR18 = for Emacs 18.* (NEMACS, NEpoch or MULE 1)
  75         TLDIR19 = for Emacs 19.* (FSF original, XEmacs or MULE 2)
  76
  77
  78 4.2 External methods
  79
  80   Edit external methods in `methods/' directory for your environment.
  81
  82
  83 4.3 make
  84
  85   Run `make all'.
  86
  87
  88 4.4 install
  89
  90   Run `make install'.
  91
  92
  93 4.5 Emacs Lisp modules
  94
  95   Run `make install-nemacs', if you use NEmacs.
  96
  97   Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*).
  98
  99   Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.
 100
 101   Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).
 102
 103   Or copy *.el to your emacs lisp directory.
 104
 105
 106 5 tm-MUA
 107
 108 5.1 tm-gnus
 109
 110 (1) Please edit gnus/Makefile
 111
 112 (2) make
 113
 114   Run `make nemacs', if you use NEmacs.
 115
 116   Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
 117
 118   Run `make orig19', if you use Original Emacs 19.* or XEmacs.
 119
 120   Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
 121
 122 (3) install
 123
 124   Run `make install-18', if you use Emacs 18.*.
 125
 126   Run `make install-19', if you use Emacs 19.*.
 127
 128
 129 5.1 tm-mh-e
 130
 131 (1) Please edit mh-e/Makefile
 132
 133 (2) make
 134
 135   Run `make nemacs', if you use NEmacs.
 136
 137   Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
 138
 139   Run `make orig19', if you use Original Emacs 19.* or XEmacs.
 140
 141   Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
 142
 143 (3) install
 144
 145   Run `make install-18', if you use Emacs 18.*.
 146
 147   Run `make install-19', if you use Emacs 19.*.
 148
 149
 150 5.2 tm-rmail or tm-vm
 151
 152   Please copy tm-rmail.el or tm-vm.el to Emacs Lisp install path.
 153
 154
 155 5 .emacs
 156
 157 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
 158 you use mime-setup, you should prepare mime.el.
 159
 160 If you want use vm, please insert following in .vm or .emacs:
 161
 162         (load "tm-vm")
 163
 164
 165 6 How to use mime/viewer-mode
 166
 167 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
 168 `Z' key) in Summary mode. mime/viewer-mode has following functions:
 169
 170         q       quit from mime/viewer-mode
 171         u       move to the upper content
 172         p       move to the previous content
 173         n       move to the next content
 174         SPC     scroll up
 175         M-SPC   scroll down
 176         v       play the content
 177         e       extract as file the content
 178         C-c C-p print the content