aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThijs Schreijer <thijs@thijsschreijer.nl>2024-03-15 12:55:02 +0100
committerGitHub <noreply@github.com>2024-03-15 12:55:02 +0100
commit93eef5015e0dfe8d24071dd036f9a7f02160abeb (patch)
treee29da398ce6b83a71f25f574de6d0ff58f488012 /docs
parent23241717bf91c4317065828bedafd05ebb97c1ef (diff)
downloadluasocket-93eef5015e0dfe8d24071dd036f9a7f02160abeb.tar.gz
luasocket-93eef5015e0dfe8d24071dd036f9a7f02160abeb.tar.bz2
luasocket-93eef5015e0dfe8d24071dd036f9a7f02160abeb.zip
chore(docs): update LTN12 links (#428)
Diffstat (limited to 'docs')
-rw-r--r--docs/ftp.html10
-rw-r--r--docs/http.html10
-rw-r--r--docs/mime.html2
-rw-r--r--docs/smtp.html14
-rw-r--r--docs/socket.html4
5 files changed, 20 insertions, 20 deletions
diff --git a/docs/ftp.html b/docs/ftp.html
index 7f7da2e..2c57fc8 100644
--- a/docs/ftp.html
+++ b/docs/ftp.html
@@ -55,7 +55,7 @@ protocol. For that, check the implementation.
55 55
56<p> 56<p>
57To really benefit from this module, a good understanding of 57To really benefit from this module, a good understanding of
58<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks"> 58<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">
59LTN012, Filters sources and sinks</a> is necessary. 59LTN012, Filters sources and sinks</a> is necessary.
60</p> 60</p>
61 61
@@ -122,7 +122,7 @@ expects at least the fields <tt>host</tt>, <tt>sink</tt>, and one of
122<tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes 122<tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes
123precedence). <tt>Host</tt> is the server to connect to. <tt>Sink</tt> is 123precedence). <tt>Host</tt> is the server to connect to. <tt>Sink</tt> is
124the <em>simple</em> 124the <em>simple</em>
125<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 125<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
126sink that will receive the downloaded data. <tt>Argument</tt> or 126sink that will receive the downloaded data. <tt>Argument</tt> or
127<tt>path</tt> give the target path to the resource in the server. The 127<tt>path</tt> give the target path to the resource in the server. The
128optional arguments are the following: 128optional arguments are the following:
@@ -136,7 +136,7 @@ authentication. Defaults to "<tt>ftp:anonymous@anonymous.org</tt>";</li>
136<li><tt>type</tt>: The transfer mode. Can take values "<tt>i</tt>" or 136<li><tt>type</tt>: The transfer mode. Can take values "<tt>i</tt>" or
137"<tt>a</tt>". Defaults to whatever is the server default;</li> 137"<tt>a</tt>". Defaults to whatever is the server default;</li>
138<li><tt>step</tt>: 138<li><tt>step</tt>:
139<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 139<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
140pump step function used to pass data from the 140pump step function used to pass data from the
141server to the sink. Defaults to the LTN12 <tt>pump.step</tt> function;</li> 141server to the sink. Defaults to the LTN12 <tt>pump.step</tt> function;</li>
142<li><tt>create</tt>: An optional function to be used instead of 142<li><tt>create</tt>: An optional function to be used instead of
@@ -206,7 +206,7 @@ expects at least the fields <tt>host</tt>, <tt>source</tt>, and one of
206<tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes 206<tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes
207precedence). <tt>Host</tt> is the server to connect to. <tt>Source</tt> is 207precedence). <tt>Host</tt> is the server to connect to. <tt>Source</tt> is
208the <em>simple</em> 208the <em>simple</em>
209<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 209<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
210source that will provide the contents to be uploaded. 210source that will provide the contents to be uploaded.
211<tt>Argument</tt> or 211<tt>Argument</tt> or
212<tt>path</tt> give the target path to the resource in the server. The 212<tt>path</tt> give the target path to the resource in the server. The
@@ -221,7 +221,7 @@ authentication. Defaults to "<tt>ftp:anonymous@anonymous.org</tt>";</li>
221<li><tt>type</tt>: The transfer mode. Can take values "<tt>i</tt>" or 221<li><tt>type</tt>: The transfer mode. Can take values "<tt>i</tt>" or
222"<tt>a</tt>". Defaults to whatever is the server default;</li> 222"<tt>a</tt>". Defaults to whatever is the server default;</li>
223<li><tt>step</tt>: 223<li><tt>step</tt>:
224<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 224<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
225pump step function used to pass data from the 225pump step function used to pass data from the
226server to the sink. Defaults to the LTN12 <tt>pump.step</tt> function;</li> 226server to the sink. Defaults to the LTN12 <tt>pump.step</tt> function;</li>
227<li><tt>create</tt>: An optional function to be used instead of 227<li><tt>create</tt>: An optional function to be used instead of
diff --git a/docs/http.html b/docs/http.html
index 52b8a30..c6423ba 100644
--- a/docs/http.html
+++ b/docs/http.html
@@ -52,7 +52,7 @@ implementation conforms to the HTTP/1.1 standard,
52The module exports functions that provide HTTP functionality in different 52The module exports functions that provide HTTP functionality in different
53levels of abstraction. From the simple 53levels of abstraction. From the simple
54string oriented requests, through generic 54string oriented requests, through generic
55<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> based, down to even lower-level if you bother to look through the source code. 55<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a> based, down to even lower-level if you bother to look through the source code.
56</p> 56</p>
57 57
58<p> 58<p>
@@ -144,7 +144,7 @@ http.<b>request{</b><br>
144The request function has two forms. The simple form downloads 144The request function has two forms. The simple form downloads
145a URL using the <tt>GET</tt> or <tt>POST</tt> method and is based 145a URL using the <tt>GET</tt> or <tt>POST</tt> method and is based
146on strings. The generic form performs any HTTP method and is 146on strings. The generic form performs any HTTP method and is
147<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> based. 147<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a> based.
148</p> 148</p>
149 149
150<p class="parameters"> 150<p class="parameters">
@@ -158,7 +158,7 @@ in the <tt>url</tt>. Otherwise, it performs a <tt>GET</tt> in the
158<p class="parameters"> 158<p class="parameters">
159If the first argument is instead a table, the most important fields are 159If the first argument is instead a table, the most important fields are
160the <tt>url</tt> and the <em>simple</em> 160the <tt>url</tt> and the <em>simple</em>
161<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 161<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
162<tt>sink</tt> that will receive the downloaded content. 162<tt>sink</tt> that will receive the downloaded content.
163Any part of the <tt>url</tt> can be overridden by including 163Any part of the <tt>url</tt> can be overridden by including
164the appropriate field in the request table. 164the appropriate field in the request table.
@@ -172,13 +172,13 @@ following:
172<li><tt>method</tt>: The HTTP request method. Defaults to "GET";</li> 172<li><tt>method</tt>: The HTTP request method. Defaults to "GET";</li>
173<li><tt>headers</tt>: Any additional HTTP headers to send with the request;</li> 173<li><tt>headers</tt>: Any additional HTTP headers to send with the request;</li>
174<li><tt>source</tt>: <em>simple</em> 174<li><tt>source</tt>: <em>simple</em>
175<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 175<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
176source to provide the request body. If there 176source to provide the request body. If there
177is a body, you need to provide an appropriate "<tt>content-length</tt>" 177is a body, you need to provide an appropriate "<tt>content-length</tt>"
178request header field, or the function will attempt to send the body as 178request header field, or the function will attempt to send the body as
179"<tt>chunked</tt>" (something few servers support). Defaults to the empty source;</li> 179"<tt>chunked</tt>" (something few servers support). Defaults to the empty source;</li>
180<li><tt>step</tt>: 180<li><tt>step</tt>:
181<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 181<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
182pump step function used to move data. 182pump step function used to move data.
183Defaults to the LTN12 <tt>pump.step</tt> function.</li> 183Defaults to the LTN12 <tt>pump.step</tt> function.</li>
184<li><tt>proxy</tt>: The URL of a proxy server to use. Defaults to no proxy;</li> 184<li><tt>proxy</tt>: The URL of a proxy server to use. Defaults to no proxy;</li>
diff --git a/docs/mime.html b/docs/mime.html
index ff4d8e8..600357b 100644
--- a/docs/mime.html
+++ b/docs/mime.html
@@ -54,7 +54,7 @@ MIME is described mainly in
54<p> 54<p>
55All functionality provided by the MIME module 55All functionality provided by the MIME module
56follows the ideas presented in 56follows the ideas presented in
57<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks"> 57<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">
58LTN012, Filters sources and sinks</a>. 58LTN012, Filters sources and sinks</a>.
59</p> 59</p>
60 60
diff --git a/docs/smtp.html b/docs/smtp.html
index 787d0b1..23e3184 100644
--- a/docs/smtp.html
+++ b/docs/smtp.html
@@ -57,7 +57,7 @@ of the MIME standard, but described mainly
57in <a href="http://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>.</p> 57in <a href="http://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>.</p>
58 58
59<p> In the description below, good understanding of <a 59<p> In the description below, good understanding of <a
60href="http://lua-users.org/wiki/FiltersSourcesAndSinks"> LTN012, Filters 60href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md"> LTN012, Filters
61sources and sinks</a> and the <a href="mime.html">MIME</a> module is 61sources and sinks</a> and the <a href="mime.html">MIME</a> module is
62assumed. In fact, the SMTP module was the main reason for their 62assumed. In fact, the SMTP module was the main reason for their
63creation. </p> 63creation. </p>
@@ -122,7 +122,7 @@ smtp.<b>message(</b>mesgt<b>)</b>
122 122
123<p class="description"> 123<p class="description">
124Returns a <em>simple</em> 124Returns a <em>simple</em>
125<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> source that sends an SMTP message body, possibly multipart (arbitrarily deep). 125<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a> source that sends an SMTP message body, possibly multipart (arbitrarily deep).
126</p> 126</p>
127 127
128<p class="parameters"> 128<p class="parameters">
@@ -155,7 +155,7 @@ multipart-mesgt = {<br>
155For a simple message, all that is needed is a set of <tt>headers</tt> 155For a simple message, all that is needed is a set of <tt>headers</tt>
156and the <tt>body</tt>. The message <tt>body</tt> can be given as a string 156and the <tt>body</tt>. The message <tt>body</tt> can be given as a string
157or as a <em>simple</em> 157or as a <em>simple</em>
158<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 158<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
159source. For multipart messages, the body is a table that 159source. For multipart messages, the body is a table that
160recursively defines each part as an independent message, plus an optional 160recursively defines each part as an independent message, plus an optional
161<tt>preamble</tt> and <tt>epilogue</tt>. 161<tt>preamble</tt> and <tt>epilogue</tt>.
@@ -163,7 +163,7 @@ recursively defines each part as an independent message, plus an optional
163 163
164<p class="return"> 164<p class="return">
165The function returns a <em>simple</em> 165The function returns a <em>simple</em>
166<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 166<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
167source that produces the 167source that produces the
168message contents as defined by <tt>mesgt</tt>, chunk by chunk. 168message contents as defined by <tt>mesgt</tt>, chunk by chunk.
169Hopefully, the following 169Hopefully, the following
@@ -264,7 +264,7 @@ The sender is given by the e-mail address in the <tt>from</tt> field.
264address, or a string 264address, or a string
265in case there is just one recipient. 265in case there is just one recipient.
266The contents of the message are given by a <em>simple</em> 266The contents of the message are given by a <em>simple</em>
267<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 267<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
268<tt>source</tt>. Several arguments are optional: 268<tt>source</tt>. Several arguments are optional:
269</p> 269</p>
270<ul> 270<ul>
@@ -276,7 +276,7 @@ methods if supported by the server (both are unsafe);</li>
276<li> <tt>domain</tt>: Domain name used to greet the server; Defaults to the 276<li> <tt>domain</tt>: Domain name used to greet the server; Defaults to the
277local machine host name;</li> 277local machine host name;</li>
278<li> <tt>step</tt>: 278<li> <tt>step</tt>:
279<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 279<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
280pump step function used to pass data from the 280pump step function used to pass data from the
281source to the server. Defaults to the LTN12 <tt>pump.step</tt> function;</li> 281source to the server. Defaults to the LTN12 <tt>pump.step</tt> function;</li>
282<li><tt>create</tt>: An optional function to be used instead of 282<li><tt>create</tt>: An optional function to be used instead of
@@ -308,7 +308,7 @@ Only recipients specified in the <tt>rcpt</tt> list will receive a copy of the
308message. Each recipient of an SMTP mail message receives a copy of the 308message. Each recipient of an SMTP mail message receives a copy of the
309message body along with the headers, and nothing more. The headers 309message body along with the headers, and nothing more. The headers
310<em>are</em> part of the message and should be produced by the 310<em>are</em> part of the message and should be produced by the
311<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 311<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
312<tt>source</tt> function. The <tt>rcpt</tt> list is <em>not</em> 312<tt>source</tt> function. The <tt>rcpt</tt> list is <em>not</em>
313part of the message and will not be sent to anyone. 313part of the message and will not be sent to anyone.
314</p> 314</p>
diff --git a/docs/socket.html b/docs/socket.html
index b4db823..983f1c9 100644
--- a/docs/socket.html
+++ b/docs/socket.html
@@ -311,7 +311,7 @@ socket.<b>sink(</b>mode, socket<b>)</b>
311 311
312<p class="description"> 312<p class="description">
313Creates an 313Creates an
314<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 314<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
315sink from a stream socket object. 315sink from a stream socket object.
316</p> 316</p>
317 317
@@ -386,7 +386,7 @@ socket.<b>source(</b>mode, socket [, length]<b>)</b>
386 386
387<p class="description"> 387<p class="description">
388Creates an 388Creates an
389<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 389<a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md">LTN12</a>
390source from a stream socket object. 390source from a stream socket object.
391</p> 391</p>
392 392