tm 7.106.
[elisp/tm.git] / doc / tm-gnus_en.texi
index ea98aa0..7ed0ea0 100644 (file)
@@ -6,23 +6,23 @@
 @titlepage
 @title{tm-gnus}
 @author{MORIOKA Tomohiko}
-@code{$Id: tm-gnus_en.texi,v 3.0 1995/09/05 10:19:13 morioka Exp $}
+@code{$Id: tm-gnus_en.texi,v 7.0 1996/04/11 17:20:24 morioka Exp $}
 @end titlepage
 
 
 @node Top, Introduction, (tm_en.info)tm-MUA, (tm_en.info)tm-MUA
+@top tm-gnus 7.25 Reference manual
+
 @comment  node-name,  next,  previous,  up
 @ifinfo
-@top tm-gnus 6.20 Reference manual
+This file documents tm-gnus, a MIME extension for GNUS and Gnus.
+
 @end ifinfo
 
 @menu
-* Introduction:: modules of tm-gnus
-* Features::     Features of tm-gnus
-* Customize::    Customize of tm-gnus
-* Concept Index::
-* Command Index::
-* Variable Index::
+* Introduction::
+* Features::
+* Index::
 @end menu
 
 
@@ -38,24 +38,26 @@ tm-gnus extends MIME features to GNUS. tm-gnus decodes RFC 1522 MIME
 encoded-word in summary buffer and article buffer, and adds a command
 to preview MIME message using tm-view in summary mode.
 
-In (ding) GNUS and GNUS 5.*, tm-gnus can display MIME preview buffer
-instead of article buffer if you apply a patch to support this
-feature. It is useful for heavy MIME user.
+In GNUS 3.15 or later and Gnus, tm-gnus can display MIME preview
+buffer instead of article buffer. It is useful for heavy MIME user.
+
+Note: September Gnus has some features to support tm-gnus. So it is
+better choice if you don't dislike alpha version.
 
 
 tm-gnus has following modules:
 
 @itemize @minus
-@item @strong{tm-gnus}:  setting module for GNUS.
-@item @strong{tm-gnus3}: setting module for GNUS 3.*.
-@item @strong{tm-gnus4}: setting module for GNUS 4.*.
-@item @strong{tm-ognus}: common part for tm-gnus3 and tm-gnus4.
-@item @strong{tm-dgnus}: setting module for (ding) GNUS.
-@item @strong{tm-gnus5}: setting module for GNUS 5.*.
+@item @strong{tm-gnus.el}:  main module of tm-gnus
+@item @strong{tm-gnus3.el}: module for GNUS 3.*.
+@item @strong{tm-gnus4.el}: module for GNUS 4.*, Gnus 5.0 and 5.1
+@item @strong{tm-gd3.el}:   common part for GNUS
+@item @strong{tm-gd5.el}:   common part for Gnus
+@item @strong{tm-sgnus.el}: module for September Gnus
 @end itemize
 
 
-@node Features, Customize, Introduction, Top
+@node Features, Index, Introduction, Top
 @comment  node-name,  next,  previous,  up
 @chapter Features
 @cindex features
@@ -76,13 +78,9 @@ tm-gnus expands following features to GNUS.
 @cindex RFC 1522
 @cindex summary buffer
 
-tm-gnus decodes MIME encoded-word in summary buffer using tiny-mime
-(@inforef{Top, , tm-eword_en}) functions. However if an encoded-word
-has unsupported charset, it is not decoded.
-
-@menu
-* (tm-eword_en.info)Charsets:: supported charsets
-@end menu
+tm-gnus decodes MIME encoded-word in summary buffer using tm-view
+(@inforef{encoded-word decoding, , tm-eword_en}) functions. However if
+an encoded-word has unsupported charset, it is not decoded.
 
 
 @node Summary mode, Automatic MIME Preview, Summary buffer, Features
@@ -103,7 +101,7 @@ mime/viewer-mode is a mode to view MIME messages. You can move in a
 message, or play each contents included in a message.
 
 @menu
-* (tm-view_en.info)Commands:: Commands of mime/viewer-mode.
+* (tm_en.info)MIME navigation:: Commands of mime/viewer-mode.
 @end menu
 
 
@@ -112,17 +110,13 @@ message, or play each contents included in a message.
 @section Automatic MIME Preview
 @cindex automatic MIME preview
 
-``Automatic MIME preview'' feature is available to apply ``with tm
-patch'' for (ding) GNUS and GNUS 5.*. This patch is in
-ftp.jaist.ac.jp:/pub/GNU/elisp/dgnus/, current version is
-dgnus-0.99.23-tm.diff (as of 2 September 1995).
+``Automatic MIME preview'' feature is available in GNUS 3.15 or later
+and Gnus. If this feature is available, when reading an article in
+summary mode, tm-gnus displays preview buffer processed by tm-view
+instead of raw article buffer.
 
-If this feature is available, when reading an article in summary mode,
-tm-gnus displays preview buffer processed by tm-view (@inforef{Top, ,
-tm-view_en.info}) instead of raw article buffer.
-
-Therefore if an article is encoded by Quoted-Printable or Base64,
-decoded article is displays. In addition, if using tm-rich, rich text
+Therefore if an article is encoded by Quoted-Printable or Base64, a
+decoded article is displayed. In addition, if using tm-rich, rich text
 article is automatic formated. Of course, multipart article is dealt
 with correctly.
 
@@ -136,121 +130,42 @@ However if you use a slow machine, or are just really impatient, you
 can stop automatic MIME preview.
 
 
-@defvar tm-gnus/decode-all
+@defvar tm-gnus/automatic-mime-preview
 
 If it is t, tm-gnus is in automatic MIME preview mode.
 @end defvar
 
-
-@deffn{Command} tm-gnus/toggle-mime arg
-
-It switches normal mode and automatic MIME preview mode. Namely, it
-switches value of the variable @code{tm-gnus/decode-all}.
-
-If @var{arg} is @code{t}, it set the variable
-@code{tm-gnus/decode-all} to @code{t}.
-@end deffn
-
-
-If ``withd tm patch'' is applied, semantics of variable
-@code{gnus-article-buffer} is changed, its semantics is divided into
-following two variables.
+In September Gnus, semantics of variable @code{gnus-article-buffer} is
+changed, its semantics is divided into following two variables.
 
 
 @defvar gnus-article-buffer
 
 It indicates the buffer to display. In automatic MIME preview mode, it
-indicates preview buffer processed by tm-view. In normal mode, it
-indicates raw article buffer. In this case, it is equal to variable
-@code{gnus-clean-article-buffer}.
+indicates preview-buffer "*Article*" processed by tm-view.
 @end defvar
 
 
-@defvar gnus-clean-article-buffer
-
-It indicates raw article buffer even if tm-gnus is in automatic MIME
-preview mode.
-@end defvar
+@defvar gnus-original-article-buffer
 
+It indicates raw article-buffer " *Original Article*" even if tm-gnus
+is in automatic MIME preview mode.
 
-@node Customize, Concept Index, Features, Top
-@comment  node-name,  next,  previous,  up
-@chapter Customize of tm-gnus
-@cindex customize
-
-@defvar tm-gnus/original-article-display-hook
-
-tm-gnus uses @code{gnus-article-display-hook}, forbids to use for
-users customize. Therefore tm-gnus has this variable instead of
-@code{gnus-article-display-hook}.
-
-Notice: it is available after tm-gnus is loaded. Therefore you had
-better to set in @code{call-after-loaded} like following:
-
-@lisp
-@cartouche
-(call-after-loaded
- 'tm-view
- (function
-  (lambda ()
-    (add-hook 'tm-gnus/original-article-display-hook
-              ...)
-    )))
-@end cartouche
-@end lisp
+GNUS and Gnus 5.1 or earlier don't have it, but tm-gnus4 emulate
+it. In this case, it indicates nil if there is not preview-buffer.
 @end defvar
 
-In addition, you can customize preview buffer to set tm-view
-setting. For instance, following is a example to add faces using
-hilit19.
-
-@lisp
-@cartouche
-(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))
-       ))
-@end cartouche
-@end lisp
 
 @menu
-* (tm-view_en.info):: tm-view
+* (tm_en.info)tm-view::
 @end menu
 
 
-@node Concept Index, Command Index, Customize, Top
-@unnumbered Concept Index
+@node Index,  , Features, Top
+@unnumbered Index
 
 @printindex cp
-
-
-@node Command Index, Variable Index, Concept Index, Top
-@unnumbered Command and Function Index
-
 @printindex fn
-
-
-@node Variable Index,  , Command Index, Top
-@unnumbered Variable Index
-
 @printindex vr
 
 @bye