aboutsummaryrefslogtreecommitdiff
path: root/doc/mime.html
diff options
context:
space:
mode:
authorDiego Nehab <diego@tecgraf.puc-rio.br>2004-06-16 04:28:21 +0000
committerDiego Nehab <diego@tecgraf.puc-rio.br>2004-06-16 04:28:21 +0000
commit0a4c1534f39511894728da193ab8225ad6022de9 (patch)
tree683b711accf64eca486b138cbc034c609f93a53a /doc/mime.html
parent8e80e38f2c3121242b3b2f7a45a960c9af4d1a68 (diff)
downloadluasocket-0a4c1534f39511894728da193ab8225ad6022de9.tar.gz
luasocket-0a4c1534f39511894728da193ab8225ad6022de9.tar.bz2
luasocket-0a4c1534f39511894728da193ab8225ad6022de9.zip
Still work to do in the manual...
Diffstat (limited to 'doc/mime.html')
-rw-r--r--doc/mime.html15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/mime.html b/doc/mime.html
index 286e41c..791861e 100644
--- a/doc/mime.html
+++ b/doc/mime.html
@@ -36,7 +36,7 @@
36<h2 id=mime>MIME</h2> 36<h2 id=mime>MIME</h2>
37 37
38<p> 38<p>
39The MIME module offers filters that apply and remove common 39The <tt>mime</tt> namespace offers filters that apply and remove common
40content transfer encodings, such as Base64 and Quoted-Printable. 40content transfer encodings, such as Base64 and Quoted-Printable.
41It also provides functions to break text into lines and change 41It also provides functions to break text into lines and change
42the end-of-line convention. 42the end-of-line convention.
@@ -55,6 +55,15 @@ follows the ideas presented in
55LTN012, Filters sources and sinks</a>. 55LTN012, Filters sources and sinks</a>.
56</p> 56</p>
57 57
58<p class=description> To obtain the <tt>mime</tt> namespace, run:
59</p>
60
61<pre class=example>
62-- loads the MIME module and everything it requires
63local mime = require("mime")
64</pre>
65
66
58<!-- High-level +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 67<!-- High-level +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
59 68
60<h3 id=high>High-level filters</h3> 69<h3 id=high>High-level filters</h3>
@@ -108,7 +117,7 @@ The function returns the created filter.
108 117
109<p class=name id="encode"> 118<p class=name id="encode">
110mime.<b>encode(</b>"base64"<b>)</b><br> 119mime.<b>encode(</b>"base64"<b>)</b><br>
111mime.<b>encode(</b>"quoted-printable" [, mode])</b> 120mime.<b>encode(</b>"quoted-printable" [, mode]<b>)</b>
112</p> 121</p>
113 122
114<p class=description> 123<p class=description>
@@ -278,7 +287,7 @@ that can be encoded unambiguously. <tt>B</tt> has the remaining bytes of
278<tt>C..D</tt>, <em>before</em> encoding. 287<tt>C..D</tt>, <em>before</em> encoding.
279If <tt>D</tt> is <tt><b>nil</b></tt>, <tt>A</tt> is padded with 288If <tt>D</tt> is <tt><b>nil</b></tt>, <tt>A</tt> is padded with
280the encoding of the remaining bytes of <tt>C</tt>. 289the encoding of the remaining bytes of <tt>C</tt>.
281Throughout encoding, occurences of CRLF are replaced by the 290Throughout encoding, occurrences of CRLF are replaced by the
282<tt>marker</tt>, which itself defaults to CRLF. 291<tt>marker</tt>, which itself defaults to CRLF.
283</p> 292</p>
284 293