tm 7.48.3.
[elisp/tm.git] / doc / tm-gnus_en.texi
1 \input texinfo.tex
2 @c{-*-tm-gnus manual-*-}
3 @setfilename tm-gnus_en.info
4 @settitle{tm-gnus manual}
5
6 @titlepage
7 @title{tm-gnus}
8 @author{MORIOKA Tomohiko}
9 @code{$Id: tm-gnus_en.texi,v 6.0 1996/03/27 23:04:30 morioka Exp morioka $}
10 @end titlepage
11
12
13 @node Top, Introduction, (tm_en.info)tm-MUA, (tm_en.info)tm-MUA
14 @comment  node-name,  next,  previous,  up
15 @ifinfo
16 This file documents tm-gnus, a MIME extension for GNUS and Gnus.
17
18 @top tm-gnus 7.25 Reference manual
19 @end ifinfo
20
21 @menu
22 * Introduction::
23 * Features::
24 * Index::
25 @end menu
26
27
28 @node Introduction, Features, Top, Top
29 @comment  node-name,  next,  previous,  up
30 @chapter Introduction
31 @cindex components
32
33 tm-gnus is a GNUS extender to use tm. It supports GNUS 3.*, GNUS 4.*,
34 (ding) GNUS and GNUS 5.*.
35
36 tm-gnus extends MIME features to GNUS. tm-gnus decodes RFC 1522 MIME
37 encoded-word in summary buffer and article buffer, and adds a command
38 to preview MIME message using tm-view in summary mode.
39
40 In GNUS 3.15 or later and Gnus, tm-gnus can display MIME preview
41 buffer instead of article buffer. It is useful for heavy MIME user.
42
43 Note: September Gnus has some features to support tm-gnus. So it is
44 better choice if you don't dislike alpha version.
45
46
47 tm-gnus has following modules:
48
49 @itemize @minus
50 @item @strong{tm-gnus.el}:  main module of tm-gnus
51 @item @strong{tm-gnus3.el}: module for GNUS 3.*.
52 @item @strong{tm-gnus4.el}: module for GNUS 4.*, Gnus 5.0 and 5.1
53 @item @strong{tm-gd3.el}:   common part for GNUS
54 @item @strong{tm-gd5.el}:   common part for Gnus
55 @item @strong{tm-sgnus.el}: module for September Gnus
56 @end itemize
57
58
59 @node Features, Index, Introduction, Top
60 @comment  node-name,  next,  previous,  up
61 @chapter Features
62 @cindex features
63
64 tm-gnus expands following features to GNUS.
65
66 @menu
67 * Summary buffer::         Summary buffer decoding
68 * Summary mode::           Extension to summary mode.
69 * Automatic MIME Preview:: Automatic MIME Preview
70 @end menu
71
72
73 @node Summary buffer, Summary mode, Features, Features
74 @comment  node-name,  next,  previous,  up
75 @section Summary buffer decoding
76 @cindex encoded-word
77 @cindex RFC 1522
78 @cindex summary buffer
79
80 tm-gnus decodes MIME encoded-word in summary buffer using tm-view
81 (@inforef{encoded-word decoding, , tm-eword_en}) functions. However if
82 an encoded-word has unsupported charset, it is not decoded.
83
84
85 @node Summary mode, Automatic MIME Preview, Summary buffer, Features
86 @comment  node-name,  next,  previous,  up
87 @section Extension to Summary mode
88 @cindex Summary mode
89
90 @table @kbd 
91 @item @key{M-t}
92 In automatic MIME preview support version GNUS, it is the toggle
93 whether to do automatic MIME preview or not. Otherwise it is the
94 toggle for decoding mode of RFC 1522 MIME encoded-word.
95 @item @key{v}
96 Enter @code{mime/viewer-mode} to view a message.
97 @end table
98
99 mime/viewer-mode is a mode to view MIME messages. You can move in a
100 message, or play each contents included in a message.
101
102 @menu
103 * (tm_en.info)MIME navigation:: Commands of mime/viewer-mode.
104 @end menu
105
106
107 @node Automatic MIME Preview,  , Summary mode, Features
108 @comment  node-name,  next,  previous,  up
109 @section Automatic MIME Preview
110 @cindex automatic MIME preview
111
112 ``Automatic MIME preview'' feature is available in GNUS 3.15 or later
113 and Gnus. If this feature is available, when reading an article in
114 summary mode, tm-gnus displays preview buffer processed by tm-view
115 instead of raw article buffer.
116
117 Therefore if an article is encoded by Quoted-Printable or Base64, a
118 decoded article is displayed. In addition, if using tm-rich, rich text
119 article is automatic formated. Of course, multipart article is dealt
120 with correctly.
121
122 Different from using metamail, speaker does not roar just then read an
123 article includes audio content, video player does not play just then
124 read an article includes video content, it does not do anonymous ftp
125 or send mail when read an article includes external-message. These
126 contents are played when you do decoding command in preview buffer.
127
128 However if you use a slow machine, or are just really impatient, you
129 can stop automatic MIME preview.
130
131
132 @defvar tm-gnus/automatic-mime-preview
133
134 If it is t, tm-gnus is in automatic MIME preview mode.
135 @end defvar
136
137 In September Gnus, semantics of variable @code{gnus-article-buffer} is
138 changed, its semantics is divided into following two variables.
139
140
141 @defvar gnus-article-buffer
142
143 It indicates the buffer to display. In automatic MIME preview mode, it
144 indicates preview-buffer "*Article*" processed by tm-view.
145 @end defvar
146
147
148 @defvar gnus-original-article-buffer
149
150 It indicates raw article-buffer " *Original Article*" even if tm-gnus
151 is in automatic MIME preview mode.
152
153 GNUS and Gnus 5.1 or earlier don't have it, but tm-gnus4 emulate
154 it. In this case, it indicates nil if there is not preview-buffer.
155 @end defvar
156
157
158 @menu
159 * (tm_en.info)tm-view::
160 @end menu
161
162
163 @node Index,  , Features, Top
164 @unnumbered Index
165
166 @printindex cp
167 @printindex fn
168 @printindex vr
169
170 @bye