README.eng

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