README.eng

   1 [README for tm (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 and KOBAYASHI Shuhei <shuhei@cmpt01.phys.tohoku.ac.jp>
   4 $Id: README.eng,v 7.4 1995/12/06 09:21:07 morioka Exp $
   5
   6 1 What's tm?
   7
   8   tm is a MIME package for GNU Emacs. tm has following functions:
   9
  10         - MIME style multilingual header
  11         - MIME message viewer (mime/viewer-mode)
  12         - MIME message composer (mime/editor-mode)
  13         - MIME extenders for mh-e, GNUS, RMAIL and VM
  14
  15
  16 2 Documents
  17
  18   This package includes following documents.
  19
  20 (1) English edition
  21
  22 - tm/doc/tm_en.texi     : tm Reference Manual (TeXinfo)
  23 - tm/doc/tm-view_en.texi: tm-view Reference Manual (TeXinfo)
  24 - tm/doc/tm-gnus_en.texi: tm-gnus Reference Manual (TeXinfo)
  25
  26 (2) Japanese edition
  27
  28 - tm/doc/tm_ja.tex       : tm Reference Manual (TeXinfo)
  29 - tm/doc/tm-view_ja.texi : tm-view Reference Manual (TeXinfo)
  30 - tm/doc/tm-gnus_ja.texi : tm-gnus Reference Manual (TeXinfo)
  31 - tm/doc/signature-jp.ol : signature.el Reference Manual (Emacs Outline)
  32 - tm/doc/signature-jp.tex: signature.el Reference Manual (LaTeX)
  33
  34
  35 3 Modules
  36
  37   tm has following modules:
  38
  39         - tm-view : MIME viewer
  40                 - tm-parse.el : MIME message parser
  41                 - tm-play.el  : MIME content player
  42                 - tm-ew-d.el : MIME encoded-word decoder
  43         - preview filter for tm-view
  44                 - tm-rich    : for text/enriched and text/richtext
  45         - internal methods for tm-view
  46                 - tm-partial : automatic assembler for message/partial
  47                 - tm-ftp     : for anonymous ftp
  48                 - tm-file    : for file extraction
  49                 - tm-tar     : for tar content
  50                 - tm-latex   : for LaTeX
  51                 - tm-html    : for text/html
  52         - tm-edit : MIME composer (mime.el and tm-comp.el were merged)
  53                 - tm-ew-e.el : MIME encoded-word encoder
  54         - tm-def  : definition module for tm
  55                 - tm-nemacs.el : NEmacs depended part of tm
  56                 - tm-orig.el   : FSF original Emacs and XEmacs
  57                                  depended part of tm
  58                 - tm-mule.el   : Mule depended part of tm
  59         - tm-MUAs : MIME extender for MUAs
  60                 - tm-mh-e  : tm-MUA for mh-e
  61                 - tm-gnus  : tm-MUA for GNUS
  62                 - tm-rmail : tm-MUA for RMAIL
  63                 - tm-vm    : tm-MUA for vm
  64                 - tm-mail  : tm-MUA library module for mail-mode
  65         - mime-setup: set up module for MIME
  66                 - tm-setup: set up only reading
  67
  68
  69 4 Install
  70
  71 4.1 tm/config.tm
  72
  73   Please edit tm/config.tm file.
  74
  75
  76 4.2 External methods
  77
  78   Please edit external methods in `tm/methods/' directory for your
  79 environment.
  80
  81         tm/methods/tm-au        for audio
  82         tm/methods/tm-file      for file extraction
  83         tm/methods/tm-image     for image
  84         tm/methods/tm-mpeg      for MPEG
  85         tm/methods/tm-plain     for plain text
  86         tm/methods/tm-html      for HTML
  87         tm/methods/tmdecode     decoder
  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-18', if you use Emacs 18 (NEmacs, Mule 1.*).
 103
 104   Run `make install-xemacs', if you use Emacs .. 19.28 (Mule 2.* based
 105 on), or XEmacs.
 106
 107   Run `make install-19_29', if you use Emacs 19.29 or later (Mule 2.*
 108 based on).
 109
 110   Or copy *.el to your emacs lisp directory.
 111
 112
 113 5 tm-MUA
 114
 115 5.1 tm-gnus
 116
 117   If you use optional GNUS or Gnus, you must edit and make manually.
 118
 119 (1) Please edit tm/gnus/Makefile.
 120
 121     If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
 122
 123     If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
 124
 125     If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
 126
 127     If you use September Gnus, please edit tm/gnus/s-path.
 128
 129 (2) make
 130
 131   Run `make gnus3', if you use GNUS 3.*.
 132
 133   Run `make gnus4', if you use GNUS 4.*.
 134
 135   Run `make gnus5', if you use Gnus 5.0.*.
 136
 137   Run `make sgnus', if you use September Gnus.
 138
 139 (3) install
 140
 141   Run `make install-18', if you use Emacs 18.*.
 142
 143   Run `make install-19', if you use Emacs .. 19.28 or XEmacs.
 144
 145   Run `make install-19_29', if you use Emacs 19.29 or later.
 146
 147
 148 5.1.1 automatic MIME preview support
 149
 150   tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
 151 later, Gnus 5.0.*, Gnus 5.1, and September Gnus.
 152
 153   If you don't want to use automatic MIME preview feature, please
 154 insert following to ~/.emacs.
 155
 156         (setq tm-gnus/automatic-mime-preview nil)
 157
 158   In addition, September Gnus has automatic MIME preview supporting
 159 feature. Of course, tm-gnus provide this feature for other GNUS and
 160 Gnus, but it is unnatural.
 161
 162   When automatic MIME preview mode, GNUS and Gnus do MIME processing
 163 if a message has a Mime-Version field. If it does not have, GNUS and
 164 Gnus does not do MIME processing, in default.
 165
 166   Gnus 5.0.*, 5.1 and September Gnus have a variable
 167 `gnus-strict-mime'. If you insert
 168
 169         (setq gnus-strict-mime nil)
 170
 171 Gnus do MIME processing even if a message does not have Mime-Version
 172 field.
 173
 174   In September Gnus, if `gnus-strict-mime' is not nil, variable
 175 `gnus-decode-encoded-word-method' is called. tm-gnus uses it to decode
 176 RFC 1522 encoded-word. So it is not necessary to reset
 177 `gnus-strict-mime'.
 178
 179
 180 5.2 tm-mh-e
 181
 182   If you use optional mh-e, you must edit and make manually.
 183
 184 (1) Please edit mh-e/Makefile
 185
 186 (2) make
 187
 188   Run `make elc'.
 189
 190 (3) install
 191
 192   Run `make install-18', if you use Emacs 18.*.
 193
 194   Run `make install-19', if you use Emacs 19.*.
 195
 196 * 5.3 VM
 197
 198   If you use VM, please edit `mk-tm'.
 199
 200
 201 6 .emacs
 202
 203   Please insert (load "mime-setup") in ~/.emacs.
 204
 205 6.1 VM
 206
 207   If you use vm, please insert (require 'tm-vm) in ~/.vm.
 208
 209   tm works well with BBDB: If you use VM, please insert
 210 (require 'tm-vm) *after* (bbdb-insinuate-vm).
 211
 212
 213 6.2 setting sample for hilit19
 214
 215 ======================================================================
 216 (cond (window-system
 217        (let* ((header-patterns '(("^Subject:.*$" nil msg-subject)
 218                                  ("^From:.*$" nil msg-from)
 219                                  ("^--text follows this line--$"
 220                                   nil msg-separator)
 221                                  ("^[A-Za-z][A-Za-z0-9-]+:" nil msg-header)
 222                                  ))
 223               (body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$"
 224                                 nil msg-quote)))
 225               (message-patterns (append header-patterns body-patterns))
 226               )
 227          (hilit-set-mode-patterns 'msg-header header-patterns)
 228          (hilit-set-mode-patterns 'msg-body body-patterns)
 229          (hilit-set-mode-patterns 'mime/viewer-mode
 230                                   message-patterns
 231                                   'hilit-rehighlight-message)
 232          )
 233        (add-hook 'mime-viewer/content-header-filter-hook
 234                  (function hilit-rehighlight-buffer-quietly))
 235        (add-hook 'mime-viewer/plain-text-preview-hook
 236                  (function hilit-rehighlight-buffer-quietly))
 237        ))
 238 ======================================================================
 239
 240 6.3 setting sample for browse
 241
 242   If you have browse-url.el (included in Gnus 5.*, September Gnus and
 243 Emacs 19.30 or later), you can use URL button in
 244 mime/viewer-mode. Following is setting sample:
 245
 246 ======================================================================
 247 (setq browse-url-browser-function
 248       (if (eq window-system 'x)
 249           'browse-url-netscape
 250         'browse-url-w3))
 251 (autoload browse-url-browser-function "browse-url"
 252   "Ask a WWW browser to show a URL." t)
 253 ======================================================================
 254
 255
 256 7 How to use mime/viewer-mode
 257
 258 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
 259 `Z' key) in Summary mode. Or automatic MIME previewed buffer's
 260 major-mode is mime/viewer-mode. mime/viewer-mode has following
 261 functions:
 262
 263         q         quit from mime/viewer-mode
 264         u         move to upper content
 265         p         move to previous content
 266         n         move to next content
 267         SPC       scroll up or move to next content
 268         M-SPC     scroll down or move to previous content
 269         DEL       scroll down or move to previous content
 270         RET       move to next line
 271         M-RET     move to previous line
 272         v         play current content
 273         e         extract as file current content
 274         C-c C-p   print current content
 275         button-2  move to point under the mouse cursor and play
 276                   current content or browse URL
 277
 278
 279 8 Bug report
 280
 281 If you write bug-reports and/or propositions for improvement, please
 282 post them to following news groups:
 283
 284         fj.editor.emacs         (Japanese or English)
 285         fj.editor.mule          (Japanese or English; if you use Mule)
 286         gnu.emacs.help          (English)
 287
 288         fj.news.reader.gnus     (Japanese or English; about GNUS and Gnus)
 289         gnu.emacs.gnus          (English; about GNUS and Gnus)
 290
 291         gnu.emacs.vm.info       (English; about tm-vm)
 292
 293 or send to tm ML:
 294
 295         bug-tm-en@chamonix.jaist.ac.jp  (English)
 296         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 297
 298 Via tm ML, You can report bugs of tm, obtain the latest release of tm
 299 package, and discuss the future enhancements to tm. To join tm ML,
 300 send a mail to
 301
 302         tm-admin@chamonix.jaist.ac.jp           (Japanese or English)
 303         tm-eng-admin@chamonix.jaist.ac.jp       (English)
 304
 305 Since the user registration is manually done, please write the mail
 306 body in human-recognizable language (^_^).
 307
 308
 309 9 How to get new version
 310
 311 tm is available from following anonymous ftp site:
 312
 313         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime/       (Japan)
 314
 315 and its mirrors:
 316
 317         ftp://ftp.nis.co.jp/pub/gnu/emacs-lisp/tm/      (Japan)
 318         ftp://ftp.nisiq.net/pub/gnu/emacs-lisp/tm/      (US)
 319
 320
 321 10 TODO
 322
 323 - automatic MIME preview support for another MUA
 324 - better XEmacs support (e.g. inline image)
 325 - development of internal method for message/external-body based on
 326   tm-ftp
 327 - development good MIME composer
 328 - etc.