projects / elisp / flim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Specify coding-system.
[elisp/flim.git] / mime-en.sgml
diff --git a/mime-en.sgml b/mime-en.sgml
index 264996e..f9d5d4e 100644 (file)
--- a/mime-en.sgml
+++ b/mime-en.sgml
@@ -1,6 +1,6 @@
 <!doctype sinfo system>
 <head>
-<title>FLIM 1.8 Manual about MIME Features
+<title>FLIM 1.9 Manual about MIME Features
 <author>MORIOKA Tomohiko <mail>morioka@jaist.ac.jp</mail>
 <date>1998/07/01
 
@@ -98,20 +98,17 @@ Open an entity and return it.
 depended on representation-type.
 </defun>
 
-<defun name="mime-parse-message">
-         <opts> default-ctl node-id
-<p>
-Parse current buffer as message, and return the result as mime-entity.
-</defun>
-
 <defun name="mime-parse-buffer">
-         <opts> buffer
+         <opts> buffer type
 <p>
 Parse <var>buffer</var> as message, and set the result to buffer local
 variable <code>mime-message-structure</code> of <var>buffer</var> as
 mime-entity.
 <p>
 If <var>buffer</var> is omitted, current buffer is used.
+<p>
+<var>type</var> is representation-type of created mime-entity. <cf
+node="mm-backend"> Default value is <var>buffer</var>.
 </defun>
 
 
@@ -200,10 +197,14 @@ Return file name of <var>entity</var>.
 </defun>
 
 <defun name="mime-entity-encoding">
-           <args> entity
+           <args> entity <opts> default-encoding
 <p>
 Return content-transfer-encoding of <var>entity</var>.
 <cf node="Content-Transfer-Encoding">
+<p>
+If the <var>entity</var> does not have Content-Transfer-Encoding
+field, this function returns <var>default-encoding</var>.  If it is
+nil, <code>"7bit"</code> is used as default value.
 </defun>
 
 <defun name="mime-entity-cooked-p">
@@ -406,8 +407,9 @@ mechanism to represent kind of character code like MIME charset.
 </memo>
 
 <p>
-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 <concept>mime-content-type</concept> \e$B$rDs6!$7$^$9!#\e(B
+FLIM provides parser for Content-Type field and structure
+<concept>mime-content-type</concept> to store information of
+Content-Type field.
 
 
 <h2> Format of Content-Type field
@@ -494,7 +496,7 @@ Content-Type \e$BMs$N>pJs$r3JG<$9$k$?$a$N9=B$BN!#\e(B
 </defun>
 
 
-<h2> Content-Type \e$BMs$N2r@O4o\e(B
+<h2> Parser
 <node> Content-Type parser
 <p>
 <defun name="mime-parse-Content-Type">
@@ -511,18 +513,18 @@ Content-Type \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
 </defun>
 
 
-<h2> Content-Type \e$B$K4X$9$kM-MQ$J4X?t\e(B
+<h2> Utility functions
 <node> Content-Type utility
 <p>
 <defun name="mime-type/subtype-string">
          <args> type <opts> subtype
 <p>
-<var>type</var> \e$B$H\e(B <var>subtype</var> \e$B$+$i\e(B type/subtype \e$B7A<0$NJ8;zNs$rJV\e(B
-\e$B$9!#\e(B
+Return type/subtype string from <var>type</var> and
+<var>subtype</var>.
 </defun>
 
 
-<h1> Content-Disposition \e$BMs$N>pJs\e(B
+<h1> Information of Content-Disposition field
 <node> Content-Disposition
 <p>
 <concept>Content-Disposition \e$BMs\e(B</concept> \e$B$O\e(B entity \e$B$NI=<($d\e(B file \e$BL>$J$I\e(B
@@ -539,7 +541,7 @@ FLIM \e$B$O\e(B Content-Disposition \e$BMs$r9=J82r@O$9$k4X?t$H\e(B Content-Dispositi
 <concept>mime-content-disposition</concept> \e$B$rDs6!$7$^$9!#\e(B
 
 
-<h2> mime-content-disposition \e$B9=B$BN\e(B
+<h2> mime-content-disposition structure
 <node> mime-content-disposition
 <p>
 <define type="Structure" name="mime-content-disposition">
@@ -572,7 +574,7 @@ Content-Disposition \e$BMs$N2r@O7k2L$r<}$a$k$?$a$N9=B$BN!#\e(B
 </defun>
 
 
-<h2> Content-Disposition \e$BMs$N2r@O4o\e(B
+<h2> Parser for Content-Disposition field
 <node> Content-Disposition parser
 <p>
 <defun name="mime-parse-Content-Disposition">
@@ -589,7 +591,7 @@ Content-Disposition \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
 </defun>
 
 
-<h1> \e$BId9f2=K!\e(B
+<h1> Encoding Method
 <node> Content-Transfer-Encoding
 <p>
 <concept>Content-Transfer-Encoding \e$BMs\e(B</concept> \e$B$O\e(B entity \e$B$NId9f2=K!$r5-\e(B
@@ -602,7 +604,7 @@ FLIM \e$B$G$O\e(B Content-Transfer-Encoding \e$BMs$r9=J82r@O$9$k4X?t$rDs6!$7$^$9!#$
 \e$B6!$5$l$^$9!#\e(B
 
 
-<h2> Content-Transfer-Encoding \e$BMs$N2r@O4o\e(B
+<h2> Parser
 <node> Content-Transfer-Encoding parser
 <p>
 <defun name="mime-parse-Content-Transfer-Encoding">
@@ -622,7 +624,7 @@ Content-Transfer-Encoding \e$BMs$,B8:_$7$J$$>l9g$O\e(B
 </defun>
 
 
-<h2> \e$BNN0h$NId9f2=!&I|9f2=\e(B
+<h2> Region encoding/decoding
 <node> Region encoder/decoder
 <p>
 <defun name="mime-encode-region">
@@ -660,7 +662,7 @@ and <code>nil</code> means not to decode.
 </defvar>
 
 
-<h2> \e$BJ8;zNs$NId9f2=!&I|9f2=\e(B
+<h2> String encoding/decoding
 <node> String encoder/decoder
 <p>
 <defun name="mime-decode-string">
@@ -679,7 +681,7 @@ FUNCTION is string decoder.
 </defvar>
 
 
-<h2> File \e$B$NId9f2=!&I|9f2=\e(B
+<h2> File encoding/decoding
 <node> File encoder/decoder
 <p>
 <defun name="mime-insert-encoded-file">
@@ -717,7 +719,7 @@ region to file.
 </defvar>
 
 
-<h1> Header \e$B$N\e(B network \e$BI=8=\e(B
+<h1> Network representation of header
 <node> encoded-word
 <p>
 encoded-word \e$B$O\e(B header \e$B$GHs\e(B <dref>ASCII</dref> \e$BJ8;z$rI=8=$9$k$?$a$N7A\e(B
@@ -734,7 +736,7 @@ encoded-word \e$B$O\e(B header \e$B$GHs\e(B <dref>ASCII</dref> \e$BJ8;z$rI=8=$9$k$?$a
 FLIM \e$B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#\e(B
 
 
-<h2> Header \e$B$NId9f2=!&I|9f2=\e(B
+<h2> Header encoding/decoding
 <node> Header encoder/decoder
 <p>
 <defun name="eword-encode-header">
@@ -760,7 +762,7 @@ It refer variable <code>eword-field-encoding-method-alist</code>.
 </defun>
 
 
-<h1> \e$B0lHL@_Dj\e(B
+<h1> Various Customization
 <node> custom
 <p>
 <define type="group" name="mime">