README.eng

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