From 93eef5015e0dfe8d24071dd036f9a7f02160abeb Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Fri, 15 Mar 2024 12:55:02 +0100 Subject: [PATCH] chore(docs): update LTN12 links (#428) --- docs/ftp.html | 10 +++++----- docs/http.html | 10 +++++----- docs/mime.html | 2 +- docs/smtp.html | 14 +++++++------- docs/socket.html | 4 ++-- 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.

To really benefit from this module, a good understanding of - + LTN012, Filters sources and sinks is necessary.

@@ -122,7 +122,7 @@ expects at least the fields host, sink, and one of argument or path (argument takes precedence). Host is the server to connect to. Sink is the simple -LTN12 +LTN12 sink that will receive the downloaded data. Argument or path give the target path to the resource in the server. The optional arguments are the following: @@ -136,7 +136,7 @@ authentication. Defaults to "ftp:anonymous@anonymous.org";
  • type: The transfer mode. Can take values "i" or "a". Defaults to whatever is the server default;
  • step: -LTN12 +LTN12 pump step function used to pass data from the server to the sink. Defaults to the LTN12 pump.step function;
  • create: An optional function to be used instead of @@ -206,7 +206,7 @@ expects at least the fields host, source, and one of argument or path (argument takes precedence). Host is the server to connect to. Source is the simple -LTN12 +LTN12 source that will provide the contents to be uploaded. Argument or path give the target path to the resource in the server. The @@ -221,7 +221,7 @@ authentication. Defaults to "ftp:anonymous@anonymous.org";
  • type: The transfer mode. Can take values "i" or "a". Defaults to whatever is the server default;
  • step: -LTN12 +LTN12 pump step function used to pass data from the server to the sink. Defaults to the LTN12 pump.step function;
  • create: 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, The module exports functions that provide HTTP functionality in different levels of abstraction. From the simple string oriented requests, through generic -LTN12 based, down to even lower-level if you bother to look through the source code. +LTN12 based, down to even lower-level if you bother to look through the source code.

    @@ -144,7 +144,7 @@ http.request{
    The request function has two forms. The simple form downloads a URL using the GET or POST method and is based on strings. The generic form performs any HTTP method and is -LTN12 based. +LTN12 based.

    @@ -158,7 +158,7 @@ in the url. Otherwise, it performs a GET in the

    If the first argument is instead a table, the most important fields are the url and the simple -LTN12 +LTN12 sink that will receive the downloaded content. Any part of the url can be overridden by including the appropriate field in the request table. @@ -172,13 +172,13 @@ following:

  • method: The HTTP request method. Defaults to "GET";
  • headers: Any additional HTTP headers to send with the request;
  • source: simple -LTN12 +LTN12 source to provide the request body. If there is a body, you need to provide an appropriate "content-length" request header field, or the function will attempt to send the body as "chunked" (something few servers support). Defaults to the empty source;
  • step: -LTN12 +LTN12 pump step function used to move data. Defaults to the LTN12 pump.step function.
  • proxy: The URL of a proxy server to use. Defaults to no proxy;
    • 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

    All functionality provided by the MIME module follows the ideas presented in - + LTN012, Filters sources and sinks.

    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 in RFC 2046.

    In the description below, good understanding of LTN012, Filters +href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md"> LTN012, Filters sources and sinks and the MIME module is assumed. In fact, the SMTP module was the main reason for their creation.

    @@ -122,7 +122,7 @@ smtp.message(mesgt)

    Returns a simple -LTN12 source that sends an SMTP message body, possibly multipart (arbitrarily deep). +LTN12 source that sends an SMTP message body, possibly multipart (arbitrarily deep).

    @@ -155,7 +155,7 @@ multipart-mesgt = {
    For a simple message, all that is needed is a set of headers and the body. The message body can be given as a string or as a simple -LTN12 +LTN12 source. For multipart messages, the body is a table that recursively defines each part as an independent message, plus an optional preamble and epilogue. @@ -163,7 +163,7 @@ recursively defines each part as an independent message, plus an optional

    The function returns a simple -LTN12 +LTN12 source that produces the message contents as defined by mesgt, chunk by chunk. Hopefully, the following @@ -264,7 +264,7 @@ The sender is given by the e-mail address in the from field. address, or a string in case there is just one recipient. The contents of the message are given by a simple -LTN12 +LTN12 source. Several arguments are optional: