tm 6.76.
[elisp/tm.git] / README.eng
index f40f3e8..b5dd5f2 100644 (file)
@@ -1,6 +1,6 @@
 [README for tm (English Version)]
 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
-$Id: README.eng,v 1.2 1995/02/09 15:47:58 morioka Exp $
+$Id: README.eng,v 6.4 1995/08/31 14:22:04 morioka Exp $
 
 1 What's tm?
 
@@ -17,17 +17,20 @@ This package includes following documents.
 
 (1) English edition
 
-- doc/tm-eng.tex       : tm Reference Manual (LaTeX)
+- doc/tm_en.texi       : tm Reference Manual (TeXinfo)
+- doc/tm-view_en.texi  : tm-view Reference Manual (TeXinfo)
 - doc/tiny-mime-eng.ol : tiny-mime.el Reference Manual (Emacs Outline)
 - doc/tiny-mime-eng.tex        : tiny-mime.el Reference Manual (LaTeX)
+- rel-6eng.ol  : notice about major changes of tm 6.* (Emacs Outline)
 
 (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/tm_ja.tex                : tm Reference Manual (TeXinfo)
+- doc/tm-view_ja.tex   : tm-view Reference Manual (TeXinfo)
+- doc/tm-eword_ja.texi : tiny-mime.el Reference Manual (TeXinfo)
 - doc/signature-jp.ol  : signature.el Reference Manual (Emacs Outline)
 - doc/signature-jp.tex : signature.el Reference Manual (LaTeX)
+- rel-6jp.ol   : notice about major changes of tm 6.* (Emacs Outline) 
 
 
 3 Modules
@@ -42,6 +45,13 @@ Tm has following modules:
                - 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
 
@@ -111,13 +121,11 @@ tl. Please read tl/README.eng.
 
 (2) make
 
-  Run `make nemacs', if you use NEmacs.
+  Run `make gnus3', if you use GNUS 3.*.
 
-  Run `make mule1', if you use Mule 1.* (based on Emacs 18.*).
+  Run `make gnus4', if you use GNUS 4.*.
 
-  Run `make orig19', if you use Original Emacs 19.* or XEmacs.
-
-  Run `make mule2', if you use Mule 2.* (based on Emacs 19.*).
+  Run `make dgnus', if you use (ding) GNUS.
 
 (3) install
 
@@ -126,6 +134,14 @@ tl. Please read tl/README.eng.
   Run `make install-19', if you use Emacs 19.*.
 
 
+5.1.1 (ding) GNUS
+
+  If you want to use automatic MIME preview support, please apply a
+patch to (ding) GNUS. This patch is called `with tm patch'. It is
+available from ftp.jaist.ac.jp:/pub/GNU/elisp/dgnus/. Current version
+is dgnus-0.99.23-tm.diff.
+
+
 5.1 tm-mh-e
 
 (1) Please edit mh-e/Makefile
@@ -147,22 +163,56 @@ tl. Please read tl/README.eng.
   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
+6 .emacs
 
 Please insert (load "mime-setup") or (load "tm-setup") in .emacs. If
 you use mime-setup, you should prepare mime.el.
 
+6.1 VM
+
 If you want use vm, please insert following in .vm or .emacs:
 
        (load "tm-vm")
 
-
-6 How to use mime/viewer-mode
+6.2 XEmacs
+
+In XEmacs, current mime.el can not work, so you should use tm-setup.el
+and another MIME composer, such as mime-compose.el. Following is a
+example:
+
+       (load "tm-setup")
+       ;; (require 'mh-e) ; if you use mh-e, please use it.
+       (load "mime-compose")
+
+6.3 setting sample for hilit19
+
+======================================================================
+(cond (window-system
+       (let* ((header-patterns '(("^Subject:.*$" nil msg-subject)
+                                ("^From:.*$" nil msg-from)
+                                ("^--text follows this line--$"
+                                 nil msg-separator)
+                                ("^[A-Za-z][A-Za-z0-9-]+:" nil msg-header)
+                                ))
+             (body-patterns '(("^\\(In article\\|[ \t]*\\w*[]<>}|]\\).*$"
+                               nil msg-quote)))
+             (message-patterns (append header-patterns body-patterns))
+             )
+        (hilit-set-mode-patterns 'msg-header header-patterns)
+        (hilit-set-mode-patterns 'msg-body body-patterns)
+        (hilit-set-mode-patterns 'mime/viewer-mode
+                                 message-patterns
+                                 'hilit-rehighlight-message)
+        )
+       (add-hook 'mime-viewer/content-header-filter-hook
+                (function hilit-rehighlight-buffer-quietly))
+       (add-hook 'mime-viewer/plain-text-preview-hook
+                (function hilit-rehighlight-buffer-quietly))
+       ))
+======================================================================
+
+
+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. mime/viewer-mode has following functions:
@@ -176,3 +226,40 @@ In tm-MUAs, you can use mime/viewer-mode if you press `v' key (in VM,
        v       play the content
        e       extract as file the content
        C-c C-p print the content
+
+
+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)
+       gnu.emacs.vm.info       (English; about tm-vm)
+
+or send to tm ML:
+
+       tm@chamonix.jaist.ac.jp         (Japanese or English)
+       tm-eng@chamonix.jaist.ac.jp     (English)
+
+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)
+
+Since the user registration is manually done, please write the mail
+body in human-recognizable language (^_^).
+
+
+9 TODO
+
+- better XEmacs support (i.e. richtext filter or inline image)
+- multi frame support
+- improvement of tiny-mime
+- better uuencode support
+- development of internal method for message/external-body based on
+  tm-ftp
+- development good MIME composer