tm 7.81.
[elisp/tm.git] / README.en
index 9a9569f..cd474a2 100644 (file)
--- a/README.en
+++ b/README.en
@@ -1,7 +1,7 @@
 [README for tm (English Version)]
 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-and KOBAYASHI Shuhei <shuhei@cmpt01.phys.tohoku.ac.jp>
-$Id: README.en,v 7.11 1995/12/25 10:43:59 morioka Exp $
+and KOBAYASHI Shuhei <shuhei-k@jaist.ac.jp>
+$Id: README.en,v 7.22 1996/08/12 11:02:46 morioka Exp $
 
 1 What's tm?
 
@@ -10,7 +10,7 @@ $Id: README.en,v 7.11 1995/12/25 10:43:59 morioka Exp $
        - MIME style multilingual header
        - MIME message viewer (mime/viewer-mode)
        - MIME message composer (mime/editor-mode)
-       - MIME extenders for mh-e, GNUS, RMAIL and VM
+       - MIME extenders for mh-e, GNUS, Gnus, RMAIL and VM
 
 
 2 Documents
@@ -41,7 +41,8 @@ $Id: README.en,v 7.11 1995/12/25 10:43:59 morioka Exp $
                - tm-play.el  : MIME content player
                - tm-ew-d.el : MIME encoded-word decoder
        - preview filter for tm-view
-               - tm-rich    : for text/enriched and text/richtext
+               - tm-text    : for text/*
+               - tm-image   : for image/* and X-Face
        - internal methods for tm-view
                - tm-partial : automatic assembler for message/partial
                - tm-ftp     : for anonymous ftp
@@ -53,10 +54,6 @@ $Id: README.en,v 7.11 1995/12/25 10:43:59 morioka Exp $
        - tm-edit : MIME composer (mime.el and tm-comp.el were merged)
                - tm-ew-e.el : MIME encoded-word encoder
        - tm-def  : definition module for tm
-               - tm-nemacs.el : NEmacs depended part of tm
-               - tm-orig.el   : FSF original Emacs and XEmacs
-                                 depended part of tm
-               - tm-mule.el   : Mule depended part of tm
        - tm-MUAs : MIME extender for MUAs
                - tm-mh-e  : tm-MUA for mh-e
                - tm-gnus  : tm-MUA for GNUS
@@ -69,149 +66,112 @@ $Id: README.en,v 7.11 1995/12/25 10:43:59 morioka Exp $
 
 4 Install
 
-4.1 tm/config.tm
+4.1 edit tm/TM-CFG (optional)
 
-  Please edit tm/config.tm file.
+  You can edit tm/TM-CFG file.
 
+  In default, tm is installed into /usr/local/. If you want to change,
+please modify the variable `PREFIX' and `EXEC_PREFIX'.
 
-4.2 External methods
 
-  Please edit external methods in `tm/methods/' directory for your
-environment.
-
-       tm/methods/tm-au        for audio
-       tm/methods/tm-file      for file extraction
-       tm/methods/tm-image     for image
-       tm/methods/tm-mpeg      for MPEG
-       tm/methods/tm-plain     for plain text
-       tm/methods/tm-html      for HTML
-       tm/methods/tmdecode     decoder
-
-
-4.3 make
-
-  Run `make all'.
+4.2 tm-gnus (optional)
 
+  If you use optional GNUS or Gnus, which is not included in Emacs
+distribution, you must edit following files before make.
 
-4.4 install
-
-  Run `make install'.
-
-
-4.5 Emacs Lisp modules
-
-  Run `make install-18', if you use Emacs 18 (NEmacs, Mule 1.*).
+    If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
 
-  Run `make install-xemacs', if you use Emacs .. 19.28 (Mule 2.* based
-on), or XEmacs.
+    If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
 
-  Run `make install-19_29', if you use Emacs 19.29 or later (Mule 2.*
-based on).
+    If you use Gnus 5.[01].*, please edit tm/gnus/g5-path.
 
-  Or copy *.el to your emacs lisp directory.
+    If you use Gnus 5.2.*, please edit tm/gnus/s-path.
 
 
-5 tm-MUA
+4.3 edit external methods (optional)
 
-5.1 tm-gnus
+  You can edit external methods in `tm/methods/' directory for your
+environment.
 
-  If you use optional GNUS or Gnus, you must edit and make manually.
+       tm/methods/tm-au        for audio
+       tm/methods/tm-file      for file extraction
+       tm/methods/tm-image     for image
+       tm/methods/tm-mpeg      for MPEG
+       tm/methods/tm-plain     for plain text
+       tm/methods/tm-html      for HTML
+       tm/methods/tmdecode     decoder
 
-(1) Please edit tm/gnus/Makefile.
+  In default, tmdecode uses `mmencode' command. If you don't have
+metamail package, please modify tmdecode to use decode-b instead of
+mmencode.
 
-    If you use Emacs 18.* and GNUS 3.*, please edit tm/gnus/g3-path.
 
-    If you use Emacs 18.* and GNUS 4.*, please edit tm/gnus/g4-path.
+4.4 make
 
-    If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
+  Run `make all'.
 
-    If you use September Gnus, please edit tm/gnus/s-path.
+  You can specify Emacs command name, for example if you want to use
+`mule' as Emacs command:
 
-(2) make
+       % make all EMACS=mule
 
-  Run `make gnus3', if you use GNUS 3.*.
 
-  Run `make gnus4', if you use GNUS 4.*.
+4.5 install
 
-  Run `make gnus5', if you use Gnus 5.0.*.
+  Run `make install'.
 
-  Run `make sgnus', if you use September Gnus.
+  You can specify Emacs command name, for example if you want to use
+`xemacs' as Emacs command:
 
-(3) install
+       % make install EMACS=xemacs
 
-  Run `make install-18', if you use Emacs 18.*.
 
-  Run `make install-19', if you use Emacs .. 19.28 or XEmacs.
+6 .emacs
 
-  Run `make install-19_29', if you use Emacs 19.29 or later.
+  Please insert `(load "mime-setup")' in ~/.emacs.
 
 
-5.1.1 automatic MIME preview support
+6.1 automatic MIME preview support
 
   tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
-later, Gnus 5.0.*, Gnus 5.1, and September Gnus.
+later, Gnus 5.0.*, Gnus 5.1, and Gnus 5.2.
 
   If you don't want to use automatic MIME preview feature, please
 insert following to ~/.emacs.
 
        (setq tm-gnus/automatic-mime-preview nil)
 
-  In addition, September Gnus has automatic MIME preview supporting
-feature. Of course, tm-gnus provides this feature for other GNUS and
-Gnus, but it is unnatural.
+  In addition, Gnus 5.2 has automatic MIME preview supporting feature. 
+Of course, tm-gnus provides this feature for other GNUS and Gnus, but
+it is unnatural.
 
   When automatic MIME preview mode, GNUS and Gnus do MIME processing
 if a message has a Mime-Version field. If it does not have, GNUS and
 Gnus does not do MIME processing, in default.
 
-  Gnus 5.0.*, 5.1 and September Gnus have a variable
-`gnus-strict-mime'. If you insert
+  Gnus 5.0.*, 5.1 and Gnus 5.2 have a variable `gnus-strict-mime'. If
+you insert
 
        (setq gnus-strict-mime nil)
 
 Gnus do MIME processing even if a message does not have Mime-Version
 field.
 
-  In September Gnus, if `gnus-strict-mime' is not nil, variable
-`gnus-decode-encoded-word-method' is called. tm-gnus uses it to decode 
+  In Gnus 5.2, if `gnus-strict-mime' is not nil, variable
+`gnus-decode-encoded-word-method' is called. tm-gnus uses it to decode
 RFC 1522 encoded-word. So it is not necessary to reset
 `gnus-strict-mime'.
 
 
-5.2 tm-mh-e
-
-  If you use optional mh-e, you must edit and make manually.
-
-(1) Please edit mh-e/Makefile
-
-(2) make
-
-  Run `make elc'.
-
-(3) install
-
-  Run `make install-18', if you use Emacs 18.*.
+6.2 VM
 
-  Run `make install-19', if you use Emacs 19.*.
-
-5.3 VM
-
-  If you use VM, please edit `mk-tm'.
-
-
-6 .emacs
-
-  Please insert (load "mime-setup") in ~/.emacs.
-
-6.1 VM
-
-  If you use vm, please insert (require 'tm-vm) in ~/.vm.
+  If you use vm, please insert `(require 'tm-vm)' in ~/.vm.
 
   tm works well with BBDB: If you use VM, please insert
 (require 'tm-vm) *after* (bbdb-insinuate-vm).
 
 
-6.2 PGP
+6.3 PGP
 
   If you have PGP and Mailcrypt package, you can use PGP on
 MIME. Currently, 2 drafts (draft-elkins-pem-pgp-02.txt and
@@ -262,7 +222,7 @@ please insert following into ~/.emacs:
 ======================================================================
 
 
-6.3 setting sample for hilit19
+6.4 setting sample for hilit19
 
 ======================================================================
 (cond (window-system
@@ -301,7 +261,8 @@ please insert following into ~/.emacs:
        ))
 ======================================================================
 
-6.4 setting sample for browse
+
+6.5 setting sample for browse-url
 
   If you have browse-url.el (included in Gnus 5.*, September Gnus and
 Emacs 19.30 or later), you can use URL button in
@@ -346,18 +307,7 @@ functions:
 8 Bug report
 
 If you write bug-reports and/or propositions for improvement, please
-post them to following news groups:
-
-       fj.editor.emacs         (Japanese or English)
-       fj.editor.mule          (Japanese or English; if you use Mule)
-       gnu.emacs.help          (English)
-
-       fj.news.reader.gnus     (Japanese or English; about GNUS and Gnus)
-       gnu.emacs.gnus          (English; about GNUS and Gnus)
-
-       gnu.emacs.vm.info       (English; about tm-vm)
-
-or send to tm ML:
+send to tm ML:
 
        bug-tm-en@chamonix.jaist.ac.jp  (English)
        bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
@@ -366,8 +316,8 @@ Via tm ML, You can report bugs of tm, obtain the latest release of tm
 package, and discuss the future enhancements to tm. To join tm ML,
 send a mail to
 
-       tm-admin@chamonix.jaist.ac.jp           (Japanese or English)
-       tm-eng-admin@chamonix.jaist.ac.jp       (English)
+       tm-ja-admin@chamonix.jaist.ac.jp        (Japanese)
+       tm-en-admin@chamonix.jaist.ac.jp        (English)
 
 Since the user registration is manually done, please write the mail
 body in human-recognizable language (^_^).