update.
[elisp/flim.git] / mime-en.texi
index 5ea9840..72dd84d 100644 (file)
@@ -1,13 +1,13 @@
 \input texinfo.tex
 @setfilename mime-en.info
-@settitle{FLIM 1.8 Manual about MIME Features}
+@settitle{FLIM 1.9 Manual about MIME Features}
 @titlepage
-@title FLIM 1.8 Manual about MIME Features
+@title FLIM 1.9 Manual about MIME Features
 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp>
 @subtitle 1998/07/01
 @end titlepage
 @node Top, Introduction, (dir), (dir)
-@top FLIM 1.8 Manual about MIME Features
+@top FLIM 1.9 Manual about MIME Features
 
 @ifinfo
 
@@ -126,19 +126,16 @@ on representation-type.
 @end defun
 
 
-@defun mime-parse-message &optional  default-ctl node-id
-
-Parse current buffer as message, and return the result as mime-entity.
-@end defun
-
-
-@defun mime-parse-buffer &optional  buffer
+@defun mime-parse-buffer &optional  buffer type
 
 Parse @var{buffer} as message, and set the result to buffer local
 variable @code{mime-message-structure} of @var{buffer} as
 mime-entity.@refill
 
-If @var{buffer} is omitted, current buffer is used.
+If @var{buffer} is omitted, current buffer is used.@refill
+
+@var{type} is representation-type of created
+mime-entity. (cf. @ref{mm-backend}) Default value is @var{buffer}.
 @end defun
 
 
@@ -226,10 +223,14 @@ Return file name of @var{entity}.
 @end defun
 
 
-@defun mime-entity-encoding entity
+@defun mime-entity-encoding entity  &optional  default-encoding
 
 Return content-transfer-encoding of @var{entity}.
-(cf. @ref{Content-Transfer-Encoding})
+(cf. @ref{Content-Transfer-Encoding}) @refill
+
+If the @var{entity} does not have Content-Transfer-Encoding field, this
+function returns @var{default-encoding}.  If it is nil, @code{"7bit"} is
+used as default value.
 @end defun
 
 
@@ -380,12 +381,11 @@ contains @var{entity}.
 @cindex entity \e$B=hM}\e(B method
 @cindex representation-type
 
-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
-\e$B$5$^$6$^$J$b$N$,MxMQ$G$-$k$h$&$K@_7W$5$l$F$$$^$9!#\e(B@refill
+Entity is an abstraction.  It is designed to use various data
+representations for their purposes.@refill
 
-\e$B$3$3$G!"\e(Bentity \e$B$,$I$&$$$&<oN`$NI=8=$r9T$C$F$$$k$+$r<($9$N$,\e(B
-@strong{representation-type} \e$B$G!"\e(Bentity \e$B$r@8@.$9$k;~$K$O$3$l$r;XDj$7$^$9!#\e(B
-(cf. @ref{Entity Creation}) @refill
+Each entity has @strong{representation-type}.  It must be specified when
+an entity is created. (cf. @ref{Entity Creation}) @refill
 
 \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
 \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 
@@ -445,15 +445,16 @@ mechanism to represent kind of character code like MIME charset.
 @end quotation
 
 
-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
-\e$B3JG<$9$k9=B$BN\e(B @strong{mime-content-type} \e$B$rDs6!$7$^$9!#\e(B
+FLIM provides parser for Content-Type field and structure
+@strong{mime-content-type} to store information of
+Content-Type field.
 
 
 @menu
 * Content-Type field::          Format of Content-Type field
 * mime-content-type::           mime-content-type structure
-* Content-Type parser::         Parser for Content-Type field
-* Content-Type utility::        Content-Type
+* Content-Type parser::         Parser
+* Content-Type utility::        Utility functions
 @end menu
 
 @node Content-Type field, mime-content-type, Content-Type, Content-Type
@@ -552,7 +553,7 @@ content-type \e$B$N@8@.;R!#\e(B
 
 
 @node Content-Type parser, Content-Type utility, mime-content-type, Content-Type
-@section Parser for Content-Type field
+@section Parser
 
 @defun mime-parse-Content-Type string
 
@@ -570,7 +571,7 @@ Content-Type \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
 
 
 @node Content-Type utility,  , Content-Type parser, Content-Type
-@section Content-Type
+@section Utility functions
 
 @defun mime-type/subtype-string type  &optional  subtype
 
@@ -679,14 +680,14 @@ FLIM \e$B$G$O\e(B Content-Transfer-Encoding \e$BMs$r9=J82r@O$9$k4X?t$rDs6!$7$^$9!#$
 
 
 @menu
-* Content-Transfer-Encoding parser::  Parser for Content-Transfer-Encoding field
+* Content-Transfer-Encoding parser::  Parser
 * Region encoder/decoder::      Region encoding/decoding
 * String encoder/decoder::      String encoding/decoding
 * File encoder/decoder::        File encoding/decoding
 @end menu
 
 @node Content-Transfer-Encoding parser, Region encoder/decoder, Content-Transfer-Encoding, Content-Transfer-Encoding
-@section Parser for Content-Transfer-Encoding field
+@section Parser
 
 @defun mime-parse-Content-Transfer-Encoding string