README.eng

   1 [README for tm (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.eng,v 6.10 1995/09/09 05:56:08 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 (ding) GNUS or GNUS 5.*
 127
 128   If you want to use automatic MIME preview support, please apply a
 129 patch to (ding) GNUS or GNUS 5.*. This patch is called `with tm
 130 patch'. It is available from
 131 ftp.jaist.ac.jp:/pub/GNU/elisp/dgnus/. Current version is
 132 dgnus-0.99.23-tm.diff.
 133
 134
 135 5.1 tm-mh-e
 136
 137 (1) Please edit mh-e/Makefile
 138
 139 (2) make
 140
 141   Run `make nemacs', if you use NEmacs.
 142
 143   Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
 144
 145   Run `make orig19', if you use Original Emacs 19.* or XEmacs.
 146
 147   Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
 148
 149 (3) install
 150
 151   Run `make install-18', if you use Emacs 18.*.
 152
 153   Run `make install-19', if you use Emacs 19.*.
 154
 155
 156 6 .emacs
 157
 158 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
 159 you use mime-setup, you should prepare mime.el.
 160
 161 6.1 VM
 162
 163 If you want use vm, please insert following in .vm or .emacs:
 164
 165         (load "tm-vm")
 166
 167 6.2 XEmacs
 168
 169 In XEmacs, current mime.el can not work, so you should use tm-setup.el
 170 and another MIME composer, such as mime-compose.el. Following is a
 171 example:
 172
 173         (load "tm-setup")
 174         ;; (require 'mh-e) ; if you use mh-e, please use it.
 175         (load "mime-compose")
 176
 177 6.3 setting sample for hilit19
 178
 179 ======================================================================
 180 (cond (window-system
 181        (let* ((header-patterns '(("^Subject:.*$" nil msg-subject)
 182                                  ("^From:.*$" nil msg-from)
 183                                  ("^--text follows this line--$"
 184                                   nil msg-separator)
 185                                  ("^[A-Za-z][A-Za-z0-9-]+:" nil msg-header)
 186                                  ))
 187               (body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$"
 188                                 nil msg-quote)))
 189               (message-patterns (append header-patterns body-patterns))
 190               )
 191          (hilit-set-mode-patterns 'msg-header header-patterns)
 192          (hilit-set-mode-patterns 'msg-body body-patterns)
 193          (hilit-set-mode-patterns 'mime/viewer-mode
 194                                   message-patterns
 195                                   'hilit-rehighlight-message)
 196          )
 197        (add-hook 'mime-viewer/content-header-filter-hook
 198                  (function hilit-rehighlight-buffer-quietly))
 199        (add-hook 'mime-viewer/plain-text-preview-hook
 200                  (function hilit-rehighlight-buffer-quietly))
 201        ))
 202 ======================================================================
 203
 204
 205 7 How to use mime/viewer-mode
 206
 207 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
 208 `Z' key) in Summary mode. mime/viewer-mode has following functions:
 209
 210         q         quit from mime/viewer-mode
 211         u         move to upper content
 212         p         move to previous content
 213         n         move to next content
 214         SPC       scroll up or move to next content
 215         M-SPC     scroll down or move to previous content
 216         DEL       scroll down or move to previous content
 217         RET       move to next line
 218         M-RET     move to previous line
 219         v         play current content
 220         e         extract as file current content
 221         C-c C-p   print current content
 222         button-2  move to point under the mouse cursor and play
 223                   current content
 224
 225 8 Bug report
 226
 227 If you write bug-reports and/or propositions for improvement, please
 228 post them to following news groups:
 229
 230         fj.editor.emacs         (Japanese or English)
 231         fj.editor.mule          (Japanese or English; if you use Mule)
 232         gnu.emacs.help          (English)
 233         gnu.emacs.vm.info       (English; about tm-vm)
 234
 235 or send to tm ML:
 236
 237         tm@chamonix.jaist.ac.jp         (Japanese or English)
 238         tm-eng@chamonix.jaist.ac.jp     (English)
 239
 240 Via tm ML, You can report bugs of tm, obtain the latest release of tm
 241 package, and discuss the future enhancements to tm. To join tm ML,
 242 send a mail to
 243
 244         tm-admin@chamonix.jaist.ac.jp           (Japanese or English)
 245         tm-eng-admin@chamonix.jaist.ac.jp       (English)
 246
 247 Since the user registration is manually done, please write the mail
 248 body in human-recognizable language (^_^).
 249
 250
 251 9 TODO
 252
 253 - better XEmacs support (i.e. richtext filter or inline image)
 254 - multi frame support
 255 - improvement of tiny-mime
 256 - better uuencode support
 257 - development of internal method for message/external-body based on
 258   tm-ftp
 259 - development good MIME composer