2 @setfilename mime-en.info
3 @settitle{FLIM 1.9 Manual about MIME Features}
5 @title FLIM 1.9 Manual about MIME Features
6 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp>
9 @node Top, Introduction, (dir), (dir)
10 @top FLIM 1.9 Manual about MIME Features
14 This file documents MIME features of FLIM, a Internet message
15 parsing/encoding library for GNU Emacs.
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
33 @node Introduction, How to use, Top, Top
34 @chapter What is FLIM?
36 FLIM is a library to provide basic features about message
37 representation or encoding.
40 @node How to use, Entity, Introduction, Top
41 @chapter How to use MIME features
43 Please eval following to use MIME features provided by FLIM:
51 @node Entity, Content-Type, How to use, Top
52 @chapter Message and Entity
56 According to RFC 2045 (@ref{RFC 2045}), `The term ``entity'', refers
57 specifically to the MIME-defined header fields and contents of either a
58 message or one of the parts in the body of a multipart entity.' In this
59 document, the term @strong{entity} indicates all of header fields and
62 The definition of RFC 2045 indicates that a MIME message is a tree, and
63 each node of the tree is an entity. Namely MIME extends message to tree
66 FLIM uses @strong{mime-entity} structure to represent
67 information of entity. In this document, it is called simply
72 * Entity creation:: Functions to create mime-entity
73 * Entity hierarchy:: Features about message tree
74 * Entity Attributes:: Functions about attributes of mime-entity
75 * Entity-header:: Information of entity header
76 * Entity-content:: Contents of Entity
77 * Entity buffer:: Entity as buffer representation
78 * mm-backend:: Entity representations and implementations
81 @node Entity creation, Entity hierarchy, Entity, Entity
82 @section Functions to create mime-entity
84 @defun mime-open-entity &optional type location
86 Open an entity and return it.@refill
88 @var{type} is representation-type. (cf. @ref{mm-backend}) @refill
90 @var{location} is location of entity. Specification of it is depended
91 on representation-type.
95 @defun mime-parse-buffer &optional buffer type
97 Parse @var{buffer} as message, and set the result to buffer local
98 variable @code{mime-message-structure} of @var{buffer} as
101 If @var{buffer} is omitted, current buffer is used.@refill
103 @var{type} is representation-type of created
104 mime-entity. (cf. @ref{mm-backend}) Default value is @var{buffer}.
109 @node Entity hierarchy, Entity Attributes, Entity creation, Entity
110 @section Features about message tree
112 @cindex entity-number
116 Structure of a MIME message is tree.@refill
118 In the tree, root node is the entity indicates all of the message. In
119 this document, it is called @strong{root-entity} or @strong{message}.
120 In FLIM, it is indicated by buffer local variable
121 @code{mime-message-structure}.@refill
123 Each entity except root-entity has a parent. An entity may have
124 children. We can indicate an entity by relative position from a base
125 entity, based on the parent-child relationship.@refill
127 In addition, we can indicate an entity by absolute position of the
130 Each entity, which is a node of the tree, can be numbered by
131 depth and left-to-right order of the depth.
137 +-------------------+-------------------+
141 | +---------+---------+ |
142 +--+--+ +--+--+ +--+--+ +--+--+ +--+--+
143 | 0.0 | | 1.0 | | 1.1 | | 1.2 | | 2.0 |
144 +-----+ +-----+ +-----+ +-----+ +-----+
147 Namely, if depth of a node is n, the node has a node-number, which is
148 consists of n integers. In this document, it is called
149 @strong{entity-number}. An entity-number is represented by list of
150 integer, like @code{(1 2 3)}.@refill
152 mime-entity has also @strong{node-id}. A node-id is represented by
153 reversed list of entity-number. For example, node-id corresponding with
154 1.2.3 is @code{(3 2 1)}.@refill
156 Each entity can be indicated by entity-number or node-id in
157 @code{mime-message-structure}.
159 @defvar mime-message-structure
161 Buffer local variable to store mime-entity structure of message.
165 @defun mime-entity-children entity
167 Return list of entities included in the @var{entity}.
171 @defun mime-entity-parent entity &optional message
173 Return parent entity of the @var{entity}.@refill
175 If @var{message} is specified, it is regarded as root instead of
176 @code{mime-message-structure}.
180 @defun mime-root-entity-p entity
182 Return non-@code{nil} if @var{entity} is root entity (message).
186 @defun mime-entity-node-id entity
188 Return node-id of @var{entity}.
192 @defun mime-entity-number entity
194 Return entity-number of @var{entity}.
198 @defun mime-find-entity-from-number entity-number &optional message
200 Return entity from @var{entity-number} in @var{message}.@refill
202 If @var{message} is not specified, @code{mime-message-structure} is
207 @defun mime-find-entity-from-node-id entity-node-id &optional message
209 Return entity from @var{entity-node-id} in @var{message}.@refill
211 If @var{message} is not specified, @code{mime-message-structure} is
217 @node Entity Attributes, Entity-header, Entity hierarchy, Entity
218 @section Functions about attributes of mime-entity
220 @defun mime-entity-content-type entity
222 Return content-type of @var{entity}. (cf. @ref{mime-content-type})
226 @defun mime-entity-content-disposition entity
228 Return content-disposition of
229 @var{entity}. (cf. @ref{mime-content-disposition})
233 @defun mime-entity-filename entity
235 Return file name of @var{entity}.
239 @defun mime-entity-encoding entity &optional default-encoding
241 Return content-transfer-encoding of @var{entity}.
242 (cf. @ref{Content-Transfer-Encoding}) @refill
244 If the @var{entity} does not have Content-Transfer-Encoding field, this
245 function returns @var{default-encoding}. If it is nil, @code{"7bit"} is
246 used as default value.
250 @defun mime-entity-cooked-p entity
252 Return non-nil if contents of @var{entity} has been already
258 @node Entity-header, Entity-content, Entity Attributes, Entity
259 @section Information of entity header
261 @defun mime-fetch-field field-name &optional entity
263 Return field-body of @var{field-name} field in header of
266 The results is network representation.@refill
268 If @var{entity} is omitted, @code{mime-message-structure} is used as
269 default value.@refill
271 If @var{field-name} field is not found, this function returns
276 @defun mime-read-field field-name &optional entity
278 Parse @var{field-name} field in header of @var{entity}, and return the
281 Format of result is depended on kind of field. For non-structured
282 field, this function returns string. For structured field, it returns
283 list corresponding with structure of the field.@refill
285 Strings in the result will be converted to internal representation of
288 If @var{entity} is omitted, @code{mime-message-structure} is used as
289 default value.@refill
291 If @var{field-name} field is not found, this function returns
296 @defun mime-insert-decoded-header entity &optional invisible-fields visible-fields
298 Insert before point a decoded contents of header of @var{entity}.@refill
300 @var{invisible-fields} is list of regexps to match field-name to hide.
301 @var{visible-fields} is list of regexps to match field-name to
304 If a field-name is matched with some elements of @var{invisible-fields}
305 and matched with none of @var{visible-fields}, this function don't
311 @node Entity-content, Entity buffer, Entity-header, Entity
312 @section Contents of Entity
314 @defun mime-entity-content entity
316 Return content of @var{entity} as byte sequence.
320 @defun mime-write-entity-content entity filename
322 Write content of @var{entity} into @var{filename}.
326 @defun mime-write-entity entity filename
328 Write representation of @var{entity} into @var{filename}.
332 @defun mime-write-entity-body entity filename
334 Write body of @var{entity} into @var{filename}.
339 @node Entity buffer, mm-backend, Entity-content, Entity
340 @section Entity as buffer representation
342 @defun mime-entity-buffer entity
344 Return buffer, which contains @var{entity}.
348 @defun mime-entity-point-min entity
350 Return the start point of @var{entity} in the buffer which contains
355 @defun mime-entity-point-max entity
357 Return the end point of @var{entity} in the buffer which contains
362 @defun mime-entity-header-start entity
364 Return the start point of header of @var{entity} in the buffer which
365 contains @var{entity}.
369 @defun mime-entity-header-end entity
371 Return the end point of header of @var{entity} in the buffer which
372 contains @var{entity}.
376 @defun mime-entity-body-start entity
378 Return the start point of body of @var{entity} in the buffer which
379 contains @var{entity}.
383 @defun mime-entity-body-end entity
385 Return the end point of body of @var{entity} in the buffer which
386 contains @var{entity}.
391 @node mm-backend, , Entity buffer, Entity
392 @section Entity representations and implementations
394 @cindex entity processing method
395 @cindex representation-type
397 Entity is an abstraction. It is designed to use various data
398 representations for their purposes.@refill
400 Each entity has @strong{representation-type}. It must be specified when
401 an entity is created. (cf. @ref{Entity Creation}) @refill
403 Functions about entity are implemented by request processing to the
404 entity. Each entity knows its representation-type. Each entity calls
405 processing function corresponding with the representation-type. Such
406 kind of function is called @strong{entity processing method}. A module,
407 consists of them corresponding with a representation-type, is called
408 @strong{mm-backend}.@refill
410 Module name of each mm-backend consists of the prefix @code{mm}
411 and its representation-type. The module is required automatically
412 when its entity is created at first.
416 * Request for entity:: Message-passing for entity
417 * mm-backend module:: How to make mm-backend
420 @node Request for entity, mm-backend module, mm-backend, mm-backend
421 @subsection Message-passing for entity
423 @defun mime-entity-send entity message &rest args
425 Send @var{message} to @var{entity} with @var{args}, and return the
428 @var{args} is arguments of the @var{message}.
433 @node mm-backend module, , Request for entity, mm-backend
434 @subsection How to make mm-backend
436 (It is not written yet, sorry. (^_^;)@refill
441 @node Content-Type, Content-Disposition, Entity, Top
442 @chapter Information of Content-Type field
443 @cindex mime-content-type
444 @cindex Content-Type field
446 @strong{Content-Type field} is a field to indicate kind of contents or
447 data format, such as media-type (@ref{media-type}) and MIME charset. It
448 is defined in RFC 2045 (@ref{RFC 2045}).
454 Historically, Content-Type field was proposed in RFC 1049. In it,
455 Content-Type did not distinguish type and subtype, and there are no
456 mechanism to represent kind of character code like MIME charset.
460 FLIM provides parser for Content-Type field and structure
461 @strong{mime-content-type} to store information of
466 * Content-Type field:: Format of Content-Type field
467 * mime-content-type:: mime-content-type structure
468 * Content-Type parser:: Parser
469 * Content-Type utility:: Utility functions
472 @node Content-Type field, mime-content-type, Content-Type, Content-Type
473 @section Format of Content-Type field
478 Content-Type
\e$BMs$N7A<0$O0J2<$N$h$&$KDj5A$5$l$F$$$^$9!'
\e(B
481 ``Content-Type'' ``:'' @strong{type} ``/''
482 @strong{subtype} *( ``;'' @strong{parameter} )
489 Content-Type: image/jpeg
498 Content-Type: text/plain; charset=iso-2022-jp
503 \e$B$J$I$N$h$&$KMQ$$$i$l$^$9!#
\e(B
505 \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
506 \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
507 `text/plain'
\e$B$O
\e(B media-type
\e$B$N#1$D$G$9!#
\e(B
513 Content-Type
\e$BMs$N$J$$
\e(B entity
\e$B$O
\e(B
517 Content-Type: text/plain; charset=us-ascii
522 \e$B$H$7$F2r<a$5$l$k!#
\e(B(cf. @ref{us-ascii})
527 @node mime-content-type, Content-Type parser, Content-Type field, Content-Type
528 @section mime-content-type structure
530 @deffn{Structure} mime-content-type
532 Content-Type
\e$BMs$N>pJs$r3JG<$9$k$?$a$N9=B$BN!#
\e(B@refill
534 \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
535 \e$B>H4X?t$rMQ$$$k!#
\e(B@refill
537 \e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'
\e(B
541 media-type
\e$B$N<g7?
\e(B (symbol).
544 media-type
\e$B$NI{7?
\e(B (symbol).
547 Content-Type
\e$BMs$N
\e(B parameter (
\e$BO"A[
\e(B list).
553 @defun make-mime-content-type type subtype
556 content-type
\e$B$N@8@.;R!#
\e(B
560 @defun mime-content-type-parameter content-type parameter
562 @var{content-type}
\e$B$N
\e(B @var{parameter}
\e$B$NCM$rJV$9!#
\e(B
567 @node Content-Type parser, Content-Type utility, mime-content-type, Content-Type
570 @defun mime-parse-Content-Type string
572 @var{string}
\e$B$r
\e(B content-type
\e$B$H$7$F2r@O$7$?7k2L$rJV$9!#
\e(B
576 @defun mime-read-Content-Type
578 \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
580 Content-Type
\e$BMs$,B8:_$7$J$$>l9g$O
\e(B nil
\e$B$rJV$9!#
\e(B
585 @node Content-Type utility, , Content-Type parser, Content-Type
586 @section Utility functions
588 @defun mime-type/subtype-string type &optional subtype
590 Return type/subtype string from @var{type} and @var{subtype}.
595 @node Content-Disposition, Content-Transfer-Encoding, Content-Type, Top
596 @chapter Information of Content-Disposition field
597 @cindex mime-content-disposition
599 @cindex Standards Track
600 @cindex Content-Disposition
\e$BMs
\e(B
602 @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
603 \e$B$NB0@-$K$J$I$K4X$9$k>pJs$r5-=R$9$k$?$a$N$b$N$G$9!#
\e(B
609 S. Dorner, K. Moore and R. Troost, ``Communicating Presentation
610 Information in Internet Messages: The Content-Disposition Header'',
611 August 1997, Standards Track.
614 FLIM
\e$B$O
\e(B Content-Disposition
\e$BMs$r9=J82r@O$9$k4X?t$H
\e(B Content-Disposition
615 \e$BMs$N2r@O7k2L$r3JG<$9$k9=B$BN
\e(B
616 @strong{mime-content-disposition}
\e$B$rDs6!$7$^$9!#
\e(B
620 * mime-content-disposition:: mime-content-disposition structure
621 * Content-Disposition parser:: Parser for Content-Disposition field
624 @node mime-content-disposition, Content-Disposition parser, Content-Disposition, Content-Disposition
625 @section mime-content-disposition structure
627 @deffn{Structure} mime-content-disposition
629 Content-Disposition
\e$BMs$N2r@O7k2L$r<}$a$k$?$a$N9=B$BN!#
\e(B@refill
631 \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
632 \e$BA0$N;2>H4X?t$rMQ$$$k!#
\e(B@refill
634 \e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'
\e(B
637 @item disposition-type
638 disposition-type (symbol).
641 Content-Disposition
\e$BMs$N
\e(B parameter (
\e$BO"A[
\e(B list).
647 @defun mime-content-disposition-parameter content-disposition parameter
649 @var{content-disposition}
\e$B$N
\e(B @var{parameter}
\e$B$NCM$rJV$9!#
\e(B
653 @defun mime-content-disposition-filename content-disposition
655 @var{content-disposition}
\e$B$N
\e(B filename
\e$B$NCM$rJV$9!#
\e(B
660 @node Content-Disposition parser, , mime-content-disposition, Content-Disposition
661 @section Parser for Content-Disposition field
663 @defun mime-parse-Content-Disposition string
665 @var{string}
\e$B$r
\e(B content-disposition
\e$B$H$7$F2r@O$7$?7k2L$rJV$9!#
\e(B
669 @defun mime-read-Content-Disposition
671 \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
674 Content-Disposition
\e$BMs$,B8:_$7$J$$>l9g$O
\e(B nil
\e$B$rJV$9!#
\e(B
679 @node Content-Transfer-Encoding, encoded-word, Content-Disposition, Top
680 @chapter Encoding Method
681 @cindex Content-Transfer-Encoding
\e$BMs
\e(B
683 @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
684 \e$B$N$b$N$G$9!#
\e(B@refill
686 FLIM
\e$B$G$O
\e(B Content-Transfer-Encoding
\e$BMs$r9=J82r@O$9$k4X?t$rDs6!$7$^$9!#$3
\e(B
687 \e$B$l$i$N4X?t$O
\e(B Content-Transfer-Encoding
\e$BMs$N>pJs$OJ8;zNs$GI=8=$7$^$9!#
\e(B
690 \e$B$^$?!"
\e(BContent-Transfer-Encoding
\e$B$K4p$E$$$FId9f2=!&I|9f2=$r9T$&4X?t$bDs
\e(B
695 * Content-Transfer-Encoding parser:: Parser
696 * Region encoder/decoder:: Region encoding/decoding
697 * String encoder/decoder:: String encoding/decoding
698 * File encoder/decoder:: File encoding/decoding
701 @node Content-Transfer-Encoding parser, Region encoder/decoder, Content-Transfer-Encoding, Content-Transfer-Encoding
704 @defun mime-parse-Content-Transfer-Encoding string
706 @var{string}
\e$B$r
\e(B content-transfer-encoding
\e$B$H$7$F2r@O$7$?7k2L$rJV$9!#
\e(B
710 @defun mime-read-Content-Transfer-Encoding &optional default-encoding
712 \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
713 \e$BJV$9!#
\e(B@refill
715 Content-Transfer-Encoding
\e$BMs$,B8:_$7$J$$>l9g$O
\e(B@var{default-encoding}
\e$B$r
\e(B
721 @node Region encoder/decoder, String encoder/decoder, Content-Transfer-Encoding parser, Content-Transfer-Encoding
722 @section Region encoding/decoding
724 @defun mime-encode-region start end encoding
726 Encode region @var{start} to @var{end} of current buffer using
731 @defun mime-decode-region start end encoding
733 Decode region @var{start} to @var{end} of current buffer using
738 @defvar mime-encoding-method-alist
740 Alist of encoding vs. corresponding method to encode region.@refill
742 Each element looks like @code{(STRING . FUNCTION)} or @code{(STRING
743 . nil)}. @var{string} is content-transfer-encoding. @code{function} is
744 region encoder and @code{nil} means not to encode.
748 @defvar mime-decoding-method-alist
750 Alist of encoding vs. corresponding method to decode region.@refill
752 Each element looks like @code{(STRING . FUNCTION)} or @code{(STRING
753 . nil)}. @var{string} is content-transfer-encoding. @code{function} is
754 region decoder and @code{nil} means not to decode.
759 @node String encoder/decoder, File encoder/decoder, Region encoder/decoder, Content-Transfer-Encoding
760 @section String encoding/decoding
762 @defun mime-decode-string string encoding
764 @var{string}
\e$B$r
\e(B @var{encoding}
\e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#
\e(B
768 @defvar mime-string-decoding-method-alist
770 Alist of encoding vs. corresponding method to decode string.@refill
772 Each element looks like @code{(STRING . FUNCTION)}. STRING is
773 content-transfer-encoding. FUNCTION is string decoder.
778 @node File encoder/decoder, , String encoder/decoder, Content-Transfer-Encoding
779 @section File encoding/decoding
781 @defun mime-insert-encoded-file filename encoding
783 Insert file @var{FILENAME} encoded by @var{ENCODING} format.
787 @defun mime-write-decoded-region start end filename encoding
789 Decode and write current region encoded by @var{encoding} into
790 @var{filename}.@refill
792 @var{start} and @var{end} are buffer positions.
796 @defvar mime-file-encoding-method-alist
798 Alist of encoding vs. corresponding method to insert encoded
801 Each element looks like @code{(STRING . FUNCTION)}. STRING is
802 content-transfer-encoding. FUNCTION is function to insert encoded file.
806 @defvar mime-file-decoding-method-alist
808 Alist of encoding vs. corresponding method to write decoded region to
811 Each element looks like @code{(STRING . FUNCTION)}. STRING is
812 content-transfer-encoding. FUNCTION is function to write decoded region
818 @node encoded-word, custom, Content-Transfer-Encoding, Top
819 @chapter Network representation of header
821 @cindex Standards Track
824 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
825 \e$B$G!"
\e(B@strong{RFC 2047}
\e$B$GDj5A$5$l$F$$$^$9!#
\e(B@refill
831 K. Moore, ``MIME (Multipurpose Internet Mail Extensions) Part Three:
832 Message Header Extensions for Non-ASCII Text'', November 1996, Standards
833 Track (obsolete RFC 1521,1522,1590).
836 \e$B$^$?!"9T57$N0-$$$3$H$@$H8@$($^$9$,!"
\e(Bencoded-word
\e$B$rMQ$$$:$KHs
\e(B ASCII
837 (@ref{ASCII})
\e$BJ8;z$r
\e(B header
\e$B$KF~$l$?5-;v$bB8:_$7$^$9!#
\e(B@refill
839 FLIM
\e$B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#
\e(B
843 * Header encoder/decoder:: Header encoding/decoding
846 @node Header encoder/decoder, , encoded-word, encoded-word
847 @section Header encoding/decoding
849 @defun eword-encode-header &optional code-conversion separator
851 Decode MIME encoded-words in header fields.@refill
853 If @var{code-conversion} is @code{nil}, it decodes only encoded-words.
854 If it is mime-charset, it decodes non-ASCII bit patterns as the
855 mime-charset. Otherwise it decodes non-ASCII bit patterns as the
856 default-mime-charset.@refill
858 If @var{separator} is not nil, it is used as header separator.
862 @defun eword-encode-header &optional code-conversion
864 Encode header fields to network representation, such as MIME
867 It refer variable @code{eword-field-encoding-method-alist}.
872 @node custom, Appendix, encoded-word, Top
873 @chapter Various Customization
877 MIME
\e$B4XO"5!G=$K4X$9$k
\e(B group.@refill
879 @code{mail}
\e$B$H
\e(B @code{news}
\e$B$KB0$9$k!#
\e(B
883 @defvar default-mime-charset
885 \e$BE,@Z$J
\e(B MIME charset (@ref{MIME charset})
\e$B$,8+$D$+$i$J$+$C$?>l9g$KMQ$$$i
\e(B
886 \e$B$l$k
\e(BMIME charset.@refill
888 \e$BK\Mh$O
\e(B APEL
\e$B$NJQ?t$G$"$k!#
\e(B
892 @defvar mime-temp-directory
894 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
897 \e$B4D6-JQ?t
\e(B @code{MIME_TMP_DIR}, @code{TM_TMP_DIR}, @code{TMPDIR},
898 @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
899 \e$BMQ$$$k!#2?$b@_Dj$5$l$F$$$J$$>l9g!"
\e(B@code{"/tmp/"}
\e$B$rMQ$$$k!#
\e(B
904 @node Appendix, Concept Index, custom, Top
910 * Bug report:: How to report bugs
911 * CVS:: CVS based development
912 * History:: History of FLIM
915 @node Glossary, Bug report, Appendix, Appendix
925 * coded character set:: Coded character set, Character code
943 @node 7bit, 8bit, Glossary, Glossary
945 @cindex 7bit (textual) string
949 @strong{7bit} means any integer between 0 .. 127.@refill
951 Any data represented by 7bit integers is called @strong{7bit data}.@refill
953 Textual string consisted of Control characters between 0 .. 31 and 127,
954 and space represented by 32, and graphic characters between 33 .. 236
955 are called @strong{7bit (textual) string}.@refill
957 Conventional Internet MTA (@ref{MTA}) can translate 7bit data, so it is
958 no need to translate by Quoted-Printable (@ref{Quoted-Printable}) or
959 Base64 (@ref{Base64}) for 7bit data.@refill
961 However if there are too long lines, it can not translate by 7bit MTA
962 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
963 ``7bit data'' has a line more than 999 bytes, it is regarded as binary
964 (@ref{binary}). For example, Postscript file should be encoded by
968 @node 8bit, ASCII, 7bit, Glossary
970 @cindex 8bit (textual) string
974 @strong{8bit} means any integer between 0 .. 255.@refill
976 Any data represented by 8bit integers is called @strong{8bit data}.@refill
978 Textual string consisted of Control characters between 0 .. 31, 127, and
979 128 .. 159, and space represented by 32, and graphic characters between
980 33 .. 236 and 160 .. 255 are called @strong{8bit (textual) string}.@refill
982 For example, iso-8859-1 (@ref{iso-8859-1}) or euc-kr (@ref{euc-kr}) are
983 coded-character-set represented by 8bit textual string.@refill
985 Traditional Internet MTA (@ref{MTA}) can translate only 7bit
986 (@ref{7bit}) data, so if a 8bit data will be translated such MTA, it
987 must be encoded by Quoted-Printable (@ref{Quoted-Printable}) or Base64
988 (@ref{Base64}).@refill
990 However 8bit MTA are increasing today.@refill
992 However if there are too long lines, it can not translate by 8bit MTA
993 even if it is 8bit data. RFC 2045 (@ref{RFC 2045}) require lines in
994 8bit data must be less than 998 bytes. So if a ``8bit data'' has a line
995 more than 999 bytes, it is regarded as binary (@ref{binary}), so it must
996 be encoded by Base64 or Quoted-Printable.
999 @node ASCII, Base64, 8bit, Glossary
1001 @cindex ANSI X3.4:1986
1005 @strong{ASCII} is a 94-character set contains primary latin characters
1006 (A-Z, a-z), numbers and some characters. It is a standard of the United
1007 States of America. It is a variant of ISO 646 (@ref{ISO 646}).
1013 ``Coded Character Set -- 7-Bit American Standard Code for Information
1014 Interchange'', ANSI X3.4:1986.
1019 @node Base64, binary, ASCII, Glossary
1024 @strong{Base64} is a transfer encoding method of MIME (@ref{MIME})
1025 defined in RFC 2045 (@ref{RFC 2045}).@refill
1027 The encoding process represents 24-bit groups of input bits as output
1028 strings of 4 encoded characters. Encoded characters represent integer 0
1029 .. 63 or @strong{pad}. Base64 data must be 4 * n bytes, so pad is used
1030 to adjust size.@refill
1032 These 65 characters are subset of all versions of ISO 646, including
1033 US-ASCII, and all versions of EBCDIC. So it is safe even if it is
1034 translated by non-Internet gateways.
1037 @node binary, coded character set, Base64, Glossary
1041 Any byte stream is called @strong{binary}.@refill
1043 It does not require structureof lines. It differs from from 8bit
1044 (@ref{8bit}).@refill
1046 In addition, if line structured data contain too long line (more than
1047 998 bytes), it is regarded as binary.
1050 @node coded character set, media-type, binary, Glossary
1051 @subsection Coded character set, Character code
1053 A set of unambiguous rules that establishes a character set and the
1054 one-to-one relationship between the characters of the set and their
1058 @node media-type, message, coded character set, Glossary
1059 @subsection media-type
1072 @strong{media-type} specifies the nature of the data in the body of MIME
1073 (@ref{MIME}) entity (@ref{entity}). It consists of @strong{type} and
1074 @strong{subtype}. It is defined in RFC 2046 (@ref{RFC 2046}).@refill
1076 Currently there are following standard primary-types:
1088 @strong{application}
1090 @strong{multipart} (@ref{multipart})
1096 And there are various subtypes, for example, application/octet-stream,
1097 audio/basic, image/jpeg, multipart/mixed (@ref{multipart/mixed}),
1098 text/plain (@ref{text/plain}), video/mpeg... @refill
1100 You can refer registered media types at MEDIA TYPES
1101 (ftp://ftp.isi.edu/in-notes/iana/assignments/media-types).@refill
1103 In addition, you can use private type or subtype using @strong{x-token},
1104 which as the prefix `x-'. However you can not use them in
1107 (cf. @ref{Content-Type field})
1111 @node message, MIME, media-type, Glossary
1114 In this document, it means mail defined in RFC 822 (@ref{RFC 822}) and
1115 news message defined in RFC 1036 (@ref{RFC 1036}).
1118 @node MIME, MIME charset, message, Glossary
1120 @cindex Multipurpose Internet Mail Extensions
1122 MIME stands for @strong{Multipurpose Internet Mail Extensions}, it is an
1123 extension for RFC 822 (@ref{RFC 822}).@refill
1125 According to RFC 2045:@refill
1127 STD 11, RFC 822, defines a message representation protocol specifying
1128 considerable detail about US-ASCII message headers, and leaves the
1129 message content, or message body, as flat US-ASCII text. This set of
1130 documents, collectively called the Multipurpose Internet Mail
1131 Extensions, or MIME, redefines the format of messages to allow for
1135 textual message bodies in character sets other than US-ASCII,
1137 an extensible set of different formats for non-textual message
1140 multi-part message bodies, and
1142 textual header information in character sets other than US-ASCII.
1146 It is defined in RFC 2045 (@ref{RFC 2045}), RFC 2046 (@ref{RFC 2046}),
1147 RFC 2047 (@ref{encoded-word}), RFC 2048 (@ref{RFC 2048}) and RFC 2049
1151 @node MIME charset, MTA, MIME, Glossary
1152 @subsection MIME charset
1154 Coded character set (@ref{coded character set}) used in Content-Type
1155 field (@ref{Content-Type field}) or charset parameter of encoded-word
1156 (@ref{encoded-word}).@refill
1158 It is defined in RFC 2045 (@ref{RFC 2045}).@refill
1160 iso-2022-jp (@ref{iso-2022-jp}) or euc-kr (@ref{euc-kr}) are kinds of
1161 it. (In this document, MIME charsets are written by small letters to
1162 distinguish graphic character set (@ref{graphic character set}). For
1163 example, ISO 8859-1 is a graphic character set, and iso-8859-1 is a MIME
1167 @node MTA, MUA, MIME charset, Glossary
1169 @cindex Message Transfer Agent
1171 @strong{Message Transfer Agent}. It means mail transfer programs
1172 (ex. sendmail) and news servers.@refill
1178 @node MUA, Quoted-Printable, MTA, Glossary
1180 @cindex Message User Agent
1182 @strong{Message User Agent}. It means mail readers and news
1189 @node Quoted-Printable, RFC 822, MUA, Glossary
1190 @subsection Quoted-Printable
1191 @cindex Quoted-Printable
1193 @strong{Quoted-Printable} is a transfer encoding method of MIME
1194 (@ref{MIME}) defined in RFC 2045 (@ref{RFC 2045}).@refill
1196 If the data being encoded are mostly US-ASCII text, the encoded form of
1197 the data remains largely recognizable by humans.@refill
1203 @node RFC 822, RFC 1036, Quoted-Printable, Glossary
1207 @cindex Internet mail
1208 @cindex Internet message
1209 @cindex message header
1211 A RFC defines format of Internet mail message, mainly @strong{message header}.
1217 news message is based on RFC 822, so @strong{Internet message} may be
1218 more suitable than @strong{Internet mail} .
1226 D. Crocker, ``Standard for the Format of ARPA Internet Text Messages'',
1227 August 1982, STD 11.
1232 @node RFC 1036, RFC 2045, RFC 822, Glossary
1233 @subsection RFC 1036
1237 A RFC defines format of USENET message. It is a subset of RFC 822
1238 (@ref{RFC 822}). It is not Internet standard, but a lot of netnews
1239 excepting Usenet uses it.
1245 M. Horton and R. Adams, ``Standard for Interchange of USENET Messages'',
1246 December 1987, (obsolete RFC 850).
1251 @node RFC 2045, RFC 2046, RFC 1036, Glossary
1252 @subsection RFC 2045
1254 @cindex Standards Track
1260 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1261 (MIME) Part One: Format of Internet Message Bodies'', November 1996,
1262 Standards Track (obsolete RFC 1521, 1522, 1590).
1267 @node RFC 2046, RFC 2048, RFC 2045, Glossary
1268 @subsection RFC 2046
1270 @cindex Standards Track
1276 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1277 (MIME) Part Two: Media Types'', November 1996, Standards Track (obsolete
1278 RFC 1521, 1522, 1590).
1283 @node RFC 2048, RFC 2049, RFC 2046, Glossary
1284 @subsection RFC 2048
1286 @cindex Standards Track
1292 N. Freed, J. Klensin and J. Postel, ``Multipurpose Internet Mail
1293 Extensions (MIME) Part Four: Registration Procedures'', November 1996,
1294 Standards Track (obsolete RFC 1521, 1522, 1590).
1299 @node RFC 2049, plain text, RFC 2048, Glossary
1300 @subsection RFC 2049
1302 @cindex Standards Track
1308 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1309 (MIME) Part Five: Conformance Criteria and Examples'', November 1996,
1310 Standards Track (obsolete RFC 1521, 1522, 1590).
1315 @node plain text, us-ascii, RFC 2049, Glossary
1316 @subsection plain text
1318 A textual data represented by only coded character set (@ref{coded character set}). It does not have information about font or
1319 typesetting. (cf. @ref{text/plain})
1323 @node us-ascii, , plain text, Glossary
1324 @subsection us-ascii
1328 A MIME charset (@ref{MIME charset}) for primary Latin script mainly
1329 written by English or other languages.@refill
1331 It is a 7bit coded character set (@ref{coded character set}) based on
1332 ISO 2022 (@ref{ISO 2022}), it contains only ASCII (@ref{ASCII}) and code
1333 extension (@ref{code extension}) is not allowed.@refill
1335 It is standard coded character set of Internet mail. If MIME charset is
1336 not specified, @strong{us-ascii} is used as default.@refill
1338 In addition, @strong{ASCII} of RFC 822 (@ref{RFC 822}) should be
1339 interpreted as us-ascii.
1342 @node Bug report, CVS, Glossary, Appendix
1343 @section How to report bugs
1344 @cindex good bug report
1346 If you write bug-reports and/or suggestions for improvement, please
1347 send them to the tm Mailing List:
1351 Japanese <bug-tm-ja@@chamonix.jaist.ac.jp>
1353 English <bug-tm-en@@chamonix.jaist.ac.jp>
1357 Notice that, we do not welcome bug reports about too old version. Bugs
1358 in old version might be fixed. So please try latest version at
1361 You should write @strong{good bug report}. If you write only ``FLIM
1362 does not work'', we can not find such situations. At least, you should
1363 write name, type, variants and version of OS, emacs, APEL, FLIM, SEMI
1364 and MUA, and setting. In addition, if error occurs, to send backtrace
1365 is very important. (cf. @ref{(emacs)Bugs}) @refill
1367 Bug may not appear only your environment, but also in a lot of
1368 environment (otherwise it might not bug). Therefor if you send mail
1369 to author directly, we must write a lot of mails. So please send mail
1370 to address for tm bugs instead of author.
1372 Via the tm ML, you can report FLIM bugs, obtain the latest release of
1373 FLIM, and discuss future enhancements to FLIM. To join the tm ML,
1374 send empty e-mail to:
1378 Japanese <tm-ja-help@@chamonix.jaist.ac.jp>
1380 English <tm-en-help@@chamonix.jaist.ac.jp>
1385 @node CVS, History, Bug report, Appendix
1386 @section CVS based development
1388 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
1389 \e$B?7$N
\e(B FLIM
\e$B$rF~<j$9$k$3$H$,$G$-$^$9!'
\e(B
1394 % cvs -d :pserver:anonymous@@chamonix.jaist.ac.jp:/hare/cvs/root \
1397 CVS password: [CR] # NULL string
1401 % cvs -d :pserver:anonymous@@chamonix.jaist.ac.jp:/hare/cvs/root \
1402 checkout [-r TAG] flim
1406 CVS
\e$B$rMQ$$$?3+H/$K;22C$7$?$$J}$O
\e(B
1410 <cvs@@chamonix.jaist.ac.jp>
1414 \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
1415 \e$B$r1h$($F8fO"Mm$/$@$5$$!#
\e(B
1418 @node History, , CVS, Appendix
1419 @section History of FLIM
1421 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
1422 \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
1423 \e$B@lMQ$N
\e(B encoded-word
\e$B$NI|9f2=%W%m%0%i%`$G$7$?!#
\e(B@refill
1425 \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
1426 \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
1427 \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
1428 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
1429 charset (@ref{MIME charset})
\e$B$rF1;~$K;H$&$3$H$,$G$-$^$7$?!#$3$N;~!"
\e(B
1430 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
1431 package
\e$B$K$^$H$a$i$l$^$9!#
\e(B@refill
1433 \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
1434 \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
1435 package
\e$B$K$^$H$a$i$l!"
\e(Btm
\e$B$H$$$&L>A0$GG[I[$5$l$^$9!#
\e(B@refill
1437 \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
1438 @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
1439 \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
1440 \e$B3K$H$J$j$^$9!#
\e(B@refill
1442 @file{tm-view.el}
\e$B$OEvA3!"
\e(BContent-Transfer-Encoding
\e$B$r07$&I,MW$,$"$j$^$9!#
\e(B
1443 \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
1444 @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
1445 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
1446 \e$B$^$7$?!#
\e(B@refill
1448 \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
1449 \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
1450 \e$B$7$?!#
\e(B@refill
1452 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
1453 \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
1454 @file{std11.el}
\e$B$KEv$?$j$^$9!#$^$?!"$3$N2aDx$G
\e(B @file{tiny-mime.el}
\e$B$OI|
\e(B
1455 \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
1456 \e$B$^$7$?!#$3$NN><T$,8=:_$N
\e(B @file{eword-decode.el}
\e$B$H
\e(B
1457 @file{eword-encode.el}
\e$B$N@hAD$KEv$?$j$^$9!#
\e(B@refill
1459 \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
1460 \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
1461 \e$B$N$&$A$N
\e(B MEL
\e$B$,
\e(B FLIM
\e$B$ND>@\$N@hAD$KEv$?$j$^$9!#
\e(B@refill
1463 \e$B8e$K!"
\e(BAPEL
\e$B$+$i
\e(B @file{std11.el}
\e$B$,0\$5$l!"$^$?!"
\e(B@file{mailcap.el},
1464 @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
1465 package
\e$B$NL>A0$,
\e(B FLIM
\e$B$H$J$j$^$9!#
\e(B@refill
1467 \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
1468 FLIM
\e$B$N;^$G$"$k
\e(B ``FLIM-FLAM''
\e$B$H$J$C$F$$$^$9!#
\e(B
1471 @node Concept Index, Function Index, Appendix, Top
1472 @chapter Concept Index
1476 @node Function Index, Variable Index, Concept Index, Top
1477 @chapter Function Index
1481 @node Variable Index, , Function Index, Top
1482 @chapter Variable Index