Browse Source

Update to FTP dtask documentation

Submitted by:	Glenn McAllister <glennm@ca.ibm.com>


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@267942 13f79535-47bb-0310-9956-ffa450edef68
master
Conor MacNeill 25 years ago
parent
commit
bec067e804
1 changed files with 71 additions and 11 deletions
  1. +71
    -11
      docs/index.html

+ 71
- 11
docs/index.html View File

@@ -3859,10 +3859,9 @@ output.</p>
<hr>
<h2><a name="ftp">FTP</a></h2>
<h3><b>Description:</b></h3>
<p>Copies files from the local system to a remote ftp server.</p>
<p>The <a href="#fileset"><code>fileset</code></a> syntax must be used for specifying the local
files to copy. All filesets will be copied into the single remote directory
specified by <i>remotedir</i>.</p>
<p>The ftp task implements a basic FTP client that can send, receive,
list, and delete files. See below for descriptions and examples of how
to perform each task.</p>
<p>The ftp task makes no attempt to determine what file system syntax is
required by the remote server, and defaults to Unix standards.
<i>remotedir</i> must be specified in the exact syntax required by the ftp
@@ -3908,8 +3907,9 @@ write patterns.</p>
</tr>
<tr>
<td valign="top">action</td>
<td valign="top">the ftp action to perform.
Current only supports&quot;put&quot;</td>
<td valign="top">the ftp action to perform, defaulting to &quot;send&quot;.
Currently supports&quot;put&quot;, &quot;get&quot;,
&quot;del&quot;, and &quot;list&quot;.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -3942,14 +3942,22 @@ write patterns.</p>
Defaults to &quot;/&quot;.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">listing</td>
<td valign="top">the file to write results of the &quot;list&quot; action.
Required for the &quot;list&quot; action, ignored otherwise.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h3>Examples</h3>
<pre> &lt;ftp server=&quot;ftp.apache.org&quot;
<h3>Sending Files</h3>
<p>The easiest way to describe how to send files is with a couple of examples:</p>
<pre>
&lt;ftp server=&quot;ftp.apache.org&quot;
userid=&quot;anonymous&quot;
password=&quot;me@myorg.com&quot;
&gt;
password=&quot;me@myorg.com&quot;&gt;
&lt;fileset dir=&quot;htdocs/manual&quot; /&gt;
&lt;/ftp&gt;</pre>
&lt;/ftp&gt;
</pre>
<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
uploads all files in the <code>htdocs/manual</code> directory
to the default directory for that user.</p>
@@ -3998,6 +4006,58 @@ mode.</p>
HTML files in the <code>htdocs/manual</code> directory to the
<code>c:\uploads</code> directory. Progress messages are displayed as each
file is uploaded.</p>
<h3>Getting Files</h3>
<p>Getting files from an FTP server works pretty much the same way as
sending them does. The only difference is that the nested filesets
use the remotedir attribute as the base directory for the files on the
FTP server, and the dir attribute as the local directory to put the files
into. The file structure from the FTP site is preserved on the local machine.</p>
<pre>
&lt;ftp action="get"
server=&quot;ftp.apache.org&quot;
userid=&quot;anonymous&quot;
password=&quot;me@myorg.com&quot;&gt;
&lt;fileset dir=&quot;htdocs/manual&quot; &gt;
&lt;include name=&quot;**/*.html&quot; /&gt;
&lt;/fileset&gt;
&lt;/ftp&gt;
</pre>
<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
recursively downloads all .html files from default directory for that user
into the <code>htdocs/manual</code> directory on the local machine.</p>
<h3>Deleting Files</h3>
As you've probably guessed by now, you use nested fileset elements to
select the files to delete from the remote FTP server. Again, the
filesets are relative to the remote directory, not a local directory. In
fact, the dir attribute of the fileset is ignored completely.
<pre>
&lt;ftp action="del"
server=&quot;ftp.apache.org&quot;
userid=&quot;anonymous&quot;
password=&quot;me@myorg.com&quot; &gt;
&lt;fileset&gt;
&lt;include name=&quot;**/*.tmp&quot; /&gt;
&lt;/fileset&gt;
&lt;/ftp&gt;
</pre>
<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
tries to delete all *.tmp files from the default directory for that user.
If you don't have permission to delete a file, a BuildException is thrown.</p>
<h3>Listing Files</h3>
<pre>
&lt;ftp action="list"
server=&quot;ftp.apache.org&quot;
userid=quot;anonymous&quot;
password=&quot;me@myorg.com&quot;
listing=&quot;data/ftp.listing&quot; &gt;
&lt;fileset&gt;
&lt;include name=&quot;**&quot; /&gt;
&lt;/fileset&gt;
&lt;/ftp&gt;
</pre>
<p>This provides a file listing in <code>data/ftp.listing</code> of all the files on
the FTP server relative to the default directory of the <code>anonymous</code>
user.  The listing is in whatever format the FTP server normally lists files.</p>
<hr>
<h2><a name="netrexxc">NetRexxC</a></h2>
<h3><b>Description:</b></h3>


Loading…
Cancel
Save