New file.
[elisp/flim.git] / mime-en.texi
1 \input texinfo.tex
2 @setfilename mime-en.info
3 @settitle{FLIM 1.8 Manual about MIME Features}
4 @titlepage
5 @title FLIM 1.8 Manual about MIME Features
6 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp>
7 @subtitle 1998/07/01
8 @end titlepage
9 @node Top, Introduction, (dir), (dir)
10 @top FLIM 1.8 Manual about MIME Features
11
12 @ifinfo
13
14 This file documents MIME features of FLIM, a Internet message
15 parsing/encoding library for GNU Emacs.
16 @end ifinfo
17
18 @menu
19 * Introduction::                What is FLIM?
20 * How to use::                  How to use MIME features
21 * Entity::                      Message and Entity
22 * Content-Type::                Information of Content-Type field
23 * Content-Disposition::         Content-Disposition \e$BMs$N>pJs\e(B
24 * Content-Transfer-Encoding::   \e$BId9f2=K!\e(B
25 * encoded-word::                Header \e$B$N\e(B network \e$BI=8=\e(B
26 * custom::                      \e$B0lHL@_Dj\e(B
27 * Appendix::                    
28 * Concept Index::               
29 * Function Index::              
30 * Variable Index::              
31 @end menu
32
33 @node Introduction, How to use, Top, Top
34 @chapter What is FLIM?
35
36 FLIM is a library to provide basic features about message
37 representation or encoding.
38
39
40 @node How to use, Entity, Introduction, Top
41 @chapter How to use MIME features
42
43 Please eval following to use MIME features provided by FLIM:
44
45 @lisp
46 (require 'mime)
47 @end lisp
48
49
50
51 @node Entity, Content-Type, How to use, Top
52 @chapter Message and Entity
53 @cindex node-id
54 @cindex entity-number
55 @cindex mime-entity
56 @cindex entity
57
58 According to RFC 2045 (@ref{RFC 2045}), `The term ``entity'', refers
59 specifically to the MIME-defined header fields and contents of either a
60 message or one of the parts in the body of a multipart entity.'  In this
61 document, the term @strong{entity} indicates all of header fields and
62 body.@refill
63
64 The definition of RFC 2045 indicates that a MIME message is a tree.  An
65 message is a tree, each node is an entity, like following figure.
66 Namely MIME extends message to tree structure.@refill
67
68 FLIM uses @strong{mime-entity} structure to represent information of
69 entity.  In this document, it is called simply `mime-entity'.@refill
70
71 \e$BA0=R$N$h$&$K!"\e(Bmessage \e$BCf$N3F\e(B entity \e$B$OLZ$N@a$KEv$?$j$^$9$,!"$3$NLZ$K$O\e(B
72 \e$B?<$5$HF1$8?<$5$NCf$N=gHV$K=>$C$FHV9f$,IU$1$k$3$H$,$G$-$^$9!#B($A!"\e(B
73 @example
74
75                               \e$B(#(!(!(!($\e(B
76                               \e$B("\e(B  nil \e$B("\e(B
77                               \e$B(&(!(((!(%\e(B
78               \e$B(#(!(!(!(!(!(!(!(!(!(+(!(!(!(!(!(!(!(!(!($\e(B
79             \e$B(#(*($\e(B              \e$B(#(*($\e(B              \e$B(#(*($\e(B
80             \e$B("#0("\e(B              \e$B("#1("\e(B              \e$B("#2("\e(B
81             \e$B(&(((%\e(B              \e$B(&(((%\e(B              \e$B(&(((%\e(B
82               \e$B("\e(B        \e$B(#(!(!(!(!(+(!(!(!(!($\e(B        \e$B("\e(B
83           \e$B(#(!(*(!($(#(!(*(!($(#(!(*(!($(#(!(*(!($(#(!(*(!($\e(B
84           \e$B("\e(B \e$B#0\e(B.\e$B#0("("\e(B \e$B#1\e(B.\e$B#0("("\e(B \e$B#1\e(B.\e$B#1("("\e(B \e$B#1\e(B.\e$B#2("("\e(B \e$B#2\e(B.\e$B#0("\e(B
85           \e$B(&(!(!(!(%(&(!(!(!(%(&(!(!(!(%(&(!(!(!(%(&(!(!(!(%\e(B
86 @end example
87
88 @noindent
89 \e$B$N$h$&$K?<$5\e(B n \e$B$N@a$K$OD9$5\e(B n \e$B$N@0?tNs$N@aHV9f$,?6$l$^$9!#$3$l\e(B
90 \e$B$r\e(B @strong{entity-number} \e$B$H8F$S$^$9!#\e(Bentity-number \e$B$O\e(B S \e$B<0$H\e(B
91 \e$B$7$F$O\e(B @code{(1 2 3)} \e$B$N$h$&$J@0?t$N%j%9%H$H$7$FI=8=$5$l$^$9!#\e(B
92
93 mime-entity \e$B$G$O!"$3$l$HF1MM$N\e(B @strong{node-id} \e$B$rMQ$$$^$9!#\e(Bnode-id \e$B$O$A$g\e(B
94 \e$B$&$I\e(B entity-number \e$B$r5U$K$7$?%j%9%H$G!"\e(Bentity-number 1.2.3 \e$B$KBP1~$9$k\e(B 
95 node-id \e$B$O\e(B @code{(3 2 1)} \e$B$G$9!#\e(B@refill
96
97 \e$BA0=R$N$h$&$K!"\e(BMIME message \e$B$O\e(B entity \e$B$rC10L$H$7$?LZ9=B$$K$J$C$F$$$k$N$G!"\e(B
98 \e$B$3$N:,$G$"$k\e(B message \e$BA4BN$b\e(B mime-entity \e$B$GI=8=$9$k$3$H$,$G$-!"\e(Bbuffer
99 local \e$BJQ?t\e(B @code{mime-message-structure} \e$B$K3JG<$9$k$3$H$K$7$^$9!#\e(B
100 \e$B$=$7$F!"\e(Bentity-number \e$B$d\e(B node-id \e$B$rMQ$$$k$3$H$G\e(B 
101 @code{mime-message-structure} \e$B$K$*$1$k\e(B entity \e$B$NAjBPE*$J0LCV4X78$r\e(B
102 \e$B07$&$3$H$,$G$-$^$9!#\e(B
103
104
105 @menu
106 * Entity creation::             Functions to create mime-entity
107 * Entity hierarchy::            Features about message tree
108 * Entity Attributes::           Functions about attributes of mime-entity
109 * Entity-header::               Information of entity header
110 * Entity-content::              Contents of Entity
111 * Entity buffer::               Entity as buffer representation
112 * mm-backend::                  Entity representations and implementations
113 @end menu
114
115 @node Entity creation, Entity hierarchy, Entity, Entity
116 @section Functions to create mime-entity
117
118 @defun mime-open-entity &optional  type location
119
120 Open an entity and return it.@refill
121
122 @var{type} is representation-type. (cf. @ref{mm-backend}) @refill
123
124 @var{location} is location of entity.  Specification of it is depended
125 on representation-type.
126 @end defun
127
128
129 @defun mime-parse-message &optional  default-ctl node-id
130
131 Parse current buffer as message, and return the result as mime-entity.
132 @end defun
133
134
135 @defun mime-parse-buffer &optional  buffer
136
137 Parse @var{buffer} as message, and set the result to buffer local
138 variable @code{mime-message-structure} of @var{buffer} as
139 mime-entity.@refill
140
141 If @var{buffer} is omitted, current buffer is used.
142 @end defun
143
144
145
146 @node Entity hierarchy, Entity Attributes, Entity creation, Entity
147 @section Features about message tree
148
149 @defvar mime-message-structure
150
151 Buffer local variable to store mime-entity structure of message.
152 @end defvar
153
154
155 @defun mime-entity-children entity
156
157 Return list of entities included in the @var{entity}.
158 @end defun
159
160
161 @defun mime-entity-parent entity  &optional  message
162
163 Return parent entity of the @var{entity}.@refill
164
165 If @var{message} is specified, it is regarded as root instead of
166 @code{mime-message-structure}.
167 @end defun
168
169
170 @defun mime-root-entity-p entity
171
172 Return non-@code{nil} if @var{entity} is root entity (message).
173 @end defun
174
175
176 @defun mime-entity-node-id entity
177
178 Return node-id of @var{entity}.
179 @end defun
180
181
182 @defun mime-entity-number entity
183
184 Return entity-number of @var{entity}.
185 @end defun
186
187
188 @defun mime-find-entity-from-number entity-number  &optional  message
189
190 Return entity from @var{entity-number} in @var{message}.@refill
191
192 If @var{message} is not specified, @code{mime-message-structure} is
193 used.
194 @end defun
195
196
197 @defun mime-find-entity-from-node-id entity-node-id  &optional  message
198
199 Return entity from @var{entity-node-id} in @var{message}.@refill
200
201 If @var{message} is not specified, @code{mime-message-structure} is
202 used.
203 @end defun
204
205
206
207 @node Entity Attributes, Entity-header, Entity hierarchy, Entity
208 @section Functions about attributes of mime-entity
209
210 @defun mime-entity-content-type entity
211
212 Return content-type of @var{entity}.  (cf. @ref{mime-content-type})
213 @end defun
214
215
216 @defun mime-entity-content-disposition entity
217
218 Return content-disposition of
219 @var{entity}. (cf. @ref{mime-content-disposition})
220 @end defun
221
222
223 @defun mime-entity-filename entity
224
225 Return file name of @var{entity}.
226 @end defun
227
228
229 @defun mime-entity-encoding entity
230
231 Return content-transfer-encoding of @var{entity}.
232 (cf. @ref{Content-Transfer-Encoding})
233 @end defun
234
235
236 @defun mime-entity-cooked-p entity
237
238 Return non-nil if contents of @var{entity} has been already
239 code-converted.
240 @end defun
241
242
243
244 @node Entity-header, Entity-content, Entity Attributes, Entity
245 @section Information of entity header
246
247 @defun mime-fetch-field field-name  &optional  entity
248
249 Return field-body of @var{field-name} field in header of
250 @var{entity}.@refill
251
252 The results is network representation.@refill
253
254 If @var{entity} is omitted, @code{mime-message-structure} is used as
255 default value.@refill
256
257 If @var{field-name} field is not found, this function returns
258 @code{nil}.
259 @end defun
260
261
262 @defun mime-read-field field-name  &optional  entity
263
264 Parse @var{field-name} field in header of @var{entity}, and return the
265 result.@refill
266
267 Format of result is depended on kind of field.  For non-structured
268 field, this function returns string.  For structured field, it returns
269 list corresponding with structure of the field.@refill
270
271 Strings in the result will be converted to internal representation of
272 Emacs.@refill
273
274 If @var{entity} is omitted, @code{mime-message-structure} is used as
275 default value.@refill
276
277 If @var{field-name} field is not found, this function returns
278 @code{nil}.
279 @end defun
280
281
282 @defun mime-insert-decoded-header entity  &optional  invisible-fields visible-fields
283
284 Insert before point a decoded contents of header of @var{entity}.@refill
285
286 @var{invisible-fields} is list of regexps to match field-name to hide.
287 @var{visible-fields} is list of regexps to match field-name to
288 hide.@refill
289
290 If a field-name is matched with some elements of @var{invisible-fields}
291 and matched with none of @var{visible-fields}, this function don't
292 insert the field.
293 @end defun
294
295
296
297 @node Entity-content, Entity buffer, Entity-header, Entity
298 @section Contents of Entity
299
300 @defun mime-entity-content entity
301
302 Return content of @var{entity} as byte sequence.
303 @end defun
304
305
306 @defun mime-write-entity-content entity filename
307
308 Write content of @var{entity} into @var{filename}.
309 @end defun
310
311
312 @defun mime-write-entity entity filename
313
314 Write representation of @var{entity} into @var{filename}.
315 @end defun
316
317
318 @defun mime-write-entity-body entity filename
319
320 Write body of @var{entity} into @var{filename}.
321 @end defun
322
323
324
325 @node Entity buffer, mm-backend, Entity-content, Entity
326 @section Entity as buffer representation
327
328 @defun mime-entity-buffer entity
329
330 Return buffer, which contains @var{entity}.
331 @end defun
332
333
334 @defun mime-entity-point-min entity
335
336 Return the start point of @var{entity} in the buffer which contains
337 @var{entity}.
338 @end defun
339
340
341 @defun mime-entity-point-max entity
342
343 Return the end point of @var{entity} in the buffer which contains
344 @var{entity}.
345 @end defun
346
347
348 @defun mime-entity-header-start entity
349
350 Return the start point of header of @var{entity} in the buffer which
351 contains @var{entity}.
352 @end defun
353
354
355 @defun mime-entity-header-end entity
356
357 Return the end point of header of @var{entity} in the buffer which
358 contains @var{entity}.
359 @end defun
360
361
362 @defun mime-entity-body-start entity
363
364 Return the start point of body of @var{entity} in the buffer which
365 contains @var{entity}.
366 @end defun
367
368
369 @defun mime-entity-body-end entity
370
371 Return the end point of body of @var{entity} in the buffer which
372 contains @var{entity}.
373 @end defun
374
375
376
377 @node mm-backend,  , Entity buffer, Entity
378 @section Entity representations and implementations
379 @cindex mm-backend
380 @cindex entity \e$B=hM}\e(B method
381 @cindex representation-type
382
383 Entity \e$B$OCj>]2=$5$l$?%G!<%?I=8=$G!"<B:]$N%G!<%?I=8=$H$7$F$OMQES$K1~$8$F\e(B
384 \e$B$5$^$6$^$J$b$N$,MxMQ$G$-$k$h$&$K@_7W$5$l$F$$$^$9!#\e(B@refill
385
386 \e$B$3$3$G!"\e(Bentity \e$B$,$I$&$$$&<oN`$NI=8=$r9T$C$F$$$k$+$r<($9$N$,\e(B
387 @strong{representation-type} \e$B$G!"\e(Bentity \e$B$r@8@.$9$k;~$K$O$3$l$r;XDj$7$^$9!#\e(B
388 (cf. @ref{Entity Creation}) @refill
389
390 \e$BA0@a$^$G$K=R$Y$FMh$?\e(B entity \e$B$KBP$9$k=hM}$O!"\e(Bentity \e$B$KBP$7$F$=$N=hM}$r0M\e(B
391 \e$BMj$9$k$3$H$K$h$C$F<B8=$5$l$F$$$^$9!#\e(BEntity \e$B$O<+J,$N\e(B representation-type 
392 \e$B$rCN$C$F$*$j!"$=$N\e(B representation-type \e$B$K1~$8$F<B:]$N=hM}$r9T$&4X?t$r8F\e(B
393 \e$B$S=P$7$^$9!#$3$N$h$&$J4X?t$r\e(B @strong{entity \e$B=hM}\e(Bmethod} \e$B$H8F$S$^$9!#$^$?!"\e(B
394 representation-type \e$BKh$K$3$N$h$&$J4X?t$r$^$H$a$?$b$N$r\e(B 
395 @strong{mm-backend} \e$B$H8F$S$^$9!#\e(B@refill
396
397 mm-backend \e$B$O\e(B representation-type \e$B$NL>A0$N@hF,$K\e(B @code{mm} \e$B$H$$$&\e(B
398 \e$B@\F,<-$rIU$1$?4X?tL>$+$i$J$k\e(B module \e$B$G!"$=$N\e(B module \e$BL>$OF1MM$K\e(B
399 representation-type \e$B$NL>A0$N@hF,$K\e(B @code{mm} \e$B$rIU$1$?$b$N$K$J$C$F\e(B
400 \e$B$$$^$9!#$3$N\e(B module \e$B$O\e(B representation-type \e$B$N\e(B entity \e$B$,:G=i$K@8@.$5$l$k\e(B
401 \e$B;~$K<+F0E*$K\e(B require \e$B$5$l$^$9!#\e(B
402
403
404 @menu
405 * Request for entity::          Message-passing for entity
406 * mm-backend module::           How to make mm-backend
407 @end menu
408
409 @node Request for entity, mm-backend module, mm-backend, mm-backend
410 @subsection Message-passing for entity
411
412 @defun mime-entity-send entity message  &rest  args
413
414 @var{entity} \e$B$K\e(B @var{message} \e$B$rAw$k!#\e(B@refill
415
416 @var{args} \e$B$O\e(B @var{message} \e$B$N0z?t$G$"$k!#\e(B
417 @end defun
418
419
420
421 @node mm-backend module,  , Request for entity, mm-backend
422 @subsection How to make mm-backend
423
424 \e$B!J$9$_$^$;$s!#$=$N$&$A=q$-$^$9\e(B (^_^;\e$B!K\e(B@refill
425
426 \e$B!J$H$j$"$($:!"\e(Bmm*.el \e$B$r;29M$K$7$F$/$@$5$$!K\e(B
427
428
429 @node Content-Type, Content-Disposition, Entity, Top
430 @chapter Information of Content-Type field
431 @cindex mime-content-type
432 @cindex Content-Type field
433
434 @strong{Content-Type field} is a field to indicate kind of contents or
435 data format, such as media-type (@ref{media-type}) and MIME charset.  It
436 is defined in RFC 2045 (@ref{RFC 2045}).
437
438 @noindent
439 @strong{[Memo]}
440 @quotation
441
442 Historically, Content-Type field was proposed in RFC 1049.  In it,
443 Content-Type did not distinguish type and subtype, and there are no
444 mechanism to represent kind of character code like MIME charset.
445 @end quotation
446
447
448 FLIM \e$B$O\e(B Content-Type \e$BMs$r9=J82r@O$9$k4X?t$H\e(B Content-Type \e$BMs$N2r@O7k2L$r\e(B
449 \e$B3JG<$9$k9=B$BN\e(B @strong{mime-content-type} \e$B$rDs6!$7$^$9!#\e(B
450
451
452 @menu
453 * Content-Type field::          Format of Content-Type field
454 * mime-content-type::           mime-content-type structure
455 * Content-Type parser::         Content-Type \e$BMs$N2r@O4o\e(B
456 * Content-Type utility::        Content-Type \e$B$K4X$9$kM-MQ$J4X?t\e(B
457 @end menu
458
459 @node Content-Type field, mime-content-type, Content-Type, Content-Type
460 @section Format of Content-Type field
461 @cindex parameter
462 @cindex subtype
463 @cindex type
464
465 Content-Type \e$BMs$N7A<0$O0J2<$N$h$&$KDj5A$5$l$F$$$^$9!'\e(B
466
467 @quotation
468 ``Content-Type'' ``:'' @strong{type} ``/''
469 @strong{subtype} *( ``;'' @strong{parameter} )
470 @end quotation
471
472 \e$BNc$($P!"\e(B
473
474 @quotation
475 @example
476 Content-Type: image/jpeg
477 @end example
478 @end quotation
479
480 @noindent
481 \e$B$d\e(B
482
483 @quotation
484 @example
485 Content-Type: text/plain; charset=iso-2022-jp
486 @end example
487 @end quotation
488
489 @noindent
490 \e$B$J$I$N$h$&$KMQ$$$i$l$^$9!#\e(B
491
492 \e$B$3$3$G!"\e(B`type' \e$B$H\e(B `subtype' \e$B$O\e(B entity \e$B$N7A<0$r<($9$b$N$G!"N><T$rAm>N$7\e(B
493 \e$B$F!"\e(B`media-type' \e$B$H8F$V$3$H$K$7$^$9!#>e5-$NNc$K$*$1$k\e(B `image/jpeg' \e$B$d\e(B
494 `text/plain' \e$B$O\e(B media-type \e$B$N#1$D$G$9!#\e(B
495
496 @noindent
497 @strong{[Memo]}
498 @quotation
499
500 Content-Type \e$BMs$N$J$$\e(B entity \e$B$O\e(B
501
502 @quotation
503 @example
504 Content-Type: text/plain; charset=us-ascii
505 @end example
506 @end quotation
507
508 @noindent
509 \e$B$H$7$F2r<a$5$l$k!#\e(B(cf. @ref{us-ascii})
510 @end quotation
511
512
513
514 @node mime-content-type, Content-Type parser, Content-Type field, Content-Type
515 @section mime-content-type structure
516
517 @deffn{Structure} mime-content-type
518
519 Content-Type \e$BMs$N>pJs$r3JG<$9$k$?$a$N9=B$BN!#\e(B@refill
520
521 \e$B$3$N9=B$BN$r;2>H$9$k$K$O\e(B @code{mime-content-type-\e$BMWAGL>\e(B} \e$B$H$$$&L>A0$N;2\e(B
522 \e$B>H4X?t$rMQ$$$k!#\e(B@refill
523
524 \e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'\e(B
525
526 @table @var
527 @item primary-type
528 media-type \e$B$N<g7?\e(B (symbol).
529
530 @item subtype
531 media-type \e$B$NI{7?\e(B (symbol).
532
533 @item parameters
534 Content-Type \e$BMs$N\e(B parameter (\e$BO"A[\e(B list).
535
536 @end table
537 @end deffn
538
539
540 @defun make-mime-content-type type subtype
541            &optional  parameters
542
543 content-type \e$B$N@8@.;R!#\e(B
544 @end defun
545
546
547 @defun mime-content-type-parameter content-type parameter
548
549 @var{content-type} \e$B$N\e(B @var{parameter} \e$B$NCM$rJV$9!#\e(B
550 @end defun
551
552
553
554 @node Content-Type parser, Content-Type utility, mime-content-type, Content-Type
555 @section Content-Type \e$BMs$N2r@O4o\e(B
556
557 @defun mime-parse-Content-Type string
558
559 @var{string} \e$B$r\e(B content-type \e$B$H$7$F2r@O$7$?7k2L$rJV$9!#\e(B
560 @end defun
561
562
563 @defun mime-read-Content-Type
564
565 \e$B8=:_$N\e(B buffer \e$B$N\e(B Content-Type \e$BMs$rFI$_<h$j!"2r@O$7$?7k2L$rJV$9!#\e(B@refill
566
567 Content-Type \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
568 @end defun
569
570
571
572 @node Content-Type utility,  , Content-Type parser, Content-Type
573 @section Content-Type \e$B$K4X$9$kM-MQ$J4X?t\e(B
574
575 @defun mime-type/subtype-string type  &optional  subtype
576
577 @var{type} \e$B$H\e(B @var{subtype} \e$B$+$i\e(B type/subtype \e$B7A<0$NJ8;zNs$rJV$9!#\e(B
578 @end defun
579
580
581
582 @node Content-Disposition, Content-Transfer-Encoding, Content-Type, Top
583 @chapter Content-Disposition \e$BMs$N>pJs\e(B
584 @cindex mime-content-disposition
585 @cindex RFC 2183
586 @cindex Standards Track
587 @cindex Content-Disposition \e$BMs\e(B
588
589 @strong{Content-Disposition \e$BMs\e(B} \e$B$O\e(B entity \e$B$NI=<($d\e(B file \e$BL>$J$I\e(B
590 \e$B$NB0@-$K$J$I$K4X$9$k>pJs$r5-=R$9$k$?$a$N$b$N$G$9!#\e(B
591
592
593 @noindent
594 [RFC 2183]
595 @quotation
596 S. Dorner, K. Moore and R. Troost, ``Communicating Presentation
597 Information in Internet Messages: The Content-Disposition Header'',
598 August 1997, Standards Track.
599 @end quotation
600
601 FLIM \e$B$O\e(B Content-Disposition \e$BMs$r9=J82r@O$9$k4X?t$H\e(B Content-Disposition 
602 \e$BMs$N2r@O7k2L$r3JG<$9$k9=B$BN\e(B 
603 @strong{mime-content-disposition} \e$B$rDs6!$7$^$9!#\e(B
604
605
606 @menu
607 * mime-content-disposition::    mime-content-disposition \e$B9=B$BN\e(B
608 * Content-Disposition parser::  Content-Disposition \e$BMs$N2r@O4o\e(B
609 @end menu
610
611 @node mime-content-disposition, Content-Disposition parser, Content-Disposition, Content-Disposition
612 @section mime-content-disposition \e$B9=B$BN\e(B
613
614 @deffn{Structure} mime-content-disposition
615
616 Content-Disposition \e$BMs$N2r@O7k2L$r<}$a$k$?$a$N9=B$BN!#\e(B@refill
617
618 \e$B$3$N9=B$BN$r;2>H$9$k$K$O\e(B @code{mime-content-disposition-\e$BMWAGL>\e(B} \e$B$H$$$&L>\e(B
619 \e$BA0$N;2>H4X?t$rMQ$$$k!#\e(B@refill
620
621 \e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'\e(B
622
623 @table @var
624 @item disposition-type
625 disposition-type (symbol).
626
627 @item parameters
628 Content-Disposition \e$BMs$N\e(B parameter (\e$BO"A[\e(B list).
629
630 @end table
631 @end deffn
632
633
634 @defun mime-content-disposition-parameter content-disposition parameter
635
636 @var{content-disposition} \e$B$N\e(B @var{parameter} \e$B$NCM$rJV$9!#\e(B
637 @end defun
638
639
640 @defun mime-content-disposition-filename content-disposition
641
642 @var{content-disposition} \e$B$N\e(B filename \e$B$NCM$rJV$9!#\e(B
643 @end defun
644
645
646
647 @node Content-Disposition parser,  , mime-content-disposition, Content-Disposition
648 @section Content-Disposition \e$BMs$N2r@O4o\e(B
649
650 @defun mime-parse-Content-Disposition string
651
652 @var{string} \e$B$r\e(B content-disposition \e$B$H$7$F2r@O$7$?7k2L$rJV$9!#\e(B
653 @end defun
654
655
656 @defun mime-read-Content-Disposition
657
658 \e$B8=:_$N\e(B buffer \e$B$N\e(B Content-Disposition \e$BMs$rFI$_<h$j!"2r@O$7$?7k2L$rJV$9!#\e(B
659 @refill
660
661 Content-Disposition \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
662 @end defun
663
664
665
666 @node Content-Transfer-Encoding, encoded-word, Content-Disposition, Top
667 @chapter \e$BId9f2=K!\e(B
668 @cindex Content-Transfer-Encoding \e$BMs\e(B
669
670 @strong{Content-Transfer-Encoding \e$BMs\e(B} \e$B$O\e(B entity \e$B$NId9f2=K!$r5-=R$9$k$?$a\e(B
671 \e$B$N$b$N$G$9!#\e(B@refill
672
673 FLIM \e$B$G$O\e(B Content-Transfer-Encoding \e$BMs$r9=J82r@O$9$k4X?t$rDs6!$7$^$9!#$3\e(B
674 \e$B$l$i$N4X?t$O\e(B Content-Transfer-Encoding \e$BMs$N>pJs$OJ8;zNs$GI=8=$7$^$9!#\e(B
675 @refill
676
677 \e$B$^$?!"\e(BContent-Transfer-Encoding \e$B$K4p$E$$$FId9f2=!&I|9f2=$r9T$&4X?t$bDs\e(B
678 \e$B6!$5$l$^$9!#\e(B
679
680
681 @menu
682 * Content-Transfer-Encoding parser::  Content-Transfer-Encoding \e$BMs$N2r@O4o\e(B
683 * Region encoder/decoder::      \e$BNN0h$NId9f2=!&I|9f2=\e(B
684 * String encoder/decoder::      \e$BJ8;zNs$NId9f2=!&I|9f2=\e(B
685 * File encoder/decoder::        File \e$B$NId9f2=!&I|9f2=\e(B
686 @end menu
687
688 @node Content-Transfer-Encoding parser, Region encoder/decoder, Content-Transfer-Encoding, Content-Transfer-Encoding
689 @section Content-Transfer-Encoding \e$BMs$N2r@O4o\e(B
690
691 @defun mime-parse-Content-Transfer-Encoding string
692
693 @var{string} \e$B$r\e(B content-transfer-encoding \e$B$H$7$F2r@O$7$?7k2L$rJV$9!#\e(B
694 @end defun
695
696
697 @defun mime-read-Content-Transfer-Encoding &optional default-encoding
698
699 \e$B8=:_$N\e(B buffer \e$B$N\e(B Content-Transfer-Encoding \e$BMs$rFI$_<h$j!"2r@O$7$?7k2L$r\e(B
700 \e$BJV$9!#\e(B@refill
701
702 Content-Transfer-Encoding \e$BMs$,B8:_$7$J$$>l9g$O\e(B@var{default-encoding} \e$B$r\e(B
703 \e$BJV$9!#\e(B
704 @end defun
705
706
707
708 @node Region encoder/decoder, String encoder/decoder, Content-Transfer-Encoding parser, Content-Transfer-Encoding
709 @section \e$BNN0h$NId9f2=!&I|9f2=\e(B
710
711 @defun mime-encode-region start end encoding
712
713 Encode region @var{start} to @var{end} of current buffer using
714 @var{encoding}.
715 @end defun
716
717
718 @defun mime-decode-region start end encoding
719
720 Decode region @var{start} to @var{end} of current buffer using
721 @var{encoding}.
722 @end defun
723
724
725 @defvar mime-encoding-method-alist
726
727 Alist of encoding vs. corresponding method to encode region.@refill
728
729 Each element looks like @code{(STRING . FUNCTION)} or @code{(STRING
730 . nil)}.  @var{string} is content-transfer-encoding.  @code{function} is
731 region encoder and @code{nil} means not to encode.
732 @end defvar
733
734
735 @defvar mime-decoding-method-alist
736
737 Alist of encoding vs. corresponding method to decode region.@refill
738
739 Each element looks like @code{(STRING . FUNCTION)} or @code{(STRING
740 . nil)}.  @var{string} is content-transfer-encoding.  @code{function} is
741 region decoder and @code{nil} means not to decode.
742 @end defvar
743
744
745
746 @node String encoder/decoder, File encoder/decoder, Region encoder/decoder, Content-Transfer-Encoding
747 @section \e$BJ8;zNs$NId9f2=!&I|9f2=\e(B
748
749 @defun mime-decode-string string encoding
750
751 @var{string} \e$B$r\e(B @var{encoding} \e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#\e(B
752 @end defun
753
754
755 @defvar mime-string-decoding-method-alist
756
757 Alist of encoding vs. corresponding method to decode string.@refill
758
759 Each element looks like @code{(STRING . FUNCTION)}.  STRING is
760 content-transfer-encoding.  FUNCTION is string decoder.
761 @end defvar
762
763
764
765 @node File encoder/decoder,  , String encoder/decoder, Content-Transfer-Encoding
766 @section File \e$B$NId9f2=!&I|9f2=\e(B
767
768 @defun mime-insert-encoded-file filename encoding
769
770 Insert file @var{FILENAME} encoded by @var{ENCODING} format.
771 @end defun
772
773
774 @defun mime-write-decoded-region start end filename encoding
775
776 Decode and write current region encoded by @var{encoding} into
777 @var{filename}.@refill
778
779 @var{start} and @var{end} are buffer positions.
780 @end defun
781
782
783 @defvar mime-file-encoding-method-alist
784
785 Alist of encoding vs. corresponding method to insert encoded
786 file.@refill
787
788 Each element looks like @code{(STRING . FUNCTION)}.  STRING is
789 content-transfer-encoding.  FUNCTION is function to insert encoded file.
790 @end defvar
791
792
793 @defvar mime-file-decoding-method-alist
794
795 Alist of encoding vs. corresponding method to write decoded region to
796 file.@refill
797
798 Each element looks like @code{(STRING . FUNCTION)}.  STRING is
799 content-transfer-encoding.  FUNCTION is function to write decoded region
800 to file.
801 @end defvar
802
803
804
805 @node encoded-word, custom, Content-Transfer-Encoding, Top
806 @chapter Header \e$B$N\e(B network \e$BI=8=\e(B
807 @cindex RFC 2047
808 @cindex Standards Track
809 @cindex RFC 2047
810
811 encoded-word \e$B$O\e(B header \e$B$GHs\e(B ASCII (@ref{ASCII}) \e$BJ8;z$rI=8=$9$k$?$a$N7A<0\e(B
812 \e$B$G!"\e(B@strong{RFC 2047} \e$B$GDj5A$5$l$F$$$^$9!#\e(B@refill
813
814
815 @noindent
816 [RFC 2047]
817 @quotation
818 K. Moore, ``MIME (Multipurpose Internet Mail Extensions) Part Three:
819 Message Header Extensions for Non-ASCII Text'', November 1996, Standards
820 Track (obsolete RFC 1521,1522,1590).
821 @end quotation
822
823 \e$B$^$?!"9T57$N0-$$$3$H$@$H8@$($^$9$,!"\e(Bencoded-word \e$B$rMQ$$$:$KHs\e(B ASCII
824 (@ref{ASCII}) \e$BJ8;z$r\e(B header \e$B$KF~$l$?5-;v$bB8:_$7$^$9!#\e(B@refill
825
826 FLIM \e$B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#\e(B
827
828
829 @menu
830 * Header encoder/decoder::      Header \e$B$NId9f2=!&I|9f2=\e(B
831 @end menu
832
833 @node Header encoder/decoder,  , encoded-word, encoded-word
834 @section Header \e$B$NId9f2=!&I|9f2=\e(B
835
836 @defun eword-encode-header &optional  code-conversion separator
837
838 Decode MIME encoded-words in header fields.@refill
839
840 If @var{code-conversion} is @code{nil}, it decodes only encoded-words.
841 If it is mime-charset, it decodes non-ASCII bit patterns as the
842 mime-charset.  Otherwise it decodes non-ASCII bit patterns as the
843 default-mime-charset.@refill
844
845 If @var{separator} is not nil, it is used as header separator.
846 @end defun
847
848
849 @defun eword-encode-header &optional  code-conversion
850
851 Encode header fields to network representation, such as MIME
852 encoded-word.@refill
853
854 It refer variable @code{eword-field-encoding-method-alist}.
855 @end defun
856
857
858
859 @node custom, Appendix, encoded-word, Top
860 @chapter \e$B0lHL@_Dj\e(B
861
862 @deffn{group} mime
863
864 MIME \e$B4XO"5!G=$K4X$9$k\e(B group.@refill
865
866 @code{mail} \e$B$H\e(B @code{news} \e$B$KB0$9$k!#\e(B
867 @end deffn
868
869
870 @defvar default-mime-charset
871
872 \e$BE,@Z$J\e(B MIME charset (@ref{MIME charset}) \e$B$,8+$D$+$i$J$+$C$?>l9g$KMQ$$$i\e(B
873 \e$B$l$k\e(BMIME charset.@refill
874
875 \e$BK\Mh$O\e(B APEL \e$B$NJQ?t$G$"$k!#\e(B
876 @end defvar
877
878
879 @defvar mime-temp-directory
880
881 MIME \e$B5!G=$K4X$9$k<BAu$,0l;~E*$K;HMQ$9$k\e(B file \e$B$r:n@.$9$k\e(B 
882 directory.@refill
883
884 \e$B4D6-JQ?t\e(B @code{MIME_TMP_DIR}, @code{TM_TMP_DIR}, @code{TMPDIR},
885 @code{TMP} \e$B$b$7$/$O\e(B @code{TEMP} \e$B$,@_Dj$5$l$F$$$?>l9g!"$=$l$r=i4|CM$H$7$F\e(B
886 \e$BMQ$$$k!#2?$b@_Dj$5$l$F$$$J$$>l9g!"\e(B@code{"/tmp/"} \e$B$rMQ$$$k!#\e(B
887 @end defvar
888
889
890
891 @node Appendix, Concept Index, custom, Top
892 @chapter Appendix
893
894
895 @menu
896 * Glossary::                    
897 * Bug report::                  How to report bugs
898 * CVS::                         CVS based development
899 * History::                     History of FLIM
900 @end menu
901
902 @node Glossary, Bug report, Appendix, Appendix
903 @section Glossary
904
905
906 @menu
907 * 7bit::                        
908 * 8bit::                        
909 * ASCII::                       
910 * Base64::                      
911 * binary::                      
912 * coded character set::         Coded character set, Character code
913 * media-type::                  
914 * message::                     
915 * MIME::                        
916 * MIME charset::                
917 * MTA::                         
918 * MUA::                         
919 * Quoted-Printable::            
920 * RFC 822::                     
921 * RFC 1036::                    
922 * RFC 2045::                    
923 * RFC 2046::                    
924 * RFC 2048::                    
925 * RFC 2049::                    
926 * plain text::                  
927 * us-ascii::                    
928 @end menu
929
930 @node 7bit, 8bit, Glossary, Glossary
931 @subsection 7bit
932 @cindex 7bit (textual) string
933 @cindex 7bit data
934 @cindex 7bit
935
936 @strong{7bit} means any integer between 0 .. 127.@refill
937
938 Any data represented by 7bit integers is called @strong{7bit data}.@refill
939
940 Textual string consisted of Control characters between 0 .. 31 and 127,
941 and space represented by 32, and graphic characters between 33 .. 236
942 are called @strong{7bit (textual) string}.@refill
943
944 Conventional Internet MTA (@ref{MTA}) can translate 7bit data, so it is
945 no need to translate by Quoted-Printable (@ref{Quoted-Printable}) or
946 Base64 (@ref{Base64}) for 7bit data.@refill
947
948 However if there are too long lines, it can not translate by 7bit MTA
949 even if it is 7bit data.  RFC 821 (@ref{RFC 821}) and RFC 2045 (@ref{RFC 2045}) require lines in 7bit data must be less than 998 bytes.  So if a
950 ``7bit data'' has a line more than 999 bytes, it is regarded as binary
951 (@ref{binary}).  For example, Postscript file should be encoded by
952 Quoted-Printable.
953
954
955 @node 8bit, ASCII, 7bit, Glossary
956 @subsection 8bit
957 @cindex 8bit (textual) string
958 @cindex 8bit data
959 @cindex 8bit
960
961 @strong{8bit} means any integer between 0 .. 255.@refill
962
963 Any data represented by 8bit integers is called @strong{8bit data}.@refill
964
965 Textual string consisted of Control characters between 0 .. 31, 127, and
966 128 .. 159, and space represented by 32, and graphic characters between
967 33 .. 236 and 160 .. 255 are called @strong{8bit (textual) string}.@refill
968
969 For example, iso-8859-1 (@ref{iso-8859-1}) or euc-kr (@ref{euc-kr}) are
970 coded-character-set represented by 8bit textual string.@refill
971
972 Traditional Internet MTA (@ref{MTA}) can translate only 7bit
973 (@ref{7bit}) data, so if a 8bit data will be translated such MTA, it
974 must be encoded by Quoted-Printable (@ref{Quoted-Printable}) or Base64
975 (@ref{Base64}).@refill
976
977 However 8bit MTA are increasing today.@refill
978
979 However if there are too long lines, it can not translate by 8bit MTA
980 even if it is 8bit data.  RFC 2045 (@ref{RFC 2045}) require lines in
981 8bit data must be less than 998 bytes.  So if a ``8bit data'' has a line
982 more than 999 bytes, it is regarded as binary (@ref{binary}), so it must
983 be encoded by Base64 or Quoted-Printable.
984
985
986 @node ASCII, Base64, 8bit, Glossary
987 @subsection ASCII
988 @cindex ANSI X3.4:1986
989 @cindex ASCII
990 @cindex ASCII
991
992 @strong{ASCII} is a 94-character set contains primary latin characters
993 (A-Z, a-z), numbers and some characters.  It is a standard of the United
994 States of America.  It is a variant of ISO 646 (@ref{ISO 646}).
995
996
997 @noindent
998 [ASCII]
999 @quotation
1000 ``Coded Character Set -- 7-Bit American Standard Code for Information
1001 Interchange'', ANSI X3.4:1986.
1002 @end quotation
1003
1004
1005
1006 @node Base64, binary, ASCII, Glossary
1007 @subsection Base64
1008 @cindex pad
1009 @cindex Base64
1010
1011 @strong{Base64} is a transfer encoding method of MIME (@ref{MIME})
1012 defined in RFC 2045 (@ref{RFC 2045}).@refill
1013
1014 The encoding process represents 24-bit groups of input bits as output
1015 strings of 4 encoded characters.  Encoded characters represent integer 0
1016 .. 63 or @strong{pad}.  Base64 data must be 4 * n bytes, so pad is used
1017 to adjust size.@refill
1018
1019 These 65 characters are subset of all versions of ISO 646, including
1020 US-ASCII, and all versions of EBCDIC.  So it is safe even if it is
1021 translated by non-Internet gateways.
1022
1023
1024 @node binary, coded character set, Base64, Glossary
1025 @subsection binary
1026 @cindex binary
1027
1028 Any byte stream is called @strong{binary}.@refill
1029
1030 It does not require structureof lines.  It differs from from 8bit
1031 (@ref{8bit}).@refill
1032
1033 In addition, if line structured data contain too long line (more than
1034 998 bytes), it is regarded as binary.
1035
1036
1037 @node coded character set, media-type, binary, Glossary
1038 @subsection Coded character set, Character code
1039
1040 A set of unambiguous rules that establishes a character set and the
1041 one-to-one relationship between the characters of the set and their
1042 bit combinations.
1043
1044
1045 @node media-type, message, coded character set, Glossary
1046 @subsection media-type
1047 @cindex x-token
1048 @cindex message
1049 @cindex multipart
1050 @cindex application
1051 @cindex video
1052 @cindex audio
1053 @cindex image
1054 @cindex text
1055 @cindex subtype
1056 @cindex type
1057 @cindex media-type
1058
1059 @strong{media-type} specifies the nature of the data in the body of MIME
1060 (@ref{MIME}) entity (@ref{entity}).  It consists of @strong{type} and
1061 @strong{subtype}.  It is defined in RFC 2046 (@ref{RFC 2046}).@refill
1062
1063 Currently there are following standard primary-types:
1064
1065 @itemize @bullet
1066 @item
1067 @strong{text}
1068 @item
1069 @strong{image}
1070 @item
1071 @strong{audio}
1072 @item
1073 @strong{video}
1074 @item
1075 @strong{application}
1076 @item
1077 @strong{multipart} (@ref{multipart})
1078 @item
1079 @strong{message}
1080 @end itemize
1081
1082
1083 And there are various subtypes, for example, application/octet-stream,
1084 audio/basic, image/jpeg, multipart/mixed (@ref{multipart/mixed}),
1085 text/plain (@ref{text/plain}), video/mpeg...  @refill
1086
1087 You can refer registered media types at MEDIA TYPES
1088 (ftp://ftp.isi.edu/in-notes/iana/assignments/media-types).@refill
1089
1090 In addition, you can use private type or subtype using @strong{x-token},
1091 which as the prefix `x-'.  However you can not use them in
1092 public.@refill
1093
1094 (cf. @ref{Content-Type field})
1095
1096
1097
1098 @node message, MIME, media-type, Glossary
1099 @subsection message
1100
1101 In this document, it means mail defined in RFC 822 (@ref{RFC 822}) and
1102 news message defined in RFC 1036 (@ref{RFC 1036}).
1103
1104
1105 @node MIME, MIME charset, message, Glossary
1106 @subsection MIME
1107 @cindex Multipurpose Internet Mail Extensions
1108
1109 MIME stands for @strong{Multipurpose Internet Mail Extensions}, it is an
1110 extension for RFC 822 (@ref{RFC 822}).@refill
1111
1112 According to RFC 2045:@refill
1113
1114 STD 11, RFC 822, defines a message representation protocol specifying
1115 considerable detail about US-ASCII message headers, and leaves the
1116 message content, or message body, as flat US-ASCII text.  This set of
1117 documents, collectively called the Multipurpose Internet Mail
1118 Extensions, or MIME, redefines the format of messages to allow for
1119
1120 @enumerate
1121 @item
1122 textual message bodies in character sets other than US-ASCII,
1123 @item
1124 an extensible set of different formats for non-textual message
1125 bodies,
1126 @item
1127 multi-part message bodies, and
1128 @item
1129 textual header information in character sets other than US-ASCII.
1130 @end enumerate
1131
1132
1133 It is defined in RFC 2045 (@ref{RFC 2045}), RFC 2046 (@ref{RFC 2046}),
1134 RFC 2047 (@ref{encoded-word}), RFC 2048 (@ref{RFC 2048}) and RFC 2049
1135 (@ref{RFC 2049}).
1136
1137
1138 @node MIME charset, MTA, MIME, Glossary
1139 @subsection MIME charset
1140
1141 Coded character set (@ref{coded character set}) used in Content-Type
1142 field (@ref{Content-Type field}) or charset parameter of encoded-word
1143 (@ref{encoded-word}).@refill
1144
1145 It is defined in RFC 2045 (@ref{RFC 2045}).@refill
1146
1147 iso-2022-jp (@ref{iso-2022-jp}) or euc-kr (@ref{euc-kr}) are kinds of
1148 it.  (In this document, MIME charsets are written by small letters to
1149 distinguish graphic character set (@ref{graphic character set}).  For
1150 example, ISO 8859-1 is a graphic character set, and iso-8859-1 is a MIME
1151 charset)
1152
1153
1154 @node MTA, MUA, MIME charset, Glossary
1155 @subsection MTA
1156 @cindex Message Transfer Agent
1157
1158 @strong{Message Transfer Agent}.  It means mail transfer programs
1159 (ex. sendmail) and news servers.@refill
1160
1161 (cf. @ref{MUA})
1162
1163
1164
1165 @node MUA, Quoted-Printable, MTA, Glossary
1166 @subsection MUA
1167 @cindex Message User Agent
1168
1169 @strong{Message User Agent}.  It means mail readers and news
1170 readers.@refill
1171
1172 (cf. @ref{MTA})
1173
1174
1175
1176 @node Quoted-Printable, RFC 822, MUA, Glossary
1177 @subsection Quoted-Printable
1178 @cindex Quoted-Printable
1179
1180 @strong{Quoted-Printable} is a transfer encoding method of MIME
1181 (@ref{MIME}) defined in RFC 2045 (@ref{RFC 2045}).@refill
1182
1183 If the data being encoded are mostly US-ASCII text, the encoded form of
1184 the data remains largely recognizable by humans.@refill
1185
1186 (cf. @ref{Base64})
1187
1188
1189
1190 @node RFC 822, RFC 1036, Quoted-Printable, Glossary
1191 @subsection RFC 822
1192 @cindex RFC 822
1193 @cindex STD 11
1194 @cindex Internet mail
1195 @cindex Internet message
1196 @cindex message header
1197
1198 A RFC defines format of Internet mail message, mainly @strong{message header}.
1199
1200 @noindent
1201 @strong{[Memo]}
1202 @quotation
1203
1204 news message is based on RFC 822, so @strong{Internet message} may be
1205 more suitable than @strong{Internet mail} .
1206 @end quotation
1207
1208
1209
1210 @noindent
1211 [RFC 822]
1212 @quotation
1213 D. Crocker, ``Standard for the Format of ARPA Internet Text Messages'',
1214 August 1982, STD 11.
1215 @end quotation
1216
1217
1218
1219 @node RFC 1036, RFC 2045, RFC 822, Glossary
1220 @subsection RFC 1036
1221 @cindex RFC 1036
1222 @cindex USENET
1223
1224 A RFC defines format of USENET message.  It is a subset of RFC 822
1225 (@ref{RFC 822}).  It is not Internet standard, but a lot of netnews
1226 excepting Usenet uses it.
1227
1228
1229 @noindent
1230 [USENET: RFC 1036]
1231 @quotation
1232 M. Horton and R. Adams, ``Standard for Interchange of USENET Messages'',
1233 December 1987, (obsolete RFC 850).
1234 @end quotation
1235
1236
1237
1238 @node RFC 2045, RFC 2046, RFC 1036, Glossary
1239 @subsection RFC 2045
1240 @cindex RFC 2045
1241 @cindex Standards Track
1242
1243
1244 @noindent
1245 [RFC 2045]
1246 @quotation
1247 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1248 (MIME) Part One: Format of Internet Message Bodies'', November 1996,
1249 Standards Track (obsolete RFC 1521, 1522, 1590).
1250 @end quotation
1251
1252
1253
1254 @node RFC 2046, RFC 2048, RFC 2045, Glossary
1255 @subsection RFC 2046
1256 @cindex RFC 2046
1257 @cindex Standards Track
1258
1259
1260 @noindent
1261 [RFC 2046]
1262 @quotation
1263 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1264 (MIME) Part Two: Media Types'', November 1996, Standards Track (obsolete
1265 RFC 1521, 1522, 1590).
1266 @end quotation
1267
1268
1269
1270 @node RFC 2048, RFC 2049, RFC 2046, Glossary
1271 @subsection RFC 2048
1272 @cindex RFC 2048
1273 @cindex Standards Track
1274
1275
1276 @noindent
1277 [RFC 2048]
1278 @quotation
1279 N. Freed, J. Klensin and J. Postel, ``Multipurpose Internet Mail
1280 Extensions (MIME) Part Four: Registration Procedures'', November 1996,
1281 Standards Track (obsolete RFC 1521, 1522, 1590).
1282 @end quotation
1283
1284
1285
1286 @node RFC 2049, plain text, RFC 2048, Glossary
1287 @subsection RFC 2049
1288 @cindex RFC 2049
1289 @cindex Standards Track
1290
1291
1292 @noindent
1293 [RFC 2049]
1294 @quotation
1295 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1296 (MIME) Part Five: Conformance Criteria and Examples'', November 1996,
1297 Standards Track (obsolete RFC 1521, 1522, 1590).
1298 @end quotation
1299
1300
1301
1302 @node plain text, us-ascii, RFC 2049, Glossary
1303 @subsection plain text
1304
1305 A textual data represented by only coded character set (@ref{coded character set}).  It does not have information about font or
1306 typesetting.  (cf. @ref{text/plain})
1307
1308
1309
1310 @node us-ascii,  , plain text, Glossary
1311 @subsection us-ascii
1312 @cindex ASCII
1313 @cindex us-ascii
1314
1315 A MIME charset (@ref{MIME charset}) for primary Latin script mainly
1316 written by English or other languages.@refill
1317
1318 It is a 7bit coded character set (@ref{coded character set}) based on
1319 ISO 2022 (@ref{ISO 2022}), it contains only ASCII (@ref{ASCII}) and code
1320 extension (@ref{code extension}) is not allowed.@refill
1321
1322 It is standard coded character set of Internet mail.  If MIME charset is
1323 not specified, @strong{us-ascii} is used as default.@refill
1324
1325 In addition, @strong{ASCII} of RFC 822 (@ref{RFC 822}) should be
1326 interpreted as us-ascii.
1327
1328
1329 @node Bug report, CVS, Glossary, Appendix
1330 @section How to report bugs
1331 @cindex good bug report
1332
1333 If you write bug-reports and/or suggestions for improvement, please
1334 send them to the tm Mailing List:
1335
1336 @itemize @bullet
1337 @item
1338  Japanese <bug-tm-ja@@chamonix.jaist.ac.jp>
1339 @item
1340  English <bug-tm-en@@chamonix.jaist.ac.jp>
1341 @end itemize
1342
1343
1344 Notice that, we do not welcome bug reports about too old version.  Bugs
1345 in old version might be fixed.  So please try latest version at
1346 first.@refill
1347
1348 You should write @strong{good bug report}.  If you write only ``FLIM
1349 does not work'', we can not find such situations.  At least, you should
1350 write name, type, variants and version of OS, emacs, APEL, FLIM, SEMI
1351 and MUA, and setting.  In addition, if error occurs, to send backtrace
1352 is very important. (cf. @ref{(emacs)Bugs}) @refill
1353
1354 Bug may not appear only your environment, but also in a lot of
1355 environment (otherwise it might not bug).  Therefor if you send mail
1356 to author directly, we must write a lot of mails.  So please send mail
1357 to address for tm bugs instead of author.
1358
1359 Via the tm ML, you can report FLIM bugs, obtain the latest release of
1360 FLIM, and discuss future enhancements to FLIM.  To join the tm ML,
1361 send empty e-mail to:
1362
1363 @itemize @bullet
1364 @item
1365  Japanese <tm-ja-help@@chamonix.jaist.ac.jp>
1366 @item
1367  English  <tm-en-help@@chamonix.jaist.ac.jp>
1368 @end itemize
1369
1370
1371
1372 @node CVS, History, Bug report, Appendix
1373 @section CVS based development
1374
1375 FLIM \e$B$N\e(B file \e$B$O\e(B CVS \e$B$r;H$C$F4IM}$5$l$F$$$^$9!#$3$N$?$a!"0J2<$NJ}K!$G:G\e(B
1376 \e$B?7$N\e(B FLIM \e$B$rF~<j$9$k$3$H$,$G$-$^$9!'\e(B
1377
1378 @example
1379 (0) cvs login
1380
1381     % cvs -d :pserver:anonymous@@chamonix.jaist.ac.jp:/hare/cvs/root \
1382         login
1383
1384     CVS password: [CR] # NULL string
1385
1386 (1) checkout
1387
1388     % cvs -d :pserver:anonymous@@chamonix.jaist.ac.jp:/hare/cvs/root \
1389         checkout [-r TAG] flim
1390 @end example
1391
1392
1393 CVS \e$B$rMQ$$$?3+H/$K;22C$7$?$$J}$O\e(B
1394
1395 @itemize @bullet
1396 @item
1397  <cvs@@chamonix.jaist.ac.jp>
1398 @end itemize
1399
1400 @noindent
1401 \e$B$^$G!"\e(Baccount \e$BL>$H\e(B UNIX \e$B$N\e(B passwd \e$B$HF1$87A<0$N\e(B crypt \e$B2=$5$l$?\e(B password
1402 \e$B$r1h$($F8fO"Mm$/$@$5$$!#\e(B
1403
1404
1405 @node History,  , CVS, Appendix
1406 @section History of FLIM
1407
1408 FLIM \e$B$N\e(B code \e$B$N:G8E$NItJ,$O\e(B \e$B1]JB\e(B \e$B;LCR\e(B \e$B;a$,=q$$$?\e(B @file{mime.el}\e$B$K5/8;$7\e(B
1409 \e$B$^$9!#$3$N>.$5$J\e(B program \e$B$O\e(B Nemacs \e$B$GF0:n$9$k\e(B iso-2022-jp \e$B$N\e(B B-encoding 
1410 \e$B@lMQ$N\e(B encoded-word \e$B$NI|9f2=%W%m%0%i%`$G$7$?!#\e(B@refill
1411
1412 \e$B$=$N8e!"<i2,\e(B \e$BCNI'\e(B \e$B$O\e(B @file{mime.el} \e$B$r85$K\e(B@file{tiny-mime.el} \e$B$H$$$&%W%m\e(B
1413 \e$B%0%i%`$r=q$-$^$9!#$3$l$O!"\e(BNemacs \e$B$H\e(B Mule \e$B$GF0:n$9$k\e(B encoded-word \e$B$NId9f\e(B
1414 \e$B2=!&I|9f2=%W%m%0%i%`$G$7$?!#\e(B@file{tiny-mime.el} \e$B$O\e(B B-encoding \e$B$@$1$G$J$/\e(B 
1415 Q-encoding \e$B$b\e(Bsupport \e$B$7!"$^$?!"\e(BMULE \e$B$G07$&$3$H$,$G$-$k$5$^$6$^$J\e(B MIME
1416 charset (@ref{MIME charset}) \e$B$rF1;~$K;H$&$3$H$,$G$-$^$7$?!#$3$N;~!"\e(B
1417 Nemacs \e$B$H\e(B Mule \e$B$NAPJ}$r\e(B support \e$B$9$k$?$a$KMQ$$$i$l$?%F%/%K%C%/$O8e$K\e(B emu
1418 package \e$B$K$^$H$a$i$l$^$9!#\e(B@refill
1419
1420 \e$B$3$N:"!"<i2,\e(B \e$BCNI'\e(B \e$B$O\e(B @file{tiny-mime.el} \e$B$r$5$^$6$^$J\e(B MUA \e$B$G;H$&$?$a$N@_\e(B
1421 \e$BDj=8$bG[I[$7$F$$$^$7$?$,!"$=$l$i$O8e$K\e(B@file{tiny-mime.el} \e$B$H$H$b$K#1$D$N\e(B 
1422 package \e$B$K$^$H$a$i$l!"\e(Btm \e$B$H$$$&L>A0$GG[I[$5$l$^$9!#\e(B@refill
1423
1424 \e$B<i2,\e(B \e$BCNI'\e(B \e$B$O$d$,$F!"\e(BMIME message \e$B$r1\Mw$9$k$?$a$N%W%m%0%i%`$G$"$k\e(B
1425 @file{tm-body.el} \e$B$r=q$-$^$9!#$3$l$O!"$9$0$K\e(B@file{tm-view.el} \e$B$H$$$&L>A0\e(B
1426 \e$B$KJQ$o$j$^$7$?$,!"$d$,$F!"$3$l$,\e(B@file{tiny-mime.el} \e$B$KBe$o$C$F!"\e(Btm \e$B$NCf\e(B
1427 \e$B3K$H$J$j$^$9!#\e(B@refill
1428
1429 @file{tm-view.el} \e$B$OEvA3!"\e(BContent-Transfer-Encoding \e$B$r07$&I,MW$,$"$j$^$9!#\e(B
1430 \e$B$3$NL\E*$N$?$a$K!"\e(BMEL \e$B$,@0Hw$5$l$O$8$a$^$7$?!#\e(BBase64 \e$B$K4X$7$F$O\e(B 
1431 @file{tiny-mime.el} \e$B$N\e(B code \e$B$,0\$5$l!"$^$?!"?7$?$K\e(BQuoted-Printable \e$B$N\e(B 
1432 code \e$B$,DI2C$5$l$^$7$?!#$3$l$i$,\e(B@file{mel-b.el} \e$B$H\e(B @file{mel-q.el} \e$B$K$J$j\e(B
1433 \e$B$^$7$?!#\e(B@refill
1434
1435 \e$B$^$?!"8e$K!"<i2,\e(B \e$BCNI'\e(B \e$B$K$h$C$F\e(B uuencode \e$BMQ$N\e(B @file{mel-u.el} \e$B$,DI2C$5$l!"\e(B
1436 \e$B$=$N8e$K!">.NS\e(B \e$B=$J?\e(B \e$B;a$K$h$C$F\e(B x-gzip64 \e$BMQ$N\e(B@file{mel-g.el} \e$B$,DI2C$5$l$^\e(B
1437 \e$B$7$?!#\e(B@refill
1438
1439 tm \e$B$G$O8e$K!"<i2,\e(B \e$BCNI'\e(B \e$B$K$h$C$F\e(B @file{tiny-mime.el} \e$B$N:F<BAu$,9T$o$l!"$3\e(B
1440 \e$B$N2aDx$G!"\e(BSTD 11 \e$B$N\e(B parser \e$B$,=q$+$l$^$7$?!#$3$l$O!"8=:_$N\e(B 
1441 @file{std11.el} \e$B$KEv$?$j$^$9!#$^$?!"$3$N2aDx$G\e(B @file{tiny-mime.el} \e$B$OI|\e(B
1442 \e$B9f2=$r9T$&\e(B @file{tm-ew-d.el} \e$B$HId9f2=$r9T$&\e(B @file{tm-ew-e.el} \e$B$KJ,$1$i$l\e(B
1443 \e$B$^$7$?!#$3$NN><T$,8=:_$N\e(B @file{eword-decode.el} \e$B$H\e(B 
1444 @file{eword-encode.el} \e$B$N@hAD$KEv$?$j$^$9!#\e(B@refill
1445
1446 \e$B8e$K!"<i2,\e(B \e$BCNI'\e(B \e$B$i$K$h$C$F\e(B tm \e$B$NA4LL=q$-49$(:n6H$,9T$o$l!"$3$N2aDx$G!"\e(Btm 
1447 \e$B$O\e(B APEL, MEL, SEMI, EMH, RMAIL-MIME, Gnus-MIME \e$B$J$I$KJ,$1$i$l$^$7$?!#$3\e(B
1448 \e$B$N$&$A$N\e(B MEL \e$B$,\e(B FLIM \e$B$ND>@\$N@hAD$KEv$?$j$^$9!#\e(B@refill
1449
1450 \e$B8e$K!"\e(BAPEL \e$B$+$i\e(B @file{std11.el} \e$B$,0\$5$l!"$^$?!"\e(B@file{mailcap.el},
1451 @file{eword-decode.el} \e$B$*$h$S\e(B @file{eword-encode.el} \e$B$,\e(B SEMI \e$B$+$i0\$5$l!"\e(B
1452 package \e$B$NL>A0$,\e(B FLIM\e$B$H$J$j$^$9!#\e(B@refill
1453
1454 \e$B$3$ND>A0$+$iEDCf\e(B \e$BE/\e(B \e$B;a$,$h$j\e(B RFC \e$B$KCi<B$J<BAu$r=q$-;O$a!"$3$l$O!"8=:_!"\e(B
1455 FLIM \e$B$N;^$G$"$k\e(B ``FLIM-FLAM'' \e$B$H$J$C$F$$$^$9!#\e(B
1456
1457
1458 @node Concept Index, Function Index, Appendix, Top
1459 @chapter Concept Index
1460
1461 @printindex cp
1462
1463 @node Function Index, Variable Index, Concept Index, Top
1464 @chapter Function Index
1465
1466 @printindex fn
1467
1468 @node Variable Index,  , Function Index, Top
1469 @chapter Variable Index
1470
1471 @printindex vr
1472 @bye