scohen 2005/05/22 11:49:46
Modified: docs/manual/OptionalTasks ftp.html
Log:
Document new timestampGranularity attribute and spiff up the page generally,
add links to Java code as
appropriate, fix up the table column sizing which had become rather unwieldy.
Revision Changes Path
1.36 +53 -21 ant/docs/manual/OptionalTasks/ftp.html
Index: ftp.html
===================================================================
RCS file: /home/cvs/ant/docs/manual/OptionalTasks/ftp.html,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- ftp.html 21 May 2005 13:02:02 -0000 1.35
+++ ftp.html 22 May 2005 18:49:46 -0000 1.36
@@ -39,9 +39,9 @@
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <td valign="top" width="15%"><b>Attribute</b></td>
+ <td valign="top" width="65%"><b>Description</b></td>
+ <td align="center" valign="top" width="20%"><b>Required</b></td>
</tr>
<tr>
<td valign="top">server</td>
@@ -119,10 +119,30 @@
Since ant 1.6</td>
<td valign="top" align="center">No</td>
</tr>
+ <a name="timestampGranularity"/>
+ <tr>
+ <td valign="top">timestampGranularity</td>
+ <td valign="top">Specify either <code>MINUTE</code>, <code>NONE</code>,
+ (or you may specify <code>""</code> which is equivalent to not
specifying a value,
+ useful for property-file driven scripts). Allows override of the
typical situation
+ in PUT and GET where local filesystem timestamps are
<code>HH:mm:ss</code>
+ and the typical FTP server's timestamps are <code>HH:mm</code>. This
can throw
+ off uptodate calculations. However, the default values should suffice
for most
+ applications.<br>
+ Since ant 1.7
+ </td>
+ <td valign="top" align="center">No. Only applies in "puts" and "gets"
where the
+ default values are <code>MINUTE</code> for PUT and <code>NONE</code> for
GET.
+ (It is not as necessary in GET because we have the
<b>preservelastmodified</b> option.)</td>
+ </tr>
<tr>
<td valign="top">timediffmillis</td>
- <td valign="top">number of milliseconds to add to the time on the remote
machine
- to get the time on the local machine.<br>
+ <td valign="top"><b>Deprecated</b>. Number of milliseconds to add to the
time on
+ the remote machine to get the time on the local machine. The
<b>timestampGranularity</b>
+ attribute (for which the default values should suffice in most
situations), and the
+ <b>serverTimeZoneConfig</b> option, should make this unnecessary.
+ <b>serverTimeZoneConfig</b> does the math for you and also knows about
+ Daylight Savings Time.<br>
Since ant 1.6
</td>
<td valign="top" align="center">No</td>
@@ -209,7 +229,8 @@
Supported values are <code>"UNIX", "VMS", "WINDOWS", "OS/2", "OS/400",
"MVS".</code> If not specified, (or specified as <code>""</code>) and
if
no other xxxConfig attributes are specified, the autodectection
mechanism
- based on the FTP SYST command will be used.
+ based on the FTP SYST command will be used.<br>
+ Since ant 1.7
</td>
<td valign="top" align="center">No, but if any of the following xxxConfig
attributes is specified, UNIX will be assumed, even if
<code>""</code>
@@ -218,25 +239,31 @@
</tr>
<tr>
<td valign="top">serverTimeZoneConfig</td>
- <td valign="top">Specify as a <code>java.util.Timezone</code> identifier
- (e.g. <code>GMT</code>, <code>America/Chicago</code> or
- <code>Asia/Jakarta</code>) the timezone
- used by the server for timestamps. This enables Ant timestamp
dependency
- checking even when the server is in a different timezone than the
client.
- If not specified, (or specified as <code>""</code>), the timezone of
the
- client is assumed.
+ <td valign="top">Specify as a Java
+ <a
href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/TimeZone.html";>
+ TimeZone</a> identifier, (e.g. <code>GMT</code>,
<code>America/Chicago</code> or
+ <code>Asia/Jakarta</code>) the timezone used by the server for
timestamps. This
+ enables timestamp dependency checking even when the server is in a
different
+ time zone from the client. Time Zones know, also, about daylight
savings time,
+ and do not require you to calculate milliseconds of difference. If
not specified,
+ (or specified as <code>""</code>), the time zone of the client is
assumed.<br>
+ Since ant 1.7
</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
+
<td valign="top">defaultDateFormatConfig</td>
- <td valign="top">Specify in java.text.SimpleDateFormat notation, (e.g.
- <code>yyyy-MM-dd</code>) the date format generally used by the FTP server
+ <td valign="top">Specify in Java
+ <a
href="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html";>
+ SimpleDateFormat</a> notation, (e.g.
+ <code>yyyy-MM-dd</code>), the date format generally used by the FTP
server
to parse dates. In some cases this will be the only date format used.
In others, (unix for example) this will be used for dates
- older than a year old. (See recentDateFormatConfig). If not specified,
+ older than a year old. (See <b>recentDateFormatConfig</b>). If not
specified,
(or specified as <code>""</code>), the default date format for the
system
- type indicated by the systemTypeKey attribute will be used.
+ type indicated by the <b>systemTypeKey</b> attribute will be used.<br>
+ Since ant 1.7
</td>
<td valign="top" align="center">
No.
@@ -244,11 +271,14 @@
</tr>
<tr>
<td valign="top">recentDateFormatConfig</td>
- <td valign="top">Specify in java.text.SimpleDateFormat notation,
+ <td valign="top">Specify in Java
+ <a
href="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html";>
+ SimpleDateFormat</a> notation,
(e.g. <code>MMM dd hh:mm</code>) the date format used by the FTP server
to parse dates less than a year old. If not specified (or specified as
<code>""</code>), and if the system type indicated by the system key
uses
- a recent date format, its standard format will be used.
+ a recent date format, its standard format will be used.<br>
+ Since ant 1.7
</td>
<td valign="top" align="center">No</td>
</tr>
@@ -280,7 +310,8 @@
<li>sl - Slovenian</li>
</ul>
If you require a language other than the above, see also the
- shortMonthNamesConfig attribute.
+ <b>shortMonthNamesConfig</b> attribute.<br>
+ Since ant 1.7
</td>
<td valign="top" align="center">No</td>
@@ -293,7 +324,8 @@
Icelandic FTP server might conceivably be specified as
<code>"jan|feb|mar|apr|maí|jún|júl|ágú|sep|okt|nóv|des"</code>.
This attribute exists primarily to support languages not supported by
- the serverLanguageCode attribute.
+ the <b>serverLanguageCode</b> attribute.<br>
+ Since ant 1.7
</td>
<td valign="top" align="center">No</td>
</tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
