README.eng

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