README.eng

   1 [README for tm (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.eng,v 6.11 1995/09/20 17:16:09 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-def  : definition module for tm
  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.1 tm/config.tm
  62
  63   Please edit tm/config.tm file.
  64
  65
  66 4.2 External methods
  67
  68   Please edit external methods in `methods/' directory for your
  69 environment.
  70
  71
  72 4.3 make
  73
  74   Run `make all'.
  75
  76
  77 4.4 install
  78
  79   Run `make install'.
  80
  81
  82 4.5 Emacs Lisp modules
  83
  84   Run `make install-nemacs', if you use NEmacs.
  85
  86   Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*).
  87
  88   Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.
  89
  90   Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).
  91
  92   Or copy *.el to your emacs lisp directory.
  93
  94
  95 5 tm-MUA
  96
  97 5.1 tm-gnus
  98
  99 (1) Please edit gnus/Makefile.
 100
 101     If you use GNUS 3.*, please edit gnus/g3-path.
 102
 103     If you use GNUS 4.*, please edit gnus/g4-path.
 104
 105     If you use (ding) GNUS, please edit gnus/d-path.
 106
 107     If you use GNUS 5.*, please edit gnus/g5-path.
 108
 109 (2) make
 110
 111   Run `make gnus3', if you use GNUS 3.*.
 112
 113   Run `make gnus4', if you use GNUS 4.*.
 114
 115   Run `make dgnus', if you use (ding) GNUS.
 116
 117   Run `make gnus5', if you use GNUS 5.*.
 118
 119 (3) install
 120
 121   Run `make install-18', if you use Emacs 18.*.
 122
 123   Run `make install-19', if you use Emacs 19.*.
 124
 125
 126 5.1.1 Gnus 5.*
 127
 128   If you want to use automatic MIME preview support, please apply a
 129 patch to Gnus 5.*. This patch is called `with tm patch'. It is
 130 available from ftp.jaist.ac.jp:/pub/GNU/elisp/dgnus/. Current version
 131 is gnus-5.0.4-tm.diff.
 132
 133
 134 5.2 tm-mh-e
 135
 136 (1) Please edit mh-e/Makefile
 137
 138 (2) make
 139
 140   Run `make nemacs', if you use NEmacs.
 141
 142   Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
 143
 144   Run `make orig19', if you use Original Emacs 19.* or XEmacs.
 145
 146   Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
 147
 148 (3) install
 149
 150   Run `make install-18', if you use Emacs 18.*.
 151
 152   Run `make install-19', if you use Emacs 19.*.
 153
 154
 155 6 .emacs
 156
 157 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
 158 you use mime-setup, you should prepare mime.el.
 159
 160 mime.el is included in emacs-mime-tools.shar written by UMEDA
 161 Masanobu. It is available by anonymous ftp:
 162
 163         ftp.kyutech.ac.jp       /pub/MultiMedia/mime/
 164         ftp.jaist.ac.jp         /pub/GNU/elisp/mime/
 165
 166 or a lot of anonymous ftp sites. Please try archie.
 167
 168 6.1 VM
 169
 170 If you want use vm, please insert following in .vm or .emacs:
 171
 172         (load "tm-vm")
 173
 174 6.2 XEmacs
 175
 176 In XEmacs, current mime.el can not work, so you should use tm-setup.el
 177 and another MIME composer, such as mime-compose.el. Following is a
 178 example:
 179
 180         (load "tm-setup")
 181         ;; (require 'mh-e) ; if you use mh-e, please use it.
 182         (load "mime-compose")
 183
 184 6.3 setting sample for hilit19
 185
 186 ======================================================================
 187 (cond (window-system
 188        (let* ((header-patterns '(("^Subject:.*$" nil msg-subject)
 189                                  ("^From:.*$" nil msg-from)
 190                                  ("^--text follows this line--$"
 191                                   nil msg-separator)
 192                                  ("^[A-Za-z][A-Za-z0-9-]+:" nil msg-header)
 193                                  ))
 194               (body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$"
 195                                 nil msg-quote)))
 196               (message-patterns (append header-patterns body-patterns))
 197               )
 198          (hilit-set-mode-patterns 'msg-header header-patterns)
 199          (hilit-set-mode-patterns 'msg-body body-patterns)
 200          (hilit-set-mode-patterns 'mime/viewer-mode
 201                                   message-patterns
 202                                   'hilit-rehighlight-message)
 203          )
 204        (add-hook 'mime-viewer/content-header-filter-hook
 205                  (function hilit-rehighlight-buffer-quietly))
 206        (add-hook 'mime-viewer/plain-text-preview-hook
 207                  (function hilit-rehighlight-buffer-quietly))
 208        ))
 209 ======================================================================
 210
 211
 212 7 How to use mime/viewer-mode
 213
 214 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
 215 `Z' key) in Summary mode. mime/viewer-mode has following functions:
 216
 217         q         quit from mime/viewer-mode
 218         u         move to upper content
 219         p         move to previous content
 220         n         move to next content
 221         SPC       scroll up or move to next content
 222         M-SPC     scroll down or move to previous content
 223         DEL       scroll down or move to previous content
 224         RET       move to next line
 225         M-RET     move to previous line
 226         v         play current content
 227         e         extract as file current content
 228         C-c C-p   print current content
 229         button-2  move to point under the mouse cursor and play
 230                   current content
 231
 232 8 Bug report
 233
 234 If you write bug-reports and/or propositions for improvement, please
 235 post them to following news groups:
 236
 237         fj.editor.emacs         (Japanese or English)
 238         fj.editor.mule          (Japanese or English; if you use Mule)
 239         gnu.emacs.help          (English)
 240         gnu.emacs.vm.info       (English; about tm-vm)
 241
 242 or send to tm ML:
 243
 244         tm@chamonix.jaist.ac.jp         (Japanese or English)
 245         tm-eng@chamonix.jaist.ac.jp     (English)
 246
 247 Via tm ML, You can report bugs of tm, obtain the latest release of tm
 248 package, and discuss the future enhancements to tm. To join tm ML,
 249 send a mail to
 250
 251         tm-admin@chamonix.jaist.ac.jp           (Japanese or English)
 252         tm-eng-admin@chamonix.jaist.ac.jp       (English)
 253
 254 Since the user registration is manually done, please write the mail
 255 body in human-recognizable language (^_^).
 256
 257
 258 9 TODO
 259
 260 - better XEmacs support (i.e. richtext filter or inline image)
 261 - multi frame support
 262 - improvement of tiny-mime
 263 - better uuencode support
 264 - development of internal method for message/external-body based on
 265   tm-ftp
 266 - development good MIME composer