diff options
Diffstat (limited to 'doc/ftp.html')
| -rw-r--r-- | doc/ftp.html | 23 |
1 files changed, 16 insertions, 7 deletions
diff --git a/doc/ftp.html b/doc/ftp.html index 9fda02b..7ad5e4d 100644 --- a/doc/ftp.html +++ b/doc/ftp.html | |||
| @@ -54,7 +54,8 @@ To really benefit from this module, a good understanding of | |||
| 54 | LTN012, Filters sources and sinks</a> is necessary. | 54 | LTN012, Filters sources and sinks</a> is necessary. |
| 55 | </p> | 55 | </p> |
| 56 | 56 | ||
| 57 | <p class=description> To obtain the <tt>ftp</tt> namespace, run: | 57 | <p> |
| 58 | To obtain the <tt>ftp</tt> namespace, run: | ||
| 58 | </p> | 59 | </p> |
| 59 | 60 | ||
| 60 | <pre class=example> | 61 | <pre class=example> |
| @@ -99,7 +100,7 @@ ftp.<b>get{</b><br> | |||
| 99 | [command = <i>string</i>,]<br> | 100 | [command = <i>string</i>,]<br> |
| 100 | [port = <i>number</i>,]<br> | 101 | [port = <i>number</i>,]<br> |
| 101 | [type = <i>string</i>,]<br> | 102 | [type = <i>string</i>,]<br> |
| 102 | [step = <i>LTN12 pump step</i>],<br> | 103 | [step = <i>LTN12 pump step</i>,]<br> |
| 103 | <b>}</b> | 104 | <b>}</b> |
| 104 | </p> | 105 | </p> |
| 105 | 106 | ||
| @@ -115,7 +116,9 @@ If the argument of the <tt>get</tt> function is a table, the function | |||
| 115 | expects at least the fields <tt>host</tt>, <tt>sink</tt>, and one of | 116 | expects at least the fields <tt>host</tt>, <tt>sink</tt>, and one of |
| 116 | <tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes | 117 | <tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes |
| 117 | precedence). <tt>Host</tt> is the server to connect to. <tt>Sink</tt> is | 118 | precedence). <tt>Host</tt> is the server to connect to. <tt>Sink</tt> is |
| 118 | the <em>simple</em> LTN12 sink that will receive the downloaded data. <tt>Argument</tt> or | 119 | the <em>simple</em> |
| 120 | <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> | ||
| 121 | sink that will receive the downloaded data. <tt>Argument</tt> or | ||
| 119 | <tt>path</tt> give the target path to the resource in the server. The | 122 | <tt>path</tt> give the target path to the resource in the server. The |
| 120 | optional arguments are the following: | 123 | optional arguments are the following: |
| 121 | </p> | 124 | </p> |
| @@ -127,7 +130,9 @@ authentication. Defaults to "<tt>ftp:anonymous@anonymous.org</tt>"; | |||
| 127 | <li><tt>port</tt>: The port to used for the control connection. Defaults to 21; | 130 | <li><tt>port</tt>: The port to used for the control connection. Defaults to 21; |
| 128 | <li><tt>type</tt>: The transfer mode. Can take values "<tt>i</tt>" or | 131 | <li><tt>type</tt>: The transfer mode. Can take values "<tt>i</tt>" or |
| 129 | "<tt>a</tt>". Defaults to whatever is the server default; | 132 | "<tt>a</tt>". Defaults to whatever is the server default; |
| 130 | <li><tt>step</tt>: LTN12 pump step function used to pass data from the | 133 | <li><tt>step</tt>: |
| 134 | <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> | ||
| 135 | pump step function used to pass data from the | ||
| 131 | server to the sink. Defaults to the LTN12 <tt>pump.step</tt> function. | 136 | server to the sink. Defaults to the LTN12 <tt>pump.step</tt> function. |
| 132 | </ul> | 137 | </ul> |
| 133 | 138 | ||
| @@ -177,7 +182,7 @@ ftp.<b>put{</b><br> | |||
| 177 | [command = <i>string</i>,]<br> | 182 | [command = <i>string</i>,]<br> |
| 178 | [port = <i>number</i>,]<br> | 183 | [port = <i>number</i>,]<br> |
| 179 | [type = <i>string</i>,]<br> | 184 | [type = <i>string</i>,]<br> |
| 180 | [step = <i>LTN12 pump step</i>],<br> | 185 | [step = <i>LTN12 pump step</i>,]<br> |
| 181 | <b>}</b> | 186 | <b>}</b> |
| 182 | </p> | 187 | </p> |
| 183 | 188 | ||
| @@ -192,7 +197,9 @@ If the argument of the <tt>put</tt> function is a table, the function | |||
| 192 | expects at least the fields <tt>host</tt>, <tt>source</tt>, and one of | 197 | expects at least the fields <tt>host</tt>, <tt>source</tt>, and one of |
| 193 | <tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes | 198 | <tt>argument</tt> or <tt>path</tt> (<tt>argument</tt> takes |
| 194 | precedence). <tt>Host</tt> is the server to connect to. <tt>Source</tt> is | 199 | precedence). <tt>Host</tt> is the server to connect to. <tt>Source</tt> is |
| 195 | the <em>simple</em> LTN12 source that will provide the contents to be uploaded. | 200 | the <em>simple</em> |
| 201 | <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> | ||
| 202 | source that will provide the contents to be uploaded. | ||
| 196 | <tt>Argument</tt> or | 203 | <tt>Argument</tt> or |
| 197 | <tt>path</tt> give the target path to the resource in the server. The | 204 | <tt>path</tt> give the target path to the resource in the server. The |
| 198 | optional arguments are the following: | 205 | optional arguments are the following: |
| @@ -205,7 +212,9 @@ authentication. Defaults to "<tt>ftp:anonymous@anonymous.org</tt>"; | |||
| 205 | <li><tt>port</tt>: The port to used for the control connection. Defaults to 21; | 212 | <li><tt>port</tt>: The port to used for the control connection. Defaults to 21; |
| 206 | <li><tt>type</tt>: The transfer mode. Can take values "<tt>i</tt>" or | 213 | <li><tt>type</tt>: The transfer mode. Can take values "<tt>i</tt>" or |
| 207 | "<tt>a</tt>". Defaults to whatever is the server default; | 214 | "<tt>a</tt>". Defaults to whatever is the server default; |
| 208 | <li><tt>step</tt>: LTN12 pump step function used to pass data from the | 215 | <li><tt>step</tt>: |
| 216 | <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> | ||
| 217 | pump step function used to pass data from the | ||
| 209 | server to the sink. Defaults to the LTN12 <tt>pump.step</tt> function. | 218 | server to the sink. Defaults to the LTN12 <tt>pump.step</tt> function. |
| 210 | </ul> | 219 | </ul> |
| 211 | 220 | ||
