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