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