README.eng

   1 [README for tm (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.eng,v 6.0 1995/08/01 19:09:28 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, RMAIL and vm
  12
  13
  14 2 Documents
  15
  16 This package includes following documents.
  17
  18 (1) English edition
  19
  20 - doc/tm_en.texi        : tm Reference Manual (TeXinfo)
  21 - doc/tm-view_en.texi   : tm-view Reference Manual (TeXinfo)
  22 - doc/tiny-mime-eng.ol  : tiny-mime.el Reference Manual (Emacs Outline)
  23 - doc/tiny-mime-eng.tex : tiny-mime.el Reference Manual (LaTeX)
  24 - rel-6eng.ol   : notice about major changes of tm 6.* (Emacs Outline)
  25
  26 (2) Japanese edition
  27
  28 - doc/tm_ja.tex         : tm Reference Manual (TeXinfo)
  29 - doc/tm-view_ja.tex    : tm-view Reference Manual (TeXinfo)
  30 - doc/tm-eword_ja.texi  : tiny-mime.el Reference Manual (TeXinfo)
  31 - doc/signature-jp.ol   : signature.el Reference Manual (Emacs Outline)
  32 - doc/signature-jp.tex  : signature.el Reference Manual (LaTeX)
  33 - rel-6jp.ol    : notice about major changes of tm 6.* (Emacs Outline)
  34
  35
  36 3 Modules
  37
  38 Tm has following modules:
  39
  40         - tiny-mime : MIME header encoder/decoder
  41         - tm-view : MIME viewer
  42         - tm-misc : library module for tm-MUAs
  43         - tm-MUAs : MIME extender for MUAs
  44                 - tm-mh-e  : tm-MUA for mh-e
  45                 - tm-gnus  : tm-MUA for GNUS
  46                 - tm-rmail : tm-MUA for RMAIL
  47                 - tm-vm    : tm-MUA for vm
  48         - extender for tm-view
  49                 - tm-partial : automatic assembler for message/partial
  50                 - tm-ftp     : for anonymous ftp
  51                 - tm-rich    : for text/enriched and text/richtext
  52         - tm-comp : extender for mime.el (big message automatic
  53                         splitter, previewer using tm-view, uuencode
  54                         supporter)
  55         - tm-setup: set up module for tm-MUAs
  56         - mime-setup: set up module for MIME
  57
  58
  59 4 Install
  60
  61 4.0 install tl
  62
  63 Tm uses Emacs Lisp library ``tl'', so, at first, you install
  64 tl. Please read tl/README.eng.
  65
  66
  67 4.1 Makefile
  68
  69   Please edit Makefile.
  70
  71 4.1.1 specify Emacs executables
  72
  73   Please specify Emacs executable file name.
  74
  75         NEMACS  = for NEMACS (or NEpoch)
  76         MULE1   = for Mule 1.* (based on Emacs 18.*)
  77         ORIG19  = for Emacs 19.* (FSF original or XEmacs)
  78         MULE2   = for MULE 2.* (based on Emacs 19.*)
  79
  80 4.1.2 specify Emacs Lisp install path
  81
  82   Please specify Emacs Lisp install path.
  83
  84         TLDIR18 = for Emacs 18.* (NEMACS, NEpoch or MULE 1)
  85         TLDIR19 = for Emacs 19.* (FSF original, XEmacs or MULE 2)
  86
  87
  88 4.2 External methods
  89
  90   Edit external methods in `methods/' directory for your environment.
  91
  92
  93 4.3 make
  94
  95   Run `make all'.
  96
  97
  98 4.4 install
  99
 100   Run `make install'.
 101
 102
 103 4.5 Emacs Lisp modules
 104
 105   Run `make install-nemacs', if you use NEmacs.
 106
 107   Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*).
 108
 109   Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.
 110
 111   Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).
 112
 113   Or copy *.el to your emacs lisp directory.
 114
 115
 116 5 tm-MUA
 117
 118 5.1 tm-gnus
 119
 120 (1) Please edit gnus/Makefile
 121
 122 (2) make
 123
 124   Run `make gnus3', if you use GNUS 3.*.
 125
 126   Run `make gnus4', if you use GNUS 4.*.
 127
 128   Run `make dgnus', if you use (ding) GNUS.
 129
 130 (3) install
 131
 132   Run `make install-18', if you use Emacs 18.*.
 133
 134   Run `make install-19', if you use Emacs 19.*.
 135
 136
 137 5.1.1 (ding) GNUS
 138
 139   If you want to use automatic MIME preview support, please apply a
 140 patch to (ding) GNUS. This patch is called `with tm patch'. It is
 141 available from ftp.jaist.ac.jp:/pub/GNU/elisp/dgnus/. Current version
 142 is dgnus-0.98.6-tm.diff.
 143
 144
 145 5.1 tm-mh-e
 146
 147 (1) Please edit mh-e/Makefile
 148
 149 (2) make
 150
 151   Run `make nemacs', if you use NEmacs.
 152
 153   Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
 154
 155   Run `make orig19', if you use Original Emacs 19.* or XEmacs.
 156
 157   Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
 158
 159 (3) install
 160
 161   Run `make install-18', if you use Emacs 18.*.
 162
 163   Run `make install-19', if you use Emacs 19.*.
 164
 165
 166 5.2 tm-rmail or tm-vm
 167
 168   Please copy tm-rmail.el or tm-vm.el to Emacs Lisp install path.
 169
 170
 171 6 .emacs
 172
 173 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
 174 you use mime-setup, you should prepare mime.el.
 175
 176 6.1 VM
 177
 178 If you want use vm, please insert following in .vm or .emacs:
 179
 180         (load "tm-vm")
 181
 182 6.2 XEmacs
 183
 184 In XEmacs, current mime.el can not work, so you should use tm-setup.el
 185 and another MIME composer, such as mime-compose.el. Following is a
 186 example:
 187
 188         (load "tm-setup")
 189         ;; (require 'mh-e) ; if you use mh-e, please use it.
 190         (load "mime-compose")
 191
 192
 193 7 How to use mime/viewer-mode
 194
 195 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
 196 `Z' key) in Summary mode. mime/viewer-mode has following functions:
 197
 198         q       quit from mime/viewer-mode
 199         u       move to the upper content
 200         p       move to the previous content
 201         n       move to the next content
 202         SPC     scroll up
 203         M-SPC   scroll down
 204         v       play the content
 205         e       extract as file the content
 206         C-c C-p print the content
 207
 208
 209 8 Bug report
 210
 211 If you write bug-reports and/or propositions for improvement, please
 212 post them to following news groups:
 213
 214         fj.editor.emacs         (Japanese or English)
 215         fj.editor.mule          (Japanese or English; if you use Mule)
 216         gnu.emacs.help          (English)
 217         gnu.emacs.vm.info       (English; about tm-vm)
 218
 219 or send to tm ML:
 220
 221         tm@chamonix.jaist.ac.jp         (Japanese or English)
 222         tm-eng@chamonix.jaist.ac.jp     (English)
 223
 224 Via tm ML, You can report bugs of tm, obtain the latest release of tm
 225 package, and discuss the future enhancements to tm. To join tm ML,
 226 send a mail to
 227
 228         tm-admin@chamonix.jaist.ac.jp           (Japanese or English)
 229         tm-eng-admin@chamonix.jaist.ac.jp       (English)
 230
 231 Since the user registration is manually done, please write the mail
 232 body in human-recognizable language (^_^).
 233
 234
 235 9 TODO
 236
 237 - better XEmacs support (i.e. richtext filter or inline image)
 238 - multi frame support
 239 - improvement of tiny-mime
 240 - better uuencode support
 241 - development of internal method for message/external-body based on
 242   tm-ftp
 243 - development good MIME composer