update.
[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::         Information of Content-Disposition field
24 * Content-Transfer-Encoding::   Encoding Method
25 * encoded-word::                Network representation of header
26 * custom::                      Various Customization
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 provides parser for Content-Type field and structure
449 @strong{mime-content-type} to store information of
450 Content-Type field.
451
452
453 @menu
454 * Content-Type field::          Format of Content-Type field
455 * mime-content-type::           mime-content-type structure
456 * Content-Type parser::         Parser
457 * Content-Type utility::        Utility functions
458 @end menu
459
460 @node Content-Type field, mime-content-type, Content-Type, Content-Type
461 @section Format of Content-Type field
462 @cindex parameter
463 @cindex subtype
464 @cindex type
465
466 Content-Type \e$BMs$N7A<0$O0J2<$N$h$&$KDj5A$5$l$F$$$^$9!'\e(B
467
468 @quotation
469 ``Content-Type'' ``:'' @strong{type} ``/''
470 @strong{subtype} *( ``;'' @strong{parameter} )
471 @end quotation
472
473 \e$BNc$($P!"\e(B
474
475 @quotation
476 @example
477 Content-Type: image/jpeg
478 @end example
479 @end quotation
480
481 @noindent
482 \e$B$d\e(B
483
484 @quotation
485 @example
486 Content-Type: text/plain; charset=iso-2022-jp
487 @end example
488 @end quotation
489
490 @noindent
491 \e$B$J$I$N$h$&$KMQ$$$i$l$^$9!#\e(B
492
493 \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
494 \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
495 `text/plain' \e$B$O\e(B media-type \e$B$N#1$D$G$9!#\e(B
496
497 @noindent
498 @strong{[Memo]}
499 @quotation
500
501 Content-Type \e$BMs$N$J$$\e(B entity \e$B$O\e(B
502
503 @quotation
504 @example
505 Content-Type: text/plain; charset=us-ascii
506 @end example
507 @end quotation
508
509 @noindent
510 \e$B$H$7$F2r<a$5$l$k!#\e(B(cf. @ref{us-ascii})
511 @end quotation
512
513
514
515 @node mime-content-type, Content-Type parser, Content-Type field, Content-Type
516 @section mime-content-type structure
517
518 @deffn{Structure} mime-content-type
519
520 Content-Type \e$BMs$N>pJs$r3JG<$9$k$?$a$N9=B$BN!#\e(B@refill
521
522 \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
523 \e$B>H4X?t$rMQ$$$k!#\e(B@refill
524
525 \e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'\e(B
526
527 @table @var
528 @item primary-type
529 media-type \e$B$N<g7?\e(B (symbol).
530
531 @item subtype
532 media-type \e$B$NI{7?\e(B (symbol).
533
534 @item parameters
535 Content-Type \e$BMs$N\e(B parameter (\e$BO"A[\e(B list).
536
537 @end table
538 @end deffn
539
540
541 @defun make-mime-content-type type subtype
542            &optional  parameters
543
544 content-type \e$B$N@8@.;R!#\e(B
545 @end defun
546
547
548 @defun mime-content-type-parameter content-type parameter
549
550 @var{content-type} \e$B$N\e(B @var{parameter} \e$B$NCM$rJV$9!#\e(B
551 @end defun
552
553
554
555 @node Content-Type parser, Content-Type utility, mime-content-type, Content-Type
556 @section Parser
557
558 @defun mime-parse-Content-Type string
559
560 @var{string} \e$B$r\e(B content-type \e$B$H$7$F2r@O$7$?7k2L$rJV$9!#\e(B
561 @end defun
562
563
564 @defun mime-read-Content-Type
565
566 \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
567
568 Content-Type \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
569 @end defun
570
571
572
573 @node Content-Type utility,  , Content-Type parser, Content-Type
574 @section Utility functions
575
576 @defun mime-type/subtype-string type  &optional  subtype
577
578 Return type/subtype string from @var{type} and @var{subtype}.
579 @end defun
580
581
582
583 @node Content-Disposition, Content-Transfer-Encoding, Content-Type, Top
584 @chapter Information of Content-Disposition field
585 @cindex mime-content-disposition
586 @cindex RFC 2183
587 @cindex Standards Track
588 @cindex Content-Disposition \e$BMs\e(B
589
590 @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
591 \e$B$NB0@-$K$J$I$K4X$9$k>pJs$r5-=R$9$k$?$a$N$b$N$G$9!#\e(B
592
593
594 @noindent
595 [RFC 2183]
596 @quotation
597 S. Dorner, K. Moore and R. Troost, ``Communicating Presentation
598 Information in Internet Messages: The Content-Disposition Header'',
599 August 1997, Standards Track.
600 @end quotation
601
602 FLIM \e$B$O\e(B Content-Disposition \e$BMs$r9=J82r@O$9$k4X?t$H\e(B Content-Disposition 
603 \e$BMs$N2r@O7k2L$r3JG<$9$k9=B$BN\e(B 
604 @strong{mime-content-disposition} \e$B$rDs6!$7$^$9!#\e(B
605
606
607 @menu
608 * mime-content-disposition::    mime-content-disposition structure
609 * Content-Disposition parser::  Parser for Content-Disposition field
610 @end menu
611
612 @node mime-content-disposition, Content-Disposition parser, Content-Disposition, Content-Disposition
613 @section mime-content-disposition structure
614
615 @deffn{Structure} mime-content-disposition
616
617 Content-Disposition \e$BMs$N2r@O7k2L$r<}$a$k$?$a$N9=B$BN!#\e(B@refill
618
619 \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
620 \e$BA0$N;2>H4X?t$rMQ$$$k!#\e(B@refill
621
622 \e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'\e(B
623
624 @table @var
625 @item disposition-type
626 disposition-type (symbol).
627
628 @item parameters
629 Content-Disposition \e$BMs$N\e(B parameter (\e$BO"A[\e(B list).
630
631 @end table
632 @end deffn
633
634
635 @defun mime-content-disposition-parameter content-disposition parameter
636
637 @var{content-disposition} \e$B$N\e(B @var{parameter} \e$B$NCM$rJV$9!#\e(B
638 @end defun
639
640
641 @defun mime-content-disposition-filename content-disposition
642
643 @var{content-disposition} \e$B$N\e(B filename \e$B$NCM$rJV$9!#\e(B
644 @end defun
645
646
647
648 @node Content-Disposition parser,  , mime-content-disposition, Content-Disposition
649 @section Parser for Content-Disposition field
650
651 @defun mime-parse-Content-Disposition string
652
653 @var{string} \e$B$r\e(B content-disposition \e$B$H$7$F2r@O$7$?7k2L$rJV$9!#\e(B
654 @end defun
655
656
657 @defun mime-read-Content-Disposition
658
659 \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
660 @refill
661
662 Content-Disposition \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
663 @end defun
664
665
666
667 @node Content-Transfer-Encoding, encoded-word, Content-Disposition, Top
668 @chapter Encoding Method
669 @cindex Content-Transfer-Encoding \e$BMs\e(B
670
671 @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
672 \e$B$N$b$N$G$9!#\e(B@refill
673
674 FLIM \e$B$G$O\e(B Content-Transfer-Encoding \e$BMs$r9=J82r@O$9$k4X?t$rDs6!$7$^$9!#$3\e(B
675 \e$B$l$i$N4X?t$O\e(B Content-Transfer-Encoding \e$BMs$N>pJs$OJ8;zNs$GI=8=$7$^$9!#\e(B
676 @refill
677
678 \e$B$^$?!"\e(BContent-Transfer-Encoding \e$B$K4p$E$$$FId9f2=!&I|9f2=$r9T$&4X?t$bDs\e(B
679 \e$B6!$5$l$^$9!#\e(B
680
681
682 @menu
683 * Content-Transfer-Encoding parser::  Parser for Content-Transfer-Encoding field
684 * Region encoder/decoder::      Region encoding/decoding
685 * String encoder/decoder::      String encoding/decoding
686 * File encoder/decoder::        File encoding/decoding
687 @end menu
688
689 @node Content-Transfer-Encoding parser, Region encoder/decoder, Content-Transfer-Encoding, Content-Transfer-Encoding
690 @section Parser for Content-Transfer-Encoding field
691
692 @defun mime-parse-Content-Transfer-Encoding string
693
694 @var{string} \e$B$r\e(B content-transfer-encoding \e$B$H$7$F2r@O$7$?7k2L$rJV$9!#\e(B
695 @end defun
696
697
698 @defun mime-read-Content-Transfer-Encoding &optional default-encoding
699
700 \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
701 \e$BJV$9!#\e(B@refill
702
703 Content-Transfer-Encoding \e$BMs$,B8:_$7$J$$>l9g$O\e(B@var{default-encoding} \e$B$r\e(B
704 \e$BJV$9!#\e(B
705 @end defun
706
707
708
709 @node Region encoder/decoder, String encoder/decoder, Content-Transfer-Encoding parser, Content-Transfer-Encoding
710 @section Region encoding/decoding
711
712 @defun mime-encode-region start end encoding
713
714 Encode region @var{start} to @var{end} of current buffer using
715 @var{encoding}.
716 @end defun
717
718
719 @defun mime-decode-region start end encoding
720
721 Decode region @var{start} to @var{end} of current buffer using
722 @var{encoding}.
723 @end defun
724
725
726 @defvar mime-encoding-method-alist
727
728 Alist of encoding vs. corresponding method to encode region.@refill
729
730 Each element looks like @code{(STRING . FUNCTION)} or @code{(STRING
731 . nil)}.  @var{string} is content-transfer-encoding.  @code{function} is
732 region encoder and @code{nil} means not to encode.
733 @end defvar
734
735
736 @defvar mime-decoding-method-alist
737
738 Alist of encoding vs. corresponding method to decode region.@refill
739
740 Each element looks like @code{(STRING . FUNCTION)} or @code{(STRING
741 . nil)}.  @var{string} is content-transfer-encoding.  @code{function} is
742 region decoder and @code{nil} means not to decode.
743 @end defvar
744
745
746
747 @node String encoder/decoder, File encoder/decoder, Region encoder/decoder, Content-Transfer-Encoding
748 @section String encoding/decoding
749
750 @defun mime-decode-string string encoding
751
752 @var{string} \e$B$r\e(B @var{encoding} \e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#\e(B
753 @end defun
754
755
756 @defvar mime-string-decoding-method-alist
757
758 Alist of encoding vs. corresponding method to decode string.@refill
759
760 Each element looks like @code{(STRING . FUNCTION)}.  STRING is
761 content-transfer-encoding.  FUNCTION is string decoder.
762 @end defvar
763
764
765
766 @node File encoder/decoder,  , String encoder/decoder, Content-Transfer-Encoding
767 @section File encoding/decoding
768
769 @defun mime-insert-encoded-file filename encoding
770
771 Insert file @var{FILENAME} encoded by @var{ENCODING} format.
772 @end defun
773
774
775 @defun mime-write-decoded-region start end filename encoding
776
777 Decode and write current region encoded by @var{encoding} into
778 @var{filename}.@refill
779
780 @var{start} and @var{end} are buffer positions.
781 @end defun
782
783
784 @defvar mime-file-encoding-method-alist
785
786 Alist of encoding vs. corresponding method to insert encoded
787 file.@refill
788
789 Each element looks like @code{(STRING . FUNCTION)}.  STRING is
790 content-transfer-encoding.  FUNCTION is function to insert encoded file.
791 @end defvar
792
793
794 @defvar mime-file-decoding-method-alist
795
796 Alist of encoding vs. corresponding method to write decoded region to
797 file.@refill
798
799 Each element looks like @code{(STRING . FUNCTION)}.  STRING is
800 content-transfer-encoding.  FUNCTION is function to write decoded region
801 to file.
802 @end defvar
803
804
805
806 @node encoded-word, custom, Content-Transfer-Encoding, Top
807 @chapter Network representation of header
808 @cindex RFC 2047
809 @cindex Standards Track
810 @cindex RFC 2047
811
812 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
813 \e$B$G!"\e(B@strong{RFC 2047} \e$B$GDj5A$5$l$F$$$^$9!#\e(B@refill
814
815
816 @noindent
817 [RFC 2047]
818 @quotation
819 K. Moore, ``MIME (Multipurpose Internet Mail Extensions) Part Three:
820 Message Header Extensions for Non-ASCII Text'', November 1996, Standards
821 Track (obsolete RFC 1521,1522,1590).
822 @end quotation
823
824 \e$B$^$?!"9T57$N0-$$$3$H$@$H8@$($^$9$,!"\e(Bencoded-word \e$B$rMQ$$$:$KHs\e(B ASCII
825 (@ref{ASCII}) \e$BJ8;z$r\e(B header \e$B$KF~$l$?5-;v$bB8:_$7$^$9!#\e(B@refill
826
827 FLIM \e$B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#\e(B
828
829
830 @menu
831 * Header encoder/decoder::      Header encoding/decoding
832 @end menu
833
834 @node Header encoder/decoder,  , encoded-word, encoded-word
835 @section Header encoding/decoding
836
837 @defun eword-encode-header &optional  code-conversion separator
838
839 Decode MIME encoded-words in header fields.@refill
840
841 If @var{code-conversion} is @code{nil}, it decodes only encoded-words.
842 If it is mime-charset, it decodes non-ASCII bit patterns as the
843 mime-charset.  Otherwise it decodes non-ASCII bit patterns as the
844 default-mime-charset.@refill
845
846 If @var{separator} is not nil, it is used as header separator.
847 @end defun
848
849
850 @defun eword-encode-header &optional  code-conversion
851
852 Encode header fields to network representation, such as MIME
853 encoded-word.@refill
854
855 It refer variable @code{eword-field-encoding-method-alist}.
856 @end defun
857
858
859
860 @node custom, Appendix, encoded-word, Top
861 @chapter Various Customization
862
863 @deffn{group} mime
864
865 MIME \e$B4XO"5!G=$K4X$9$k\e(B group.@refill
866
867 @code{mail} \e$B$H\e(B @code{news} \e$B$KB0$9$k!#\e(B
868 @end deffn
869
870
871 @defvar default-mime-charset
872
873 \e$BE,@Z$J\e(B MIME charset (@ref{MIME charset}) \e$B$,8+$D$+$i$J$+$C$?>l9g$KMQ$$$i\e(B
874 \e$B$l$k\e(BMIME charset.@refill
875
876 \e$BK\Mh$O\e(B APEL \e$B$NJQ?t$G$"$k!#\e(B
877 @end defvar
878
879
880 @defvar mime-temp-directory
881
882 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 
883 directory.@refill
884
885 \e$B4D6-JQ?t\e(B @code{MIME_TMP_DIR}, @code{TM_TMP_DIR}, @code{TMPDIR},
886 @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
887 \e$BMQ$$$k!#2?$b@_Dj$5$l$F$$$J$$>l9g!"\e(B@code{"/tmp/"} \e$B$rMQ$$$k!#\e(B
888 @end defvar
889
890
891
892 @node Appendix, Concept Index, custom, Top
893 @chapter Appendix
894
895
896 @menu
897 * Glossary::                    
898 * Bug report::                  How to report bugs
899 * CVS::                         CVS based development
900 * History::                     History of FLIM
901 @end menu
902
903 @node Glossary, Bug report, Appendix, Appendix
904 @section Glossary
905
906
907 @menu
908 * 7bit::                        
909 * 8bit::                        
910 * ASCII::                       
911 * Base64::                      
912 * binary::                      
913 * coded character set::         Coded character set, Character code
914 * media-type::                  
915 * message::                     
916 * MIME::                        
917 * MIME charset::                
918 * MTA::                         
919 * MUA::                         
920 * Quoted-Printable::            
921 * RFC 822::                     
922 * RFC 1036::                    
923 * RFC 2045::                    
924 * RFC 2046::                    
925 * RFC 2048::                    
926 * RFC 2049::                    
927 * plain text::                  
928 * us-ascii::                    
929 @end menu
930
931 @node 7bit, 8bit, Glossary, Glossary
932 @subsection 7bit
933 @cindex 7bit (textual) string
934 @cindex 7bit data
935 @cindex 7bit
936
937 @strong{7bit} means any integer between 0 .. 127.@refill
938
939 Any data represented by 7bit integers is called @strong{7bit data}.@refill
940
941 Textual string consisted of Control characters between 0 .. 31 and 127,
942 and space represented by 32, and graphic characters between 33 .. 236
943 are called @strong{7bit (textual) string}.@refill
944
945 Conventional Internet MTA (@ref{MTA}) can translate 7bit data, so it is
946 no need to translate by Quoted-Printable (@ref{Quoted-Printable}) or
947 Base64 (@ref{Base64}) for 7bit data.@refill
948
949 However if there are too long lines, it can not translate by 7bit MTA
950 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
951 ``7bit data'' has a line more than 999 bytes, it is regarded as binary
952 (@ref{binary}).  For example, Postscript file should be encoded by
953 Quoted-Printable.
954
955
956 @node 8bit, ASCII, 7bit, Glossary
957 @subsection 8bit
958 @cindex 8bit (textual) string
959 @cindex 8bit data
960 @cindex 8bit
961
962 @strong{8bit} means any integer between 0 .. 255.@refill
963
964 Any data represented by 8bit integers is called @strong{8bit data}.@refill
965
966 Textual string consisted of Control characters between 0 .. 31, 127, and
967 128 .. 159, and space represented by 32, and graphic characters between
968 33 .. 236 and 160 .. 255 are called @strong{8bit (textual) string}.@refill
969
970 For example, iso-8859-1 (@ref{iso-8859-1}) or euc-kr (@ref{euc-kr}) are
971 coded-character-set represented by 8bit textual string.@refill
972
973 Traditional Internet MTA (@ref{MTA}) can translate only 7bit
974 (@ref{7bit}) data, so if a 8bit data will be translated such MTA, it
975 must be encoded by Quoted-Printable (@ref{Quoted-Printable}) or Base64
976 (@ref{Base64}).@refill
977
978 However 8bit MTA are increasing today.@refill
979
980 However if there are too long lines, it can not translate by 8bit MTA
981 even if it is 8bit data.  RFC 2045 (@ref{RFC 2045}) require lines in
982 8bit data must be less than 998 bytes.  So if a ``8bit data'' has a line
983 more than 999 bytes, it is regarded as binary (@ref{binary}), so it must
984 be encoded by Base64 or Quoted-Printable.
985
986
987 @node ASCII, Base64, 8bit, Glossary
988 @subsection ASCII
989 @cindex ANSI X3.4:1986
990 @cindex ASCII
991 @cindex ASCII
992
993 @strong{ASCII} is a 94-character set contains primary latin characters
994 (A-Z, a-z), numbers and some characters.  It is a standard of the United
995 States of America.  It is a variant of ISO 646 (@ref{ISO 646}).
996
997
998 @noindent
999 [ASCII]
1000 @quotation
1001 ``Coded Character Set -- 7-Bit American Standard Code for Information
1002 Interchange'', ANSI X3.4:1986.
1003 @end quotation
1004
1005
1006
1007 @node Base64, binary, ASCII, Glossary
1008 @subsection Base64
1009 @cindex pad
1010 @cindex Base64
1011
1012 @strong{Base64} is a transfer encoding method of MIME (@ref{MIME})
1013 defined in RFC 2045 (@ref{RFC 2045}).@refill
1014
1015 The encoding process represents 24-bit groups of input bits as output
1016 strings of 4 encoded characters.  Encoded characters represent integer 0
1017 .. 63 or @strong{pad}.  Base64 data must be 4 * n bytes, so pad is used
1018 to adjust size.@refill
1019
1020 These 65 characters are subset of all versions of ISO 646, including
1021 US-ASCII, and all versions of EBCDIC.  So it is safe even if it is
1022 translated by non-Internet gateways.
1023
1024
1025 @node binary, coded character set, Base64, Glossary
1026 @subsection binary
1027 @cindex binary
1028
1029 Any byte stream is called @strong{binary}.@refill
1030
1031 It does not require structureof lines.  It differs from from 8bit
1032 (@ref{8bit}).@refill
1033
1034 In addition, if line structured data contain too long line (more than
1035 998 bytes), it is regarded as binary.
1036
1037
1038 @node coded character set, media-type, binary, Glossary
1039 @subsection Coded character set, Character code
1040
1041 A set of unambiguous rules that establishes a character set and the
1042 one-to-one relationship between the characters of the set and their
1043 bit combinations.
1044
1045
1046 @node media-type, message, coded character set, Glossary
1047 @subsection media-type
1048 @cindex x-token
1049 @cindex message
1050 @cindex multipart
1051 @cindex application
1052 @cindex video
1053 @cindex audio
1054 @cindex image
1055 @cindex text
1056 @cindex subtype
1057 @cindex type
1058 @cindex media-type
1059
1060 @strong{media-type} specifies the nature of the data in the body of MIME
1061 (@ref{MIME}) entity (@ref{entity}).  It consists of @strong{type} and
1062 @strong{subtype}.  It is defined in RFC 2046 (@ref{RFC 2046}).@refill
1063
1064 Currently there are following standard primary-types:
1065
1066 @itemize @bullet
1067 @item
1068 @strong{text}
1069 @item
1070 @strong{image}
1071 @item
1072 @strong{audio}
1073 @item
1074 @strong{video}
1075 @item
1076 @strong{application}
1077 @item
1078 @strong{multipart} (@ref{multipart})
1079 @item
1080 @strong{message}
1081 @end itemize
1082
1083
1084 And there are various subtypes, for example, application/octet-stream,
1085 audio/basic, image/jpeg, multipart/mixed (@ref{multipart/mixed}),
1086 text/plain (@ref{text/plain}), video/mpeg...  @refill
1087
1088 You can refer registered media types at MEDIA TYPES
1089 (ftp://ftp.isi.edu/in-notes/iana/assignments/media-types).@refill
1090
1091 In addition, you can use private type or subtype using @strong{x-token},
1092 which as the prefix `x-'.  However you can not use them in
1093 public.@refill
1094
1095 (cf. @ref{Content-Type field})
1096
1097
1098
1099 @node message, MIME, media-type, Glossary
1100 @subsection message
1101
1102 In this document, it means mail defined in RFC 822 (@ref{RFC 822}) and
1103 news message defined in RFC 1036 (@ref{RFC 1036}).
1104
1105
1106 @node MIME, MIME charset, message, Glossary
1107 @subsection MIME
1108 @cindex Multipurpose Internet Mail Extensions
1109
1110 MIME stands for @strong{Multipurpose Internet Mail Extensions}, it is an
1111 extension for RFC 822 (@ref{RFC 822}).@refill
1112
1113 According to RFC 2045:@refill
1114
1115 STD 11, RFC 822, defines a message representation protocol specifying
1116 considerable detail about US-ASCII message headers, and leaves the
1117 message content, or message body, as flat US-ASCII text.  This set of
1118 documents, collectively called the Multipurpose Internet Mail
1119 Extensions, or MIME, redefines the format of messages to allow for
1120
1121 @enumerate
1122 @item
1123 textual message bodies in character sets other than US-ASCII,
1124 @item
1125 an extensible set of different formats for non-textual message
1126 bodies,
1127 @item
1128 multi-part message bodies, and
1129 @item
1130 textual header information in character sets other than US-ASCII.
1131 @end enumerate
1132
1133
1134 It is defined in RFC 2045 (@ref{RFC 2045}), RFC 2046 (@ref{RFC 2046}),
1135 RFC 2047 (@ref{encoded-word}), RFC 2048 (@ref{RFC 2048}) and RFC 2049
1136 (@ref{RFC 2049}).
1137
1138
1139 @node MIME charset, MTA, MIME, Glossary
1140 @subsection MIME charset
1141
1142 Coded character set (@ref{coded character set}) used in Content-Type
1143 field (@ref{Content-Type field}) or charset parameter of encoded-word
1144 (@ref{encoded-word}).@refill
1145
1146 It is defined in RFC 2045 (@ref{RFC 2045}).@refill
1147
1148 iso-2022-jp (@ref{iso-2022-jp}) or euc-kr (@ref{euc-kr}) are kinds of
1149 it.  (In this document, MIME charsets are written by small letters to
1150 distinguish graphic character set (@ref{graphic character set}).  For
1151 example, ISO 8859-1 is a graphic character set, and iso-8859-1 is a MIME
1152 charset)
1153
1154
1155 @node MTA, MUA, MIME charset, Glossary
1156 @subsection MTA
1157 @cindex Message Transfer Agent
1158
1159 @strong{Message Transfer Agent}.  It means mail transfer programs
1160 (ex. sendmail) and news servers.@refill
1161
1162 (cf. @ref{MUA})
1163
1164
1165
1166 @node MUA, Quoted-Printable, MTA, Glossary
1167 @subsection MUA
1168 @cindex Message User Agent
1169
1170 @strong{Message User Agent}.  It means mail readers and news
1171 readers.@refill
1172
1173 (cf. @ref{MTA})
1174
1175
1176
1177 @node Quoted-Printable, RFC 822, MUA, Glossary
1178 @subsection Quoted-Printable
1179 @cindex Quoted-Printable
1180
1181 @strong{Quoted-Printable} is a transfer encoding method of MIME
1182 (@ref{MIME}) defined in RFC 2045 (@ref{RFC 2045}).@refill
1183
1184 If the data being encoded are mostly US-ASCII text, the encoded form of
1185 the data remains largely recognizable by humans.@refill
1186
1187 (cf. @ref{Base64})
1188
1189
1190
1191 @node RFC 822, RFC 1036, Quoted-Printable, Glossary
1192 @subsection RFC 822
1193 @cindex RFC 822
1194 @cindex STD 11
1195 @cindex Internet mail
1196 @cindex Internet message
1197 @cindex message header
1198
1199 A RFC defines format of Internet mail message, mainly @strong{message header}.
1200
1201 @noindent
1202 @strong{[Memo]}
1203 @quotation
1204
1205 news message is based on RFC 822, so @strong{Internet message} may be
1206 more suitable than @strong{Internet mail} .
1207 @end quotation
1208
1209
1210
1211 @noindent
1212 [RFC 822]
1213 @quotation
1214 D. Crocker, ``Standard for the Format of ARPA Internet Text Messages'',
1215 August 1982, STD 11.
1216 @end quotation
1217
1218
1219
1220 @node RFC 1036, RFC 2045, RFC 822, Glossary
1221 @subsection RFC 1036
1222 @cindex RFC 1036
1223 @cindex USENET
1224
1225 A RFC defines format of USENET message.  It is a subset of RFC 822
1226 (@ref{RFC 822}).  It is not Internet standard, but a lot of netnews
1227 excepting Usenet uses it.
1228
1229
1230 @noindent
1231 [USENET: RFC 1036]
1232 @quotation
1233 M. Horton and R. Adams, ``Standard for Interchange of USENET Messages'',
1234 December 1987, (obsolete RFC 850).
1235 @end quotation
1236
1237
1238
1239 @node RFC 2045, RFC 2046, RFC 1036, Glossary
1240 @subsection RFC 2045
1241 @cindex RFC 2045
1242 @cindex Standards Track
1243
1244
1245 @noindent
1246 [RFC 2045]
1247 @quotation
1248 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1249 (MIME) Part One: Format of Internet Message Bodies'', November 1996,
1250 Standards Track (obsolete RFC 1521, 1522, 1590).
1251 @end quotation
1252
1253
1254
1255 @node RFC 2046, RFC 2048, RFC 2045, Glossary
1256 @subsection RFC 2046
1257 @cindex RFC 2046
1258 @cindex Standards Track
1259
1260
1261 @noindent
1262 [RFC 2046]
1263 @quotation
1264 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1265 (MIME) Part Two: Media Types'', November 1996, Standards Track (obsolete
1266 RFC 1521, 1522, 1590).
1267 @end quotation
1268
1269
1270
1271 @node RFC 2048, RFC 2049, RFC 2046, Glossary
1272 @subsection RFC 2048
1273 @cindex RFC 2048
1274 @cindex Standards Track
1275
1276
1277 @noindent
1278 [RFC 2048]
1279 @quotation
1280 N. Freed, J. Klensin and J. Postel, ``Multipurpose Internet Mail
1281 Extensions (MIME) Part Four: Registration Procedures'', November 1996,
1282 Standards Track (obsolete RFC 1521, 1522, 1590).
1283 @end quotation
1284
1285
1286
1287 @node RFC 2049, plain text, RFC 2048, Glossary
1288 @subsection RFC 2049
1289 @cindex RFC 2049
1290 @cindex Standards Track
1291
1292
1293 @noindent
1294 [RFC 2049]
1295 @quotation
1296 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1297 (MIME) Part Five: Conformance Criteria and Examples'', November 1996,
1298 Standards Track (obsolete RFC 1521, 1522, 1590).
1299 @end quotation
1300
1301
1302
1303 @node plain text, us-ascii, RFC 2049, Glossary
1304 @subsection plain text
1305
1306 A textual data represented by only coded character set (@ref{coded character set}).  It does not have information about font or
1307 typesetting.  (cf. @ref{text/plain})
1308
1309
1310
1311 @node us-ascii,  , plain text, Glossary
1312 @subsection us-ascii
1313 @cindex ASCII
1314 @cindex us-ascii
1315
1316 A MIME charset (@ref{MIME charset}) for primary Latin script mainly
1317 written by English or other languages.@refill
1318
1319 It is a 7bit coded character set (@ref{coded character set}) based on
1320 ISO 2022 (@ref{ISO 2022}), it contains only ASCII (@ref{ASCII}) and code
1321 extension (@ref{code extension}) is not allowed.@refill
1322
1323 It is standard coded character set of Internet mail.  If MIME charset is
1324 not specified, @strong{us-ascii} is used as default.@refill
1325
1326 In addition, @strong{ASCII} of RFC 822 (@ref{RFC 822}) should be
1327 interpreted as us-ascii.
1328
1329
1330 @node Bug report, CVS, Glossary, Appendix
1331 @section How to report bugs
1332 @cindex good bug report
1333
1334 If you write bug-reports and/or suggestions for improvement, please
1335 send them to the tm Mailing List:
1336
1337 @itemize @bullet
1338 @item
1339  Japanese <bug-tm-ja@@chamonix.jaist.ac.jp>
1340 @item
1341  English <bug-tm-en@@chamonix.jaist.ac.jp>
1342 @end itemize
1343
1344
1345 Notice that, we do not welcome bug reports about too old version.  Bugs
1346 in old version might be fixed.  So please try latest version at
1347 first.@refill
1348
1349 You should write @strong{good bug report}.  If you write only ``FLIM
1350 does not work'', we can not find such situations.  At least, you should
1351 write name, type, variants and version of OS, emacs, APEL, FLIM, SEMI
1352 and MUA, and setting.  In addition, if error occurs, to send backtrace
1353 is very important. (cf. @ref{(emacs)Bugs}) @refill
1354
1355 Bug may not appear only your environment, but also in a lot of
1356 environment (otherwise it might not bug).  Therefor if you send mail
1357 to author directly, we must write a lot of mails.  So please send mail
1358 to address for tm bugs instead of author.
1359
1360 Via the tm ML, you can report FLIM bugs, obtain the latest release of
1361 FLIM, and discuss future enhancements to FLIM.  To join the tm ML,
1362 send empty e-mail to:
1363
1364 @itemize @bullet
1365 @item
1366  Japanese <tm-ja-help@@chamonix.jaist.ac.jp>
1367 @item
1368  English  <tm-en-help@@chamonix.jaist.ac.jp>
1369 @end itemize
1370
1371
1372
1373 @node CVS, History, Bug report, Appendix
1374 @section CVS based development
1375
1376 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
1377 \e$B?7$N\e(B FLIM \e$B$rF~<j$9$k$3$H$,$G$-$^$9!'\e(B
1378
1379 @example
1380 (0) cvs login
1381
1382     % cvs -d :pserver:anonymous@@chamonix.jaist.ac.jp:/hare/cvs/root \
1383         login
1384
1385     CVS password: [CR] # NULL string
1386
1387 (1) checkout
1388
1389     % cvs -d :pserver:anonymous@@chamonix.jaist.ac.jp:/hare/cvs/root \
1390         checkout [-r TAG] flim
1391 @end example
1392
1393
1394 CVS \e$B$rMQ$$$?3+H/$K;22C$7$?$$J}$O\e(B
1395
1396 @itemize @bullet
1397 @item
1398  <cvs@@chamonix.jaist.ac.jp>
1399 @end itemize
1400
1401 @noindent
1402 \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
1403 \e$B$r1h$($F8fO"Mm$/$@$5$$!#\e(B
1404
1405
1406 @node History,  , CVS, Appendix
1407 @section History of FLIM
1408
1409 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
1410 \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 
1411 \e$B@lMQ$N\e(B encoded-word \e$B$NI|9f2=%W%m%0%i%`$G$7$?!#\e(B@refill
1412
1413 \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
1414 \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
1415 \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 
1416 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
1417 charset (@ref{MIME charset}) \e$B$rF1;~$K;H$&$3$H$,$G$-$^$7$?!#$3$N;~!"\e(B
1418 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
1419 package \e$B$K$^$H$a$i$l$^$9!#\e(B@refill
1420
1421 \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
1422 \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 
1423 package \e$B$K$^$H$a$i$l!"\e(Btm \e$B$H$$$&L>A0$GG[I[$5$l$^$9!#\e(B@refill
1424
1425 \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
1426 @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
1427 \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
1428 \e$B3K$H$J$j$^$9!#\e(B@refill
1429
1430 @file{tm-view.el} \e$B$OEvA3!"\e(BContent-Transfer-Encoding \e$B$r07$&I,MW$,$"$j$^$9!#\e(B
1431 \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 
1432 @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 
1433 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
1434 \e$B$^$7$?!#\e(B@refill
1435
1436 \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
1437 \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
1438 \e$B$7$?!#\e(B@refill
1439
1440 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
1441 \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 
1442 @file{std11.el} \e$B$KEv$?$j$^$9!#$^$?!"$3$N2aDx$G\e(B @file{tiny-mime.el} \e$B$OI|\e(B
1443 \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
1444 \e$B$^$7$?!#$3$NN><T$,8=:_$N\e(B @file{eword-decode.el} \e$B$H\e(B 
1445 @file{eword-encode.el} \e$B$N@hAD$KEv$?$j$^$9!#\e(B@refill
1446
1447 \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 
1448 \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
1449 \e$B$N$&$A$N\e(B MEL \e$B$,\e(B FLIM \e$B$ND>@\$N@hAD$KEv$?$j$^$9!#\e(B@refill
1450
1451 \e$B8e$K!"\e(BAPEL \e$B$+$i\e(B @file{std11.el} \e$B$,0\$5$l!"$^$?!"\e(B@file{mailcap.el},
1452 @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
1453 package \e$B$NL>A0$,\e(B FLIM\e$B$H$J$j$^$9!#\e(B@refill
1454
1455 \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
1456 FLIM \e$B$N;^$G$"$k\e(B ``FLIM-FLAM'' \e$B$H$J$C$F$$$^$9!#\e(B
1457
1458
1459 @node Concept Index, Function Index, Appendix, Top
1460 @chapter Concept Index
1461
1462 @printindex cp
1463
1464 @node Function Index, Variable Index, Concept Index, Top
1465 @chapter Function Index
1466
1467 @printindex fn
1468
1469 @node Variable Index,  , Function Index, Top
1470 @chapter Variable Index
1471
1472 @printindex vr
1473 @bye