README.eng

   1 [README for tm (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 1994/12/6
   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 and RMAIL
  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
  24 (2) Japanese edition
  25
  26 - doc/tm-jp.tex         : tm Reference Manual (LaTeX)
  27 - doc/tiny-mime-jp.ol   : tiny-mime.el Reference Manual (Emacs Outline)
  28 - doc/tiny-mime-jp.tex  : tiny-mime.el Reference Manual (LaTeX)
  29 - doc/signature-jp.ol   : signature.el Reference Manual (Emacs Outline)
  30 - doc/signature-jp.tex  : signature.el Reference Manual (LaTeX)
  31
  32
  33 3 Modules
  34
  35 Tm has following modules:
  36
  37         - tiny-mime : MIME header encoder/decoder
  38         - tm-view : MIME viewer
  39         - tm-misc : library module for tm-MUAs
  40         - tm-MUAs : MIME extender for MUAs
  41                 - tm-mh-e  : tm-MUA for mh-e
  42                 - tm-gnus  : tm-MUA for GNUS
  43                 - tm-rmail : tm-MUA for RMAIL
  44                 - tm-vm    : tm-MUA for vm
  45         - tm-setup: set up module for tm-MUAs
  46         - mime-setup: set up module for MIME
  47
  48
  49 4 Install
  50
  51 4.1 Makefile
  52
  53   Edit Makefiles for your environment. In this package, there are
  54 following Makefiles:
  55
  56         Makefile :      main Makefile
  57         Makefile.18 :   Makefile for Emacs 18 (NEmacs, Mule 1.x)
  58         Makefile.19 :   Makefile for Emacs 19 and Mule 2.x
  59         Makefile.o19 :  Makefile for original Emacs 19 (XEmacs)
  60
  61
  62 4.2 External methods
  63
  64   Edit external methods in `methods/' directory for your environment.
  65
  66
  67 4.3 make
  68
  69   Run `make all'.
  70
  71
  72 4.4 install
  73
  74   Run `make install'.
  75
  76
  77 4.5 Emacs Lisp modules
  78
  79   Run `make install-18', if you use Emacs 18 (NEmacs, Mule 1.x).
  80
  81   Run `make install-19', if you use Emacs 19 and Mule 2.x.
  82
  83   Run `make install-o19', if you use Emacs 19 or XEmacs.
  84
  85   Or copy *.el to your emacs lisp directory.
  86
  87
  88 5 .emacs
  89
  90 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
  91 you use mime-setup, you should prepare mime.el.
  92
  93 If you want use vm, please insert following in .vm or .emacs:
  94
  95         (load "tm-vm")
  96
  97
  98 6 How to use mime/viewer-mode
  99
 100 In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
 101 `Z' key) in Summary mode. mime/viewer-mode has following functions:
 102
 103         q       quit from mime/viewer-mode
 104         u       move to the upper content
 105         p       move to the previous content
 106         n       move to the next content
 107         SPC     scroll up
 108         M-SPC   scroll down
 109         v       play the content
 110         e       extract as file the content
 111         C-c C-p print the content