conor 00/08/30 07:00:20
Modified: docs index.html
Log:
Update to FTP dtask documentation
Submitted by: Glenn McAllister <[EMAIL PROTECTED]>
Revision Changes Path
1.83 +71 -11 jakarta-ant/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/index.html,v
retrieving revision 1.82
retrieving revision 1.83
diff -u -r1.82 -r1.83
--- index.html 2000/08/21 14:41:11 1.82
+++ index.html 2000/08/30 14:00:17 1.83
@@ -3859,10 +3859,9 @@
<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 @@
</tr>
<tr>
<td valign="top">action</td>
- <td valign="top">the ftp action to perform.
- Current only supports"put"</td>
+ <td valign="top">the ftp action to perform, defaulting to
"send".
+ Currently supports"put", "get",
+ "del", and "list".</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -3942,14 +3942,22 @@
Defaults to "/".</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 "list"
action.
+ Required for the "list" action, ignored
otherwise.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
</table>
-<h3>Examples</h3>
-<pre> <ftp server="ftp.apache.org"
+<h3>Sending Files</h3>
+<p>The easiest way to describe how to send files is with a couple of
examples:</p>
+<pre>
+ <ftp server="ftp.apache.org"
userid="anonymous"
- password="[EMAIL PROTECTED]"
- >
+ password="[EMAIL PROTECTED]">
<fileset dir="htdocs/manual" />
- </ftp></pre>
+ </ftp>
+</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 @@
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>
+ <ftp action="get"
+ server="ftp.apache.org"
+ userid="anonymous"
+ password="[EMAIL PROTECTED]">
+ <fileset dir="htdocs/manual" >
+ <include name="**/*.html" />
+ </fileset>
+ </ftp>
+</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>
+ <ftp action="del"
+ server="ftp.apache.org"
+ userid="anonymous"
+ password="[EMAIL PROTECTED]" >
+ <fileset>
+ <include name="**/*.tmp" />
+ </fileset>
+ </ftp>
+</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>
+ <ftp action="list"
+ server="ftp.apache.org"
+ userid=quot;anonymous"
+ password="[EMAIL PROTECTED]"
+ listing="data/ftp.listing" >
+ <fileset>
+ <include name="**" />
+ </fileset>
+ </ftp>
+</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>
