comparison man/tm/tm-edit-en.texi @ 10:49a24b4fd526 r19-15b6

Import from CVS: tag r19-15b6
author cvs
date Mon, 13 Aug 2007 08:47:52 +0200
parents 4b173ad71786
children 131b0175ea99
comparison
equal deleted inserted replaced
9:6f2bbbbbe05a 10:49a24b4fd526
1 \input texinfo.tex 1 \input texinfo.tex
2 @setfilename tm-edit-en.info 2 @setfilename tm-edit-en.info
3 @settitle{tm-edit 7.90 Reference Manual (English Version)} 3 @settitle{tm-edit 7.100 Reference Manual (English Version)}
4 @titlepage 4 @titlepage
5 @title tm-edit 7.90 Reference Manual (English Version) 5 @title tm-edit 7.100 Reference Manual (English Version)
6 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp> 6 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp>
7 @subtitle 1996/10/11 7 @subtitle 1996/12/25
8 @end titlepage 8 @end titlepage
9 @node Top, Introduction, (dir), (dir) 9 @node Top, Introduction, (dir), (dir)
10 @top tm-edit 7.90 Reference Manual (English Version) 10 @top tm-edit 7.100 Reference Manual (English Version)
11 11
12 @ifinfo 12 @ifinfo
13 13
14 This file documents tm-edit, a MIME composer for GNU Emacs. 14 This file documents tm-edit, a MIME composer for GNU Emacs.
15 @end ifinfo 15 @end ifinfo
18 * Introduction:: What is tm-edit? 18 * Introduction:: What is tm-edit?
19 * mime/editor-mode:: 19 * mime/editor-mode::
20 * single-part operations:: 20 * single-part operations::
21 * enclosure operation:: 21 * enclosure operation::
22 * other operations of mime/editor-mode:: 22 * other operations of mime/editor-mode::
23 * tag specification for inserted file:: Default media-type or encoding for inserted file
23 * transfer level:: 24 * transfer level::
24 * header:: Using non-ASCII characters in header 25 * header:: Using non-ASCII characters in header
25 * PGP:: 26 * PGP::
27 * Acknowledgments::
26 * Concept Index:: 28 * Concept Index::
27 * Function Index:: 29 * Function Index::
28 * Variable Index:: 30 * Variable Index::
29 @end menu 31 @end menu
30 32
31 @node Introduction, mime/editor-mode, Top, Top 33 @node Introduction, mime/editor-mode, Top, Top
32 @chapter What is tm-edit? 34 @chapter What is tm-edit?
33 35 @cindex tm-edit
34 @cindex{tm-edit}@strong{tm-edit} is a general MIME composer for GNU 36
35 Emacs.@refill 37 @strong{tm-edit} is a general MIME composer for GNU Emacs.@refill
36 38
37 tm-edit is based on mime.el by UMEDA Masanobu 39 tm-edit is based on mime.el by UMEDA Masanobu
38 <umerin@@mse.kyutech.ac.jp>, who is famous as the author of 40 <umerin@@mse.kyutech.ac.jp>, who is famous as the author of
39 GNUS. tm-edit expands following points from @file{mime.el}: 41 GNUS. tm-edit expands following points from @file{mime.el}:
40 42
58 tm-edit. 60 tm-edit.
59 61
60 62
61 @node mime/editor-mode, single-part operations, Introduction, Top 63 @node mime/editor-mode, single-part operations, Introduction, Top
62 @chapter mime/editor-mode 64 @chapter mime/editor-mode
63 65 @cindex enclosure
64 @cindex{mime/editor-mode}@strong{mime/editor-mode} is a minor mode to 66 @cindex multi-part ending tag
65 compose MIME message. In this mode, @cindex{tag}@strong{tag} represents 67 @cindex multi-part beginning tag
66 various kinds of data, you can edit multi part (@ref{(tm-en)multipart}) 68 @cindex tag
67 message.@refill 69 @cindex mime/editor-mode
70
71 @strong{mime/editor-mode} is a minor mode to compose MIME message. In
72 this mode, @strong{tag} represents various kinds of data, you can edit
73 multi part (@ref{(tm-en)multipart}) message.@refill
68 74
69 There are 2 kinds of tags: 75 There are 2 kinds of tags:
70 76
71 @itemize @bullet 77 @itemize @bullet
72 @item 78 @item
91 97
92 OPTIONAL-FIELDS is to represent another fields except Content-Type field 98 OPTIONAL-FIELDS is to represent another fields except Content-Type field
93 and Content-Transfer-Encoding field.@refill 99 and Content-Transfer-Encoding field.@refill
94 100
95 multi-part tags represent multi part (@ref{(tm-en)multipart}). They 101 multi-part tags represent multi part (@ref{(tm-en)multipart}). They
96 consist of a pair of @cindex{multi-part beginning tag}@strong{multi-part 102 consist of a pair of @strong{multi-part beginning tag} and
97 beginning tag} and @cindex{multi-part ending tag}@strong{multi-part 103 @strong{multi-part ending tag}.@refill
98 ending tag}.@refill
99 104
100 multi-part beginning tag's form is following:@refill 105 multi-part beginning tag's form is following:@refill
101 106
102 @example 107 @example
103 --<<TYPE>>-@{ 108 --<<TYPE>>-@{
108 @example 113 @example
109 --@}-<<TYPE>> 114 --@}-<<TYPE>>
110 @end example 115 @end example
111 116
112 A region from multi-part beginning tag to multi-part ending tag is 117 A region from multi-part beginning tag to multi-part ending tag is
113 called as @cindex{enclosure}@strong{enclosure}. 118 called as @strong{enclosure}.
114 119
115 120
116 @node single-part operations, enclosure operation, mime/editor-mode, Top 121 @node single-part operations, enclosure operation, mime/editor-mode, Top
117 @chapter single-part operations 122 @chapter single-part operations
118 123
121 @table @kbd 126 @table @kbd
122 @item @key{C-c C-x C-t} 127 @item @key{C-c C-x C-t}
123 Insert single-part tag indicates text part. 128 Insert single-part tag indicates text part.
124 129
125 @item @key{C-c C-x C-i} 130 @item @key{C-c C-x C-i}
126 Insert file as a MIME attachment. 131 Insert file as a MIME attachment. If @kbd{C-u} is followed by it, it
132 asks media-type, subtype or encoding even if their default values are
133 specified. (cf. @ref{tag specification for inserted file})
127 134
128 @item @key{C-c C-x C-e} 135 @item @key{C-c C-x C-e}
129 Insert external part. 136 Insert external part.
130 137
131 @item @key{C-c C-x C-v} 138 @item @key{C-c C-x C-v}
182 189
183 @end table 190 @end table
184 191
185 192
186 193
187 @node other operations of mime/editor-mode, transfer level, enclosure operation, Top 194 @node other operations of mime/editor-mode, tag specification for inserted file, enclosure operation, Top
188 @chapter other operations of mime/editor-mode 195 @chapter other operations of mime/editor-mode
189 196
190 There are another operations in mime/editor-mode. 197 There are another operations in mime/editor-mode.
191 198
192 @table @kbd 199 @table @kbd
221 228
222 @end table 229 @end table
223 230
224 231
225 232
226 @node transfer level, header, other operations of mime/editor-mode, Top 233 @node tag specification for inserted file, transfer level, other operations of mime/editor-mode, Top
234 @chapter Default media-type or encoding for inserted file
235
236 When @kbd{C-c C-x C-i} (@code{mime-editor/insert-file}) is pressed, tag
237 parameters for inserted file, such as media-type or encoding, are
238 detected by variable @code{mime-file-types}.@refill
239
240 When @kbd{C-u} is followed by it or parameter is not found from the
241 variable, it asks from user. (When @kbd{C-u} is followed by it,
242 detected value is used as default value)@refill
243
244 If you want to change default value for file names, please change
245 variable @code{mime-file-types}.
246
247
248 @defvar mime-file-types
249
250 Specification of default value of tag for file name of inserted
251 file.@refill
252
253 It is a list of following list:
254
255 @lisp
256 (FILE_PAT TYPE SUBTYPE PARAMS ENCODING
257 DISPOSITION_TYPE DISPOSITION_PARAMS)
258 @end lisp
259
260
261 Each elements of the list are following:
262
263 @table @samp
264 @item FILE_PAT
265 regular expression of file name
266
267 @item TYPE
268 media type
269
270 @item SUBTYPE
271 media subtype
272
273 @item PARAMS
274 parameters of Content-Type field
275
276 @item ENCODING
277 Content-Transfer-Encoding
278
279 @item DISPOSITION_TYPE
280 disposition-type
281
282 @item DISPOSITION_PARAMS
283 parameters of Content-Disposition field
284
285 @end table
286
287 @noindent
288 Example: Specify application/rtf as default media type for
289 @file{*.rtf}
290
291 @lisp
292 (call-after-loaded
293 'tm-edit
294 (lambda ()
295 (set-alist 'mime-file-types
296 "\\.rtf$"
297 '("application" "rtf" nil nil
298 "attachment" (("filename" . file)))
299 )))
300 @end lisp
301 @end defvar
302
303
304
305 @node transfer level, header, tag specification for inserted file, Top
227 @chapter transfer level 306 @chapter transfer level
307 @cindex transfer level
228 308
229 Contents inserted in a message are represented by 7bit 309 Contents inserted in a message are represented by 7bit
230 (@ref{(tm-en)7bit}), 8bit (@ref{(tm-en)8bit}) or binary 310 (@ref{(tm-en)7bit}), 8bit (@ref{(tm-en)8bit}) or binary
231 (@ref{(tm-en)binary}).@refill 311 (@ref{(tm-en)binary}).@refill
232 312
248 disappeared. (^_^;@refill 328 disappeared. (^_^;@refill
249 329
250 Maybe there are binary-through MTA, but I think it is not major. 330 Maybe there are binary-through MTA, but I think it is not major.
251 @end quotation 331 @end quotation
252 332
253 @cindex{transfer level}@strong{transfer level} represents how range data is 333 @strong{transfer level} represents how range data is
254 available. tm-edit has a variable 334 available. tm-edit has a variable
255 @code{mime-editor/transfer-level} to represent transfer level. 335 @code{mime-editor/transfer-level} to represent transfer level.
256 336
257 337
258 @defvar mime-editor/transfer-level 338 @defvar mime-editor/transfer-level
280 360
281 361
282 362
283 @node header, PGP, transfer level, Top 363 @node header, PGP, transfer level, Top
284 @chapter Using non-ASCII characters in header 364 @chapter Using non-ASCII characters in header
365 @cindex encoded-word
285 366
286 RFC 1522 (@ref{(tm-en)RFC 1522}) defines representation of non-ASCII 367 RFC 1522 (@ref{(tm-en)RFC 1522}) defines representation of non-ASCII
287 characters in header.@refill 368 characters in header.@refill
288 369
289 It is a format called as @cindex{encoded-word}@strong{encoded-word} 370 It is a format called as @strong{encoded-word}
290 (@ref{(tm-en)encoded-word}), it is available to represent every 371 (@ref{(tm-en)encoded-word}), it is available to represent every
291 non-ASCII characters by 7bit (@ref{(tm-en)7bit}) to declare MIME charset 372 non-ASCII characters by 7bit (@ref{(tm-en)7bit}) to declare MIME charset
292 (@ref{(tm-en)MIME charset}). 373 (@ref{(tm-en)MIME charset}).
293 374
294 375
392 B-encoding. @code{"Q"} means to use Q-encoding. 473 B-encoding. @code{"Q"} means to use Q-encoding.
393 @end defvar 474 @end defvar
394 475
395 476
396 477
397 @node PGP, Concept Index, header, Top 478 @node PGP, Acknowledgments, header, Top
398 @chapter PGP 479 @chapter PGP
480 @cindex PGP-kazu
481 @cindex PGP/MIME
399 482
400 tm-edit provides PGP encryption, signature and inserting public-key 483 tm-edit provides PGP encryption, signature and inserting public-key
401 features based on @cindex{PGP/MIME}@strong{PGP/MIME} 484 features based on @strong{PGP/MIME} (@ref{(tm-en)PGP/MIME}) (RFC 2015)
402 (@ref{(tm-en)PGP/MIME}) (RFC 2015) or @cindex{PGP-kazu}@strong{PGP-kazu} 485 or @strong{PGP-kazu} (@ref{(tm-en)PGP-kazu})
403 (@ref{(tm-en)PGP-kazu}) (draft-kazu-pgp-mime-00.txt).@refill 486 (draft-kazu-pgp-mime-00.txt).@refill
404 487
405 This feature requires pgp command and Mailcrypt package 488 This feature requires pgp command and Mailcrypt package
406 (@ref{(mailcrypt)}).@refill 489 (@ref{(mailcrypt)}).@refill
407 490
408 If you want to use this feature, please set @code{pgp-elkins} or 491 If you want to use this feature, please set @code{pgp-elkins} or
432 Default value is @code{nil}. 515 Default value is @code{nil}.
433 @end defvar 516 @end defvar
434 517
435 518
436 519
437 @node Concept Index, Function Index, PGP, Top 520 @node Acknowledgments, Concept Index, PGP, Top
521 @chapter Acknowledgments
522
523 First of all, I thank UMEDA Masanobu for his work of @file{mime.el},
524 which is the origin of tm-edit, and permission to rewrite his work as
525 tm-edit.@refill
526
527 I thank members of two tm mailing lists, Japanese and English version.
528
529
530 @node Concept Index, Function Index, Acknowledgments, Top
438 @chapter Concept Index 531 @chapter Concept Index
439 532
440 @printindex cp 533 @printindex cp
441 534
442 @node Function Index, Variable Index, Concept Index, Top 535 @node Function Index, Variable Index, Concept Index, Top