[README for tm (English Version)]
by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-1994/09/26
+$Id: README.eng,v 1.2 1995/02/09 15:47:58 morioka Exp morioka $
1 What's tm?
- MIME style multilingual header
- MIME message viewer (mime/viewer-mode)
- - MIME extenders for mh-e, GNUS and RMAIL
+ - MIME extenders for mh-e, GNUS, RMAIL and vm
-2 Modules
+2 Documents
+
+This package includes following documents.
+
+(1) English edition
+
+- doc/tm-eng.tex : tm Reference Manual (LaTeX)
+- doc/tiny-mime-eng.ol : tiny-mime.el Reference Manual (Emacs Outline)
+- doc/tiny-mime-eng.tex : tiny-mime.el Reference Manual (LaTeX)
+
+(2) Japanese edition
+
+- doc/tm-jp.tex : tm Reference Manual (LaTeX)
+- doc/tiny-mime-jp.ol : tiny-mime.el Reference Manual (Emacs Outline)
+- doc/tiny-mime-jp.tex : tiny-mime.el Reference Manual (LaTeX)
+- doc/signature-jp.ol : signature.el Reference Manual (Emacs Outline)
+- doc/signature-jp.tex : signature.el Reference Manual (LaTeX)
+
+
+3 Modules
Tm has following modules:
- tm-view : MIME viewer
- tm-misc : library module for tm-MUAs
- tm-MUAs : MIME extender for MUAs
- - tm-mh-e : tm-MUA for mh-e
- - tm-gnus : tm-MUA for GNUS
+ - tm-mh-e : tm-MUA for mh-e
+ - tm-gnus : tm-MUA for GNUS
- tm-rmail : tm-MUA for RMAIL
+ - tm-vm : tm-MUA for vm
+ - extender for tm-view
+ - tm-partial : automatic assembler for message/partial
+ - tm-ftp : for anonymous ftp
+ - tm-rich : for text/enriched and text/richtext
+ - tm-comp : extender for mime.el (big message automatic
+ splitter, previewer using tm-view, uuencode
+ supporter)
- tm-setup: set up module for tm-MUAs
- mime-setup: set up module for MIME
-3 Install
+4 Install
+
+4.0 install tl
+
+Tm uses Emacs Lisp library ``tl'', so, at first, you install
+tl. Please read tl/README.eng.
+
+
+4.1 Makefile
+
+ Please edit Makefile.
+
+4.1.1 specify Emacs executables
+
+ Please specify Emacs executable file name.
+
+ NEMACS = for NEMACS (or NEpoch)
+ MULE1 = for Mule 1.* (based on Emacs 18.*)
+ ORIG19 = for Emacs 19.* (FSF original or XEmacs)
+ MULE2 = for MULE 2.* (based on Emacs 19.*)
+
+4.1.2 specify Emacs Lisp install path
+
+ Please specify Emacs Lisp install path.
+
+ TLDIR18 = for Emacs 18.* (NEMACS, NEpoch or MULE 1)
+ TLDIR19 = for Emacs 19.* (FSF original, XEmacs or MULE 2)
+
+
+4.2 External methods
+
+ Edit external methods in `methods/' directory for your environment.
+
+
+4.3 make
+
+ Run `make all'.
+
+
+4.4 install
+
+ Run `make install'.
+
+
+4.5 Emacs Lisp modules
-(1) Edit Makefile for your environment.
+ Run `make install-nemacs', if you use NEmacs.
-(2) Edit methods in `methods/' directory for your environment.
+ Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*).
-(3) Run `make all'.
+ Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.
-(4) Run `make install'.
+ Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).
-(5) Copy *.el to your emacs lisp directory.
+ Or copy *.el to your emacs lisp directory.
-4 .emacs
+5 tm-MUA
+
+5.1 tm-gnus
+
+(1) Please edit gnus/Makefile
+
+(2) make
+
+ Run `make nemacs', if you use NEmacs.
+
+ Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
+
+ Run `make orig19', if you use Original Emacs 19.* or XEmacs.
+
+ Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
+
+(3) install
+
+ Run `make install-18', if you use Emacs 18.*.
+
+ Run `make install-19', if you use Emacs 19.*.
+
+
+5.1 tm-mh-e
+
+(1) Please edit mh-e/Makefile
+
+(2) make
+
+ Run `make nemacs', if you use NEmacs.
+
+ Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
+
+ Run `make orig19', if you use Original Emacs 19.* or XEmacs.
+
+ Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
+
+(3) install
+
+ Run `make install-18', if you use Emacs 18.*.
+
+ Run `make install-19', if you use Emacs 19.*.
+
+
+5.2 tm-rmail or tm-vm
+
+ Please copy tm-rmail.el or tm-vm.el to Emacs Lisp install path.
+
+
+5 .emacs
Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
you use mime-setup, you should prepare mime.el.
+If you want use vm, please insert following in .vm or .emacs:
+
+ (load "tm-vm")
+
-5 How to use mime/viewer-mode
+6 How to use mime/viewer-mode
-In tm-MUAs, you can use mime/viewer-mode if you press `v' key in
-Summary mode. mime/viewer-mode has following functions:
+In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
+`Z' key) in Summary mode. mime/viewer-mode has following functions:
+ q quit from mime/viewer-mode
u move to the upper content
p move to the previous content
n move to the next content
projects / elisp / tm.git / blobdiff