README.eng

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