comparison man/tm/tm-vm-en.texi @ 12:bcdc7deadc19 r19-15b7

Import from CVS: tag r19-15b7
author cvs
date Mon, 13 Aug 2007 08:48:16 +0200
parents
children
comparison
equal deleted inserted replaced
11:91ffe8bd52e4 12:bcdc7deadc19
1 \input texinfo.tex
2 @c %**start of header
3 @setfilename tm-vm-en.info
4 @settitle tm-vm Manual (English Version)
5 @c %**end of header
6
7 @ifinfo
8 This file documents tm-vm.el v7.79.
9
10 tm-vm is part of the TM Package.
11
12 tm-vm is an interface between tm and the VM mail user agent that lets
13 you read and write multimedia mail on the Internet using the MIME
14 standard.
15
16 tm-vm and its documentation are distributed under the same terms as
17 TM. Please refer to the TM Manual.
18
19 Copyright 1996 Tomohiko Morioka, Oscar Figueiredo
20
21 @end ifinfo
22
23
24
25
26 @titlepage
27 @title tm-vm Manual (English Version)
28 @author by Oscar Figueiredo
29 @code{$Id: tm-vm-en.texi,v 1.1 1997/01/04 20:55:42 steve Exp $}
30 @page
31
32 tm-vm is part of the TM Package.
33
34 tm-vm and its documentation are distributed under the same terms as
35 TM. Please refer to the TM Manual.
36
37 Copyright 1996 Tomohiko Morioka, Oscar Figueiredo
38 @end titlepage
39
40
41
42
43
44 @node Top, Overview, (dir), (dir)
45 @ifinfo
46 @chapter tm-vm Manual
47 tm-vm is an interface between tm and the VM mail user agent that lets
48 you read and write multimedia mail on the Internet using the MIME
49 standard.
50
51 This document applies to release 7.79 of tm-vm.el
52 @end ifinfo
53
54 @menu
55 * Overview:: Reading and writing MIME mail in VM
56 * Install:: Installation procedure
57 * Usage:: Detailed usage of tm-vm
58 * Customization:: How to customize tm-vm behavior.
59 * News:: Recent modifications
60 * Copyright::
61 * Variable Index::
62 * Concept Index::
63 @end menu
64
65
66
67
68
69 @node Overview, Install, Top, Top
70 @chapter Overview
71
72 tm-vm is an interface between TM (@xref{Top,TM,,tm-en,TM Manual}.) and the VM
73 mail user agent (@xref{Top,VM,,vm,VM Manual}.).
74
75 In its current version VM does not provide functionality to support the
76 MIME standard. tm-vm integrates the TM package into VM so as to give you
77 a powerful MIME support in your usual mail environment for both mail
78 reading and composing.
79
80 @section Mail Reading Features
81
82 tm-vm tries to integrate as transparently as possible within VM so that
83 MIME messages appear to you the same as plain messages.
84
85 tm-vm detects MIME messages when you try to view them and, if automatic
86 MIME previewing is enabled (the default), then it automatically parses
87 the message and displays a "beautified" version under the MIME Viewer.
88
89 The MIME Viewer offers all the functionality to view/extract the MIME
90 components (attachments) of the message. It also displays images inline
91 in XEmacs. @xref{tm-view,,MIME Viewer tm-view,tm-en,TM Manual}.
92
93 @section Mail Composing Features
94
95 Composing a new message places you in a compose buffer as usual under VM
96 but a special minor mode (@samp{mime-editor}) is made available that
97 lets you perform such operations as:
98
99 @itemize @bullet
100 @item
101 Insert arbitrary files
102 @item
103 Insert another message
104 @item
105 Insert a voice sample recorded from a micro attached to the computer
106 @item
107 Enclose message sections as PGP encrypted
108 @end itemize
109
110 and much more. For details @xref{tm-edit,,MIME Editor,tm-en,TM Manual}.
111
112 When you reply to a message citing the original and tm-vm is active,
113 tm-vm will insert the contents of the MIME-Preview buffer in the reply
114 buffer. You can also insert the raw message if you want @pxref{Usage}.
115
116
117
118
119
120 @node Install, Usage, Overview, Top
121 @chapter Installing tm-vm
122
123 To take advantage of the benefits of tm-vm, you need to have VM and tm
124 already installed.
125
126 VM is part of XEmacs distributions and if you're running XEmacs you
127 don't need to install it. If you're running Emacs, you will need to
128 install VM. Official distribution site is
129 @file{ftp://ftp.uu.net/networking/mail/vm/}
130
131 If you're reading this manual then there is a pretty good chance you
132 already retrieved a recent version of tm. Official distribution site is
133 @file{ftp://ftp.jaist.ac.jp/pub/GNU/mime/}Follow the installation procedure
134 for tm as it is described in the documentation.
135
136 Once these steps are completed, tm-vm installation is very simple you
137 just need to insert the following lines in your VM configuration file
138 (generally .vm):
139
140 @lisp
141 (require 'mime-setup)
142 (require 'tm-vm)
143 @end lisp
144
145 That's it. You are ready to read and send multimedia mail! You may also
146 want to customize some aspects of tm-vm behaviour @pxref{Customization}
147
148 If you use BBDB you must load tm-vm @strong{after} BBDB. Please be sure
149 to respect the following sequence in your initialization file:
150
151 @lisp
152 (bbdb-insinuate-vm)
153 (require 'tm-vm)
154 @end lisp
155
156
157
158
159
160 @node Usage, Customization, Install, Top
161 @chapter Using tm-vm
162
163
164 @menu
165 * Reading MIME mail:: Commands for MIME previewing
166 * Composing MIME mail:: Writing/Replying to/Forwarding MIME messages
167 * Printing:: Printing MIME messages
168 * Using BBDB:: BBDB integration
169 @end menu
170
171
172 @node Reading MIME mail, Composing MIME mail, Usage, Usage
173 @section Reading MIME mail
174
175 When reading mail, tm-vm can operate in two different modes:
176 @emph{automatic preview} and @emph{on-demand preview}. In automatic
177 preview mode (the default) MIME messages are automatically decoded. In
178 on-demand preview mode all messages are presented by VM as they are (as
179 if tm were not loaded). The user can request the decoding of a message
180 at any time with @code{tm-vm/view-message} (bound to @kbd{Z}).
181
182
183 @subsection VM folder buffer and MIME Preview buffer
184
185 Though tm-vm tries to hide this fact as much as possible, it is
186 important to note that when MIME previewing is enabled the current
187 message actually exists in @strong{two} separate buffers:
188
189 @itemize @bullet
190
191 @item
192 @cindex VM folder buffer
193 @emph{the VM folder buffer}: always displays the @strong{raw} message
194 buffer where the MIME contents remain unparsed
195
196 @item
197 @cindex MIME Preview buffer
198 @emph{the MIME Preview buffer}: displays a MIME parsed version of the
199 message. It is generally what you want to see as it is more readable
200 @end itemize
201
202 The reasons why there are two different buffers are due to current VM
203 implementation that turns tm integration difficult. However we try hard
204 to make the MIME Preview buffer act as if it were the real VM message
205 buffer by making all bindings act the same in Preview buffer as in
206 folder buffer.
207
208
209 @code{tm-vm/toggle-preview-mode} (bound to @kbd{M-t}) lets you toggle
210 between automatic and on-demand preview modes.
211
212
213 @node Composing MIME mail, Printing, Reading MIME mail, Usage
214 @section Composing MIME mail
215
216 Regardless of current preview mode tm-vm activates the mime-editor mode
217 each time you compose a mail message (new message, reply or
218 forward). Functionalities provided by the mime-editor are described in
219 @xref{tm-edit,,MIME Editor,tm-en,TM Manual}.
220
221 When you reply to a message tm-vm will insert the contents of the
222 @strong{decoded} message if there exists a MIME Preview buffer. This is
223 generally what you want for quoted-printable text for instance. Inline
224 images are removed from the reply. If for some reason you want the
225 @strong{raw} message to be inserted instead of the decoded one you have
226 to kill the MIME Preview buffer first. You do this with
227 @code{kill-buffer} (bound to @kbd{C-x k}) in the MIME Preview
228 buffer. You can also toggle automatic preview off if it was on with
229 @kbd{M-t}.
230
231 Forwarding a message inserts always inserts the raw message with its own
232 MIME headers. The recipient will thus receive exactly the same message
233 as you did.
234
235
236
237 @node Printing, Using BBDB, Composing MIME mail, Usage
238 @section Printing MIME messages
239
240 For non-MULE Emacses, printing of MIME messages uses Postscript printing
241 (through the ps-print package). Non-MIME messages are printed the usual
242 way as configured in VM. This is controlled by the variable
243 @code{tm-vm/use-ps-print}.
244
245
246 @node Using BBDB, , Printing, Usage
247 @section Notes about BBDB Usage
248
249 BBDB, the Big Brother's Database, should operate normally with
250 VM/tm-vm. You must ensure however that tm-vm is loaded @strong{after}
251 BBDB has installed its hooks. Therefore be sure to respect the following
252 sequence in your initialization file:
253 @lisp
254 (bbdb-insinuate-vm)
255 (require 'tm-vm)
256 @end lisp
257
258
259
260
261 @node Customization, News, Usage, Top
262 @chapter Customization
263
264 Several variables let you adapt the behavior of tm-vm to your needs. You
265 can set this variables to the appropriate value in your initialization
266 file prior to loading tm.
267
268
269 @defopt tm-vm/automatic-mime-preview
270 If non-nil then tm-vm will start in automatic mime preview mode
271 (@pxref{Usage}). Default t.
272 @end defopt
273
274 @defopt tm-vm/strict-mime
275 If non-nil tm-vm will automatically decode MIME messages only. MIME
276 messages have a MIME-Version header. If nil then all messages will be
277 decoded and viewed in the MIME Preview buffer regardless of the
278 existence of a MIME-Version header. Default t.
279 @end defopt
280
281 @defopt tm-vm/use-xemacs-popup-menu
282 If this is non nil and you're running XEmacs, tm-vm will install a
283 menu of MIME commands as a mode popup (@key{Button 3}) in message
284 composition buffers. Default t.
285 @end defopt
286
287 @defopt tm-vm/use-ps-print
288 If this is non-nil then MIME messages will be printed in Postscript
289 using the ps-print package. By default it is t for non MULE-Emacses.
290 @end defopt
291
292 @defvar tm-vm/select-message-hook
293 tm-vm runs the hooks in this list after selecting a message. You can
294 attach your own hook functions using @code{add-hook}.
295 @end defvar
296
297 @defvar tm-vm/forward-message-hook
298 tm-vm runs the hooks in this list after a Mail mode buffer has been
299 created to forward a message in message/rfc822 type format.
300 If @code{vm-forwarding-digest-type} is @samp{rfc1521}, tm-vm runs this
301 hook instead of @code{vm-forward-message-hook}.
302 @end defvar
303
304 @defvar tm-vm/send-digest-hook
305 tm-vm runs the hooks in this list after a Mail mode buffer has been
306 created to send a digest in multipart/digest type format.
307 If @code{vm-digest-send-type} is @samp{rfc1521}, tm-vm runs this hook
308 instead of @code{vm-send-digest-hook}."
309 @end defvar
310
311 @section X-Faces
312 @cindex X-Faces
313 tm-vm displays X-Faces inline for XEmacs users in the same way as
314 VM. X-Faces are turned on by default. You need to disable their display
315 explicitly if you want to:
316
317 @lisp
318 (setq vm-use-lucid-highlighting nil)
319 (setq vm-display-xfaces nil)
320 @end lisp
321
322
323 @node News, Copyright, Customization, Top
324 @chapter News
325
326 This section documents the changes in the latest releases of tm-vm.
327
328 @section 7.79
329
330 @itemize @bullet
331 @item
332 Minor bug fixes.
333 @end itemize
334
335 @section 7.78
336
337 @itemize @bullet
338 @item
339 Better compatibility with MULE in respect of the ps-print package
340 @end itemize
341
342
343 @section 7.77
344
345 @itemize @bullet
346 @item
347 A bug in byte-compilation introduced in 7.76 was fixed
348 @item
349 Window configurations are restored more correctly (point stays where it
350 should :-) when paging through messages.
351 @end itemize
352
353
354 @section 7.76
355
356 @itemize @bullet
357 @item
358 Forwarding a MIME message now always forwards the @strong{raw} message.
359 @item
360 Forwarding a message from the @samp{Dispose} pull-down menu now works
361 correctly in XEmacs. Untested in Emacs.
362 @item
363 Forwarding a message when the current buffer is the MIME-Preview buffer
364 now works correctly
365 @item
366 @code{tm-vm/use-ps-print} was introduced @pxref{Customization}.
367
368 @end itemize
369
370
371 @section 7.75
372
373 @itemize @bullet
374 @item
375 Bug fixes: BBDB record creation and MIME component extraction from new
376 messages
377
378 @end itemize
379
380
381 @section 7.74
382
383 @itemize @bullet
384 @item
385 X-Faces are displayed by default. @pxref{Customization}
386 @end itemize
387
388
389
390
391
392
393 @node Copyright, Variable Index, News, Top
394 @ifinfo
395 @chapter Copyright
396
397 This file documents tm-vm 7.76, an interface between tm and the VM mail
398 user agent.
399
400 Copyright 1996 Tomohiko Morioka, Oscar Figueiredo
401
402 tm-vm is part of the TM package. tm-vm and its documentation are
403 distributed under the same terms as TM itself
404 @xref{Copyright, Copyright, tm-en, TM}.
405 @end ifinfo
406
407
408 @node Variable Index, Concept Index, Copyright, Top
409 @unnumbered Variable Index
410
411 @printindex vr
412
413 @node Concept Index, , Variable Index, Top
414 @unnumbered Concept Index
415
416 @printindex cp
417
418 @contents
419 @bye