tm 7.99.
[elisp/tm.git] / README.en
index cd440e5..223903e 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-k@jaist.ac.jp>
-$Id: README.en,v 7.19 1996/05/08 15:25:04 morioka Exp $
+$Id: README.en,v 7.25 1996/12/02 16:07:55 morioka Exp $
 
 1 What's tm?
 
@@ -10,12 +10,12 @@ $Id: README.en,v 7.19 1996/05/08 15:25:04 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
 
-  This package includes following documents.
+  This package includes the following documents.
 
 (1) English edition
 
@@ -55,11 +55,12 @@ $Id: README.en,v 7.19 1996/05/08 15:25:04 morioka Exp $
                - tm-ew-e.el : MIME encoded-word encoder
        - tm-def  : definition module for tm
        - tm-MUAs : MIME extender for MUAs
-               - 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
-               - tm-mail  : tm-MUA library module for mail-mode
+               - tm-mh-e   : tm-MUA for mh-e
+               - gnus-mime : tm-MUA for Gnus
+               - tm-gnus   : tm-MUA for GNUS
+               - tm-rmail  : tm-MUA for RMAIL
+               - tm-vm     : tm-MUA for vm
+               - tm-mail   : tm-MUA library module for mail-mode
        - mime-setup: set up module for MIME
                - tm-setup: set up only reading
 
@@ -70,25 +71,11 @@ $Id: README.en,v 7.19 1996/05/08 15:25:04 morioka Exp $
 
   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'.
+  By default, tm is installed into /usr/local/. If you want to change this,
+please modify the variables `PREFIX' and `EXEC_PREFIX'.
 
 
-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.
-
-    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.
-
-    If you use Gnus 5.0.*, please edit tm/gnus/g5-path.
-
-    If you use September Gnus, please edit tm/gnus/s-path.
-
-
-4.3 edit external methods (optional)
+4.2 edit external methods (optional)
 
   You can edit external methods in `tm/methods/' directory for your
 environment.
@@ -101,27 +88,28 @@ environment.
        tm/methods/tm-html      for HTML
        tm/methods/tmdecode     decoder
 
-  In default, tmdecode uses `mmencode' command. If you don't have
-metamail package, please modify tmdecode to use decode-b instead of
-mmencode.
+  By default, tmdecode uses the `mmencode' command, which is part of
+the metamail package (available by anonymous ftp from
+ftp://thumper.bellcore.com/pub/nsb).  If you don't have the metamail
+package, please modify tmdecode to use decode-b instead of mmencode.
 
 
-4.4 make
+4.3 make
 
   Run `make all'.
 
-  You can specify Emacs command name, for example if you want to use
-`mule' as Emacs command:
+  You can specify the Emacs command name, for example if you want to use
+`mule' as the Emacs command:
 
        % make all EMACS=mule
 
 
-4.5 install
+4.4 install
 
   Run `make install'.
 
-  You can specify Emacs command name, for example if you want to use
-`xemacs' as Emacs command:
+  You can specify the Emacs command name, for example if you want to use
+`xemacs' as the Emacs command:
 
        % make install EMACS=xemacs
 
@@ -131,39 +119,49 @@ mmencode.
   Please insert `(load "mime-setup")' in ~/.emacs.
 
 
-6.1 automatic MIME preview support
+6.1 gnus-mime
 
-  tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
-later, Gnus 5.0.*, Gnus 5.1, and September Gnus.
+  gnus-mime provides automatic MIME preview feature for Gnus.
 
   If you don't want to use automatic MIME preview feature, please
-insert following to ~/.emacs.
+insert in ~/.emacs:
 
-       (setq tm-gnus/automatic-mime-preview nil)
+       (setq gnus-show-mime 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 is designed to support automatic MIME preview
+feature.  Of course, gnus-mime provides this feature for Gnus 5.0.*
+and Gnus 5.1.*, 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.
+  When automatic MIME preview mode, Gnus do MIME processing if a
+message has a Mime-Version field.  If it does not have one, 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.
+Gnus does MIME processing even if a message does not have a
+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 
-RFC 1522 encoded-word. So it is not necessary to reset
+  In Gnus 5.2, if `gnus-strict-mime' is not nil, variable
+`gnus-decode-encoded-word-method' is called.  gnus-mime uses it to
+decode RFC 2047 encoded-words.  So it is not necessary to reset
 `gnus-strict-mime'.
 
 
-6.2 VM
+6.2 tm-gnus
+
+  tm-gnus provides automatic MIME preview feature for GNUS 3.15 or
+later.
+
+  If you don't want to use automatic MIME preview feature, please
+insert in ~/.emacs:
+
+       (setq tm-gnus/automatic-mime-preview nil)
+
+
+6.3 VM
 
   If you use vm, please insert `(require 'tm-vm)' in ~/.vm.
 
@@ -171,13 +169,13 @@ RFC 1522 encoded-word. So it is not necessary to reset
 (require 'tm-vm) *after* (bbdb-insinuate-vm).
 
 
-6.3 PGP
+6.4 PGP
 
-  If you have PGP and Mailcrypt package, you can use PGP on
-MIME. Currently, 2 drafts (draft-elkins-pem-pgp-02.txt and
-draft-kazu-pgp-mime-00.txt) are proposed, so tm provides both way.
+  If you have the PGP and Mailcrypt packages, you can use PGP with
+MIME. Currently, PGP/MIME (RFC 2015) and draft-kazu-pgp-mime-00.txt
+are proposed, so tm provides both ways.
 
-  For decoding, please insert following into ~/.emacs:
+  For decoding, please insert the following into ~/.emacs:
 
 ======================================================================
 (call-after-loaded
@@ -188,25 +186,25 @@ draft-kazu-pgp-mime-00.txt) are proposed, so tm provides both way.
     )))
 ======================================================================
 
-tm-pgp.el is a internal method modules to support PGP.
+tm-pgp.el is an internal method module to support PGP.
 
-  For encoding, tm-edit provides 2 mechanism. One is for signing or
-encrypting for message as application/pgp. There are two command
+  For encoding, tm-edit provides 2 mechanisms. One is for signing or
+encrypting for message as application/pgp. There are two commands,
 `mime-editor/set-sign' and `mime-editor/set-encrypt'. They set a
-message is signed, encrypted or not.
+message as signed, encrypted or not.
 
-  Another one is for content. There are 2 kinds of enclosure for PGP:
+  Another one is for content. There are 2 kinds of enclosures for PGP:
 ``signed'' and ``encrypted''. Their enclosure are bound to key and
 menu. If you use this mechanism, please specify 2 variables:
 `mime-editor/signing-type' and `mime-editor/encrypting-type'. They
 requires following values:
 
-       pgp-elkins      processed as draft-elkins-pem-pgp-02.txt
+       pgp-elkins      processed as PGP/MIME (RFC 2015)
        pgp-kazu        processed as draft-kazu-pgp-mime-00.txt
        nil             not processed
 
-If you use ``signed'' and ``encrypted'' as draft-elkins-pem-pgp-02.txt,
-please insert following into ~/.emacs:
+If you use ``signed'' and ``encrypted'' as PGP/MIME, please insert
+into ~/.emacs:
 
 ======================================================================
 (setq mime-editor/signing-type    'pgp-elkins)
@@ -214,7 +212,7 @@ please insert following into ~/.emacs:
 ======================================================================
 
 If you use ``signed'' and ``encrypted'' as draft-kazu-pgp-mime-00.txt,
-please insert following into ~/.emacs:
+please insert into ~/.emacs:
 
 ======================================================================
 (setq mime-editor/signing-type    'pgp-kazu)
@@ -222,7 +220,7 @@ please insert following into ~/.emacs:
 ======================================================================
 
 
-6.4 setting sample for hilit19
+6.5 code sample for hilit19
 
 ======================================================================
 (cond (window-system
@@ -262,11 +260,11 @@ please insert following into ~/.emacs:
 ======================================================================
 
 
-6.5 setting sample for browse-url
+6.6 code 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
-mime/viewer-mode. Following is setting sample:
+mime/viewer-mode. Sample code follows:
 
 ======================================================================
 (setq browse-url-browser-function
@@ -280,8 +278,8 @@ mime/viewer-mode. Following is setting sample:
 
 7 How to use mime/viewer-mode
 
-In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
-`Z' key) in Summary mode. Or automatic MIME previewed buffer's
+In tm-MUAs, you can use mime/viewer-mode if you press the `v' key (in
+VM, `Z' key) in Summary mode. Or automatic MIME previewed buffer's
 major-mode is mime/viewer-mode. mime/viewer-mode has following
 functions:
 
@@ -307,18 +305,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)
@@ -327,14 +314,14 @@ 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 (^_^).
 
 
-9 How to get new version
+9 How to get the latest version
 
 tm is available from following anonymous ftp site:
 
@@ -348,7 +335,6 @@ and its mirrors:
 
 10 TODO
 
-- MUA specific key bind system for mime/viewer-mode
 - better identification calculus system as successor of atype system
 - development of internal method for message/external-body based on
   tm-ftp