README.eng

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