README.eng

   1 [README for tm (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.eng,v 7.1 1995/10/18 18:18:19 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/tm-gnus_en.texi   : tm-gnus Reference Manual (TeXinfo)
  23
  24 (2) Japanese edition
  25
  26 - doc/tm_ja.tex         : tm Reference Manual (TeXinfo)
  27 - doc/tm-view_ja.texi   : tm-view Reference Manual (TeXinfo)
  28 - doc/tm-gnus_ja.texi   : tm-gnus Reference Manual (TeXinfo)
  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         - tm-view : MIME viewer
  38                 - tm-parse.el : MIME message parser
  39                 - tm-play.el  : MIME content player
  40         - tm-eword : MIME encoded-word encoder/decoder
  41                 - tm-ew-d.el : MIME encoded-word decoder
  42                 - tm-ew-e.el : MIME encoded-word encoder
  43         - tm-def  : definition module for tm
  44                 - tm-nemacs.el : NEmacs depended part of tm
  45                 - tm-orig.el   : FSF original Emacs and XEmacs
  46                                  depended part of tm
  47                 - tm-mule.el   : Mule depended part of tm
  48         - tm-MUAs : MIME extender for MUAs
  49                 - tm-mh-e  : tm-MUA for mh-e
  50                 - tm-gnus  : tm-MUA for GNUS
  51                 - tm-rmail : tm-MUA for RMAIL
  52                 - tm-vm    : tm-MUA for vm
  53         - preview filter for tm-view
  54                 - tm-rich    : for text/enriched and text/richtext
  55         - internal methods for tm-view
  56                 - tm-partial : automatic assembler for message/partial
  57                 - tm-ftp     : for anonymous ftp
  58                 - tm-w3      : for text/html (using w3)
  59                 - tm-tar     : for tar content
  60         - tm-comp : extender for mime.el (big message automatic
  61                     splitter, previewer using tm-view, uuencode supporter)
  62         - tm-setup: set up module for tm-MUAs
  63         - mime-setup: set up module for MIME
  64
  65         +---------+-----------------+------------------+
  66         | tm-MUAs | preview filters | internal methods |
  67         +---------+-----------------+------------------+
  68         |                tm-view                       |
  69         +-----------------------+-------+-----+--------+
  70         |       tm-word         |       |     |        |
  71         +-----------------------+       |     |        |
  72         |       tm-def                  |     |        |
  73         +-------------------------------+ MEL |external|
  74         |               tl              |     |        |
  75         +-------------------------------+     |methods |
  76         |               emu             |     |        |
  77         +-------------------------------+-----+        |
  78         |              Emacs variants         |        |
  79         +-------------------------------------+--------+
  80
  81
  82 4 Install
  83
  84 4.1 tm/config.tm
  85
  86   Please edit tm/config.tm file.
  87
  88
  89 4.2 External methods
  90
  91   Please edit external methods in `methods/' directory for your
  92 environment.
  93
  94
  95 4.3 make
  96
  97   Run `make all'.
  98
  99
 100 4.4 install
 101
 102   Run `make install'.
 103
 104
 105 4.5 Emacs Lisp modules
 106
 107   Run `make install-nemacs', if you use NEmacs.
 108
 109   Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*).
 110
 111   Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.
 112
 113   Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).
 114
 115   Or copy *.el to your emacs lisp directory.
 116
 117
 118 5 tm-MUA
 119
 120 5.1 tm-gnus
 121
 122 (1) Please edit tm/gnus/Makefile.
 123
 124     If you use GNUS 3.*, please edit tm/gnus/g3-path.
 125
 126     If you use GNUS 4.*, please edit tm/gnus/g4-path.
 127
 128     If you use (ding) Gnus, please edit tm/gnus/d-path.
 129
 130     If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
 131
 132     If you use September Gnus, please edit tm/gnus/s-path.
 133
 134 (2) make
 135
 136   Run `make gnus3', if you use GNUS 3.*.
 137
 138   Run `make gnus4', if you use GNUS 4.*.
 139
 140   Run `make dgnus', if you use (ding) GNUS.
 141
 142   Run `make gnus5', if you use Gnus 5.0.*.
 143
 144   Run `make sgnus', if you use September Gnus.
 145
 146 (3) install
 147
 148   Run `make install-18', if you use Emacs 18.*.
 149
 150   Run `make install-19', if you use Emacs 19.*.
 151
 152
 153 5.1.1 Gnus 5.0.6
 154
 155   If you want to use automatic MIME preview support, please apply a
 156 patch to Gnus 5.*. This patch is called `with September patch'. It
 157 provides September Gnus like article buffer feature.
 158
 159   It is available from ftp.jaist.ac.jp:/pub/GNU/elisp/dgnus/. Current
 160 version is gnus-5.0.6-September.diff.
 161
 162
 163 5.1.2 September Gnus
 164
 165   For current September Gnus, automatic MIME preview feature is
 166 available without any patches.
 167
 168
 169 5.2 tm-mh-e
 170
 171 (1) Please edit mh-e/Makefile
 172
 173 (2) make
 174
 175   Run `make nemacs', if you use NEmacs.
 176
 177   Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
 178
 179   Run `make orig19', if you use Original Emacs 19.* or XEmacs.
 180
 181   Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
 182
 183 (3) install
 184
 185   Run `make install-18', if you use Emacs 18.*.
 186
 187   Run `make install-19', if you use Emacs 19.*.
 188
 189
 190 6 .emacs
 191
 192 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
 193 you use mime-setup, you should prepare mime.el.
 194
 195 mime.el is included in emacs-mime-tools.shar written by UMEDA
 196 Masanobu. It is available by anonymous ftp:
 197
 198         ftp.kyutech.ac.jp       /pub/MultiMedia/mime/
 199         ftp.jaist.ac.jp         /pub/GNU/elisp/mime/
 200
 201 or a lot of anonymous ftp sites. Please try archie.
 202
 203 6.1 VM
 204
 205 If you want use vm, please insert following in .vm or .emacs:
 206
 207         (load "tm-vm")
 208
 209 6.2 XEmacs
 210
 211 In XEmacs, current mime.el can not work, so you should use tm-setup.el
 212 and another MIME composer, such as mime-compose.el. Following is a
 213 example:
 214
 215         (load "tm-setup")
 216         ;; (require 'mh-e) ; if you use mh-e, please use it.
 217         (load "mime-compose")
 218
 219 6.3 setting sample for hilit19
 220
 221 ======================================================================
 222 (cond (window-system
 223        (let* ((header-patterns '(("^Subject:.*$" nil msg-subject)
 224                                  ("^From:.*$" nil msg-from)
 225                                  ("^--text follows this line--$"
 226                                   nil msg-separator)
 227                                  ("^[A-Za-z][A-Za-z0-9-]+:" nil msg-header)
 228                                  ))
 229               (body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$"
 230                                 nil msg-quote)))
 231               (message-patterns (append header-patterns body-patterns))
 232               )
 233          (hilit-set-mode-patterns 'msg-header header-patterns)
 234          (hilit-set-mode-patterns 'msg-body body-patterns)
 235          (hilit-set-mode-patterns 'mime/viewer-mode
 236                                   message-patterns
 237                                   'hilit-rehighlight-message)
 238          )
 239        (add-hook 'mime-viewer/content-header-filter-hook
 240                  (function hilit-rehighlight-buffer-quietly))
 241        (add-hook 'mime-viewer/plain-text-preview-hook
 242                  (function hilit-rehighlight-buffer-quietly))
 243        ))
 244 ======================================================================
 245
 246
 247 7 How to use mime/viewer-mode
 248
 249 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
 250 `Z' key) in Summary mode. mime/viewer-mode has following functions:
 251
 252         q         quit from mime/viewer-mode
 253         u         move to upper content
 254         p         move to previous content
 255         n         move to next content
 256         SPC       scroll up or move to next content
 257         M-SPC     scroll down or move to previous content
 258         DEL       scroll down or move to previous content
 259         RET       move to next line
 260         M-RET     move to previous line
 261         v         play current content
 262         e         extract as file current content
 263         C-c C-p   print current content
 264         button-2  move to point under the mouse cursor and play
 265                   current content
 266
 267 8 Bug report
 268
 269 If you write bug-reports and/or propositions for improvement, please
 270 post them to following news groups:
 271
 272         fj.editor.emacs         (Japanese or English)
 273         fj.editor.mule          (Japanese or English; if you use Mule)
 274         gnu.emacs.help          (English)
 275         gnu.emacs.vm.info       (English; about tm-vm)
 276
 277 or send to tm ML:
 278
 279         tm@chamonix.jaist.ac.jp         (Japanese or English)
 280         tm-eng@chamonix.jaist.ac.jp     (English)
 281
 282 Via tm ML, You can report bugs of tm, obtain the latest release of tm
 283 package, and discuss the future enhancements to tm. To join tm ML,
 284 send a mail to
 285
 286         tm-admin@chamonix.jaist.ac.jp           (Japanese or English)
 287         tm-eng-admin@chamonix.jaist.ac.jp       (English)
 288
 289 Since the user registration is manually done, please write the mail
 290 body in human-recognizable language (^_^).
 291
 292
 293 9 TODO
 294
 295 - automatic MIME preview support for another MUA
 296 - better XEmacs support (e.g. inline image)
 297 - development of internal method for message/external-body based on
 298   tm-ftp
 299 - development good MIME composer
 300 - etc.