README.eng

   1 [README for tm (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.eng,v 2.0 1995/05/19 12:54:14 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-eng.tex        : tm Reference Manual (LaTeX)
  21 - doc/tiny-mime-eng.ol  : tiny-mime.el Reference Manual (Emacs Outline)
  22 - doc/tiny-mime-eng.tex : tiny-mime.el Reference Manual (LaTeX)
  23 - rel-6eng.ol   : notice about major changes of tm 6.* (Emacs Outline)
  24
  25 (2) Japanese edition
  26
  27 - doc/tm-jp.tex         : tm Reference Manual (LaTeX)
  28 - doc/tiny-mime-jp.ol   : tiny-mime.el Reference Manual (Emacs Outline)
  29 - doc/tiny-mime-jp.tex  : tiny-mime.el Reference Manual (LaTeX)
  30 - doc/signature-jp.ol   : signature.el Reference Manual (Emacs Outline)
  31 - doc/signature-jp.tex  : signature.el Reference Manual (LaTeX)
  32 - rel-6jp.ol    : notice about major changes of tm 6.* (Emacs Outline)
  33
  34 3 Modules
  35
  36 Tm has following modules:
  37
  38         - tiny-mime : MIME header encoder/decoder
  39         - tm-view : MIME viewer
  40         - tm-misc : library module for tm-MUAs
  41         - tm-MUAs : MIME extender for MUAs
  42                 - tm-mh-e  : tm-MUA for mh-e
  43                 - tm-gnus  : tm-MUA for GNUS
  44                 - tm-rmail : tm-MUA for RMAIL
  45                 - tm-vm    : tm-MUA for vm
  46         - extender for tm-view
  47                 - tm-partial : automatic assembler for message/partial
  48                 - tm-ftp     : for anonymous ftp
  49                 - tm-rich    : for text/enriched and text/richtext
  50         - tm-comp : extender for mime.el (big message automatic
  51                         splitter, previewer using tm-view, uuencode
  52                         supporter)
  53         - tm-setup: set up module for tm-MUAs
  54         - mime-setup: set up module for MIME
  55
  56
  57 4 Install
  58
  59 4.0 install tl
  60
  61 Tm uses Emacs Lisp library ``tl'', so, at first, you install
  62 tl. Please read tl/README.eng.
  63
  64
  65 4.1 Makefile
  66
  67   Please edit Makefile.
  68
  69 4.1.1 specify Emacs executables
  70
  71   Please specify Emacs executable file name.
  72
  73         NEMACS  = for NEMACS (or NEpoch)
  74         MULE1   = for Mule 1.* (based on Emacs 18.*)
  75         ORIG19  = for Emacs 19.* (FSF original or XEmacs)
  76         MULE2   = for MULE 2.* (based on Emacs 19.*)
  77
  78 4.1.2 specify Emacs Lisp install path
  79
  80   Please specify Emacs Lisp install path.
  81
  82         TLDIR18 = for Emacs 18.* (NEMACS, NEpoch or MULE 1)
  83         TLDIR19 = for Emacs 19.* (FSF original, XEmacs or MULE 2)
  84
  85
  86 4.2 External methods
  87
  88   Edit external methods in `methods/' directory for your environment.
  89
  90
  91 4.3 make
  92
  93   Run `make all'.
  94
  95
  96 4.4 install
  97
  98   Run `make install'.
  99
 100
 101 4.5 Emacs Lisp modules
 102
 103   Run `make install-nemacs', if you use NEmacs.
 104
 105   Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*).
 106
 107   Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.
 108
 109   Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).
 110
 111   Or copy *.el to your emacs lisp directory.
 112
 113
 114 5 tm-MUA
 115
 116 5.1 tm-gnus
 117
 118 (1) Please edit gnus/Makefile
 119
 120 (2) make
 121
 122   Run `make nemacs', if you use NEmacs.
 123
 124   Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
 125
 126   Run `make orig19', if you use Original Emacs 19.* or XEmacs.
 127
 128   Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
 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 tm-mh-e
 138
 139 (1) Please edit mh-e/Makefile
 140
 141 (2) make
 142
 143   Run `make nemacs', if you use NEmacs.
 144
 145   Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
 146
 147   Run `make orig19', if you use Original Emacs 19.* or XEmacs.
 148
 149   Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
 150
 151 (3) install
 152
 153   Run `make install-18', if you use Emacs 18.*.
 154
 155   Run `make install-19', if you use Emacs 19.*.
 156
 157
 158 5.2 tm-rmail or tm-vm
 159
 160   Please copy tm-rmail.el or tm-vm.el to Emacs Lisp install path.
 161
 162
 163 5 .emacs
 164
 165 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
 166 you use mime-setup, you should prepare mime.el.
 167
 168 If you want use vm, please insert following in .vm or .emacs:
 169
 170         (load "tm-vm")
 171
 172
 173 6 How to use mime/viewer-mode
 174
 175 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
 176 `Z' key) in Summary mode. mime/viewer-mode has following functions:
 177
 178         q       quit from mime/viewer-mode
 179         u       move to the upper content
 180         p       move to the previous content
 181         n       move to the next content
 182         SPC     scroll up
 183         M-SPC   scroll down
 184         v       play the content
 185         e       extract as file the content
 186         C-c C-p print the content
 187
 188
 189 7 Bug report
 190
 191 If you write bug-reports and/or propositions for improvement, please
 192 post them to following news groups:
 193
 194         fj.editor.emacs         (Japanese or English)
 195         fj.editor.mule          (Japanese or English; if you use Mule)
 196         gnu.emacs.help          (English)
 197         gnu.emacs.vm.info       (English; about tm-vm)
 198
 199 or send to tm ML:
 200
 201         tm@chamonix.jaist.ac.jp         (Japanese or English)
 202         tm-eng@chamonix.jaist.ac.jp     (English)
 203
 204 Via tm ML, You can report bugs of tm, obtain the latest release of tm
 205 package, and discuss the future enhancements to tm. To join tm ML,
 206 send a mail to
 207
 208         tm-admin@chamonix.jaist.ac.jp           (Japanese or English)
 209         tm-eng-admin@chamonix.jaist.ac.jp       (English)
 210
 211 Since the user registration is manually done, please write the mail
 212 body in human-recognizable language (^_^).
 213
 214
 215 8 TODO
 216
 217 - better XEmacs support (i.e. richtext filter or inline image)
 218 - multi frame support
 219 - improvement of tiny-mime
 220 - better uuencode support
 221 - development of internal method for message/external-body based on
 222   tm-ftp
 223 - development good MIME composer