You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2018/02/28 07:01:37 UTC
[22/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/tar.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/tar.html b/manual/Tasks/tar.html
index aa7a644..c16041c 100644
--- a/manual/Tasks/tar.html
+++ b/manual/Tasks/tar.html
@@ -27,179 +27,158 @@
<h2 id="tar">Tar</h2>
<h3>Description</h3>
<p>Creates a tar archive.</p>
-<p>The <i>basedir</i> attribute is the reference directory from where to tar.</p>
-<p>This task is a <a href="../dirtasks.html#directorybasedtasks">directory based task</a>
-and, as such, forms an implicit <a href="../Types/fileset.html">Fileset</a>. This
-defines which files, relative to the <i>basedir</i>, will be included in the
-archive. The tar task supports all the attributes of Fileset to refine the
-set of files to be included in the implicit fileset.</p>
-
-<p>In addition to the implicit fileset, the tar task supports nested
- resource collections and a special form of filesets. These
-filesets are extended to allow control over the access mode, username and groupname
-to be applied to the tar entries. This is useful, for example, when preparing archives for
- Unix systems where some files need to have execute permission. By
- default this task will use Unix permissions of 644 for files and 755
- for directories.</p>
-
-<p>Early versions of tar did not support path lengths greater than 100
- characters. Over time several incompatible extensions have been
- developed until a new POSIX standard was created that added so
- called PAX extension headers (as the pax utility first introduced
- them) that among another things addressed file names longer than 100
- characters. All modern implementations of tar support PAX extension
- headers.</p>
-
-<p>Ant's tar support predates the standard with PAX extension headers,
- it supports different dialects that can be enabled using the
- <i>longfile</i> attribute.
-If the longfile attribute is set to <code>fail</code>, any long paths will
-cause the tar task to fail. If the longfile attribute is set to
-<code>truncate</code>, any long paths will be truncated to the 100 character
-maximum length prior to adding to the archive. If the value of the longfile
-attribute is set to <code>omit</code> then files containing long paths will be
-omitted from the archive. Either option ensures that the archive can be
-untarred by any compliant version of tar.</p>
-
-<p>If the loss of path or file
-information is not acceptable, and it rarely is, longfile may be set to the
-value <code>gnu</code> or <code>posix</code>. With <code>posix</code>
- Ant will add PAX extension headers, with <code>gnu</code> it adds
- GNU tar specific extensions that newer versions of GNU tar call
- "oldgnu". GNU tar still creates these extensions by default but
- supports PAX extension headers as well. Either choice will produce
- a tar file which
-can have arbitrary length paths. Note however, that the resulting archive will
-only be able to be untarred with tar tools that support the chosen format.
-
-<p>The default for the longfile
-attribute is <code>warn</code> which behaves just like the gnu option except
-that it produces a warning for each file path encountered that does not match
-the limit. It uses gnu rather than posix for backwards compatibility
- reasons.</p>
-
-<p>To achieve best interoperability you should use
- either <code>fail</code> or <code>posix</code> for the longfile attribute.</p>
-
-<p>This task can perform compression by setting the compression attribute to "gzip"
-or "bzip2".</p>
+<p>The <var>basedir</var> attribute is the reference directory from where to tar.</p>
+<p>This task is a <a href="../dirtasks.html#directorybasedtasks">directory based task</a> and, as
+such, forms an implicit <a href="../Types/fileset.html">Fileset</a>. This defines which files,
+relative to the <var>basedir</var>, will be included in the archive. The <code>tar</code> task
+supports all the attributes of Fileset to refine the set of files to be included in the implicit
+fileset.</p>
+
+<p>In addition to the implicit fileset, the <code>tar</code> task supports nested resource
+collections and a special form of filesets. These filesets are extended to allow control over the
+access mode, username and groupname to be applied to the tar entries. This is useful, for example,
+when preparing archives for Unix systems where some files need to have execute permission. By
+default this task will use Unix permissions of 644 for files and 755 for directories.</p>
+
+<p>Early versions of <code>tar</code> utility did not support paths longer than 100 characters. Over
+time several incompatible extensions have been developed until a new POSIX standard was created that
+added so called PAX extension headers (as the <code>pax</code> utility first introduced them) that
+among another things addressed file names longer than 100 characters. All modern implementations of
+tar support PAX extension headers.</p>
+
+<p>Ant's tar support predates the standard with PAX extension headers, it supports different
+dialects that can be enabled using the <var>longfile</var> attribute. If the <var>longfile</var>
+attribute is set to <q>fail</q>, any long paths will cause the tar task to fail. If
+the <var>longfile</var> attribute is set to <q>truncate</q>, any long paths will be truncated to the
+100 character maximum length prior to adding to the archive. If the value of the <var>longfile</var>
+attribute is set to <q>omit</q> then files containing long paths will be omitted from the archive.
+Either option ensures that the archive can be untarred by any compliant version of tar.</p>
+
+<p>If the loss of path or file information is not acceptable, and it rarely is, <var>longfile</var>
+may be set to the value <q>gnu</q> or <q>posix</q>. With <q>posix</q> Ant will add PAX extension
+headers, with <q>gnu</q> it adds GNU tar specific extensions that newer versions of GNU tar
+call <q>oldgnu</q>. GNU tar still creates these extensions by default but supports PAX extension
+headers as well. Either choice will produce a tar file which can have arbitrary length paths. Note
+however, that the resulting archive will only be able to be untarred with tar tools that support the
+chosen format.</p>
+
+<p>The default for the <var>longfile</var> attribute is <q>warn</q> which behaves just like
+the <q>gnu</q> option except that it produces a warning for each filepath encountered that does not
+match the limit. It uses <q>gnu</q> rather than <q>posix</q> for backwards compatibility
+reasons.</p>
+
+<p>To achieve best interoperability you should use either <q>fail</q> or <q>posix</q> for
+the <var>longfile</var> attribute.</p>
+
+<p>This task can perform compression by setting the <var>compression</var> attribute
+to <q>gzip</q>, <q>bzip2</q>, or <q>xz</q>.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top" align="center"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">destfile</td>
- <td valign="top">the tar-file to create.</td>
- <td align="center" valign="top">Yes</td>
+ <td>destfile</td>
+ <td>the tar file to create.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">basedir</td>
- <td valign="top">the directory from which to tar the files.</td>
- <td align="center" valign="top">No</td>
+ <td>basedir</td>
+ <td>the directory from which to tar the files.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">longfile</td>
- <td valign="top">Determines how long files (>100 chars) are to be
- handled. Allowable values are "truncate", "fail",
- "warn", "omit", "gnu" and "posix". Default is
- "warn".</td>
- <td valign="top" align="center">No</td>
+ <td>longfile</td>
+ <td>Determines how long filenames (> 100 chars) are to be handled. Allowed values
+ are <q>truncate</q>, <q>fail</q>, <q>warn</q>, <q>omit</q>, <q>gnu</q> and <q>posix</q>.</td>
+ <td>No; default is <q>warn</q></td>
</tr>
<tr>
- <td valign="top">includes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- included. All files are included when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>includes</td>
+ <td>comma- or space-separated list of patterns of files that must be included.</td>
+ <td>No; defaults to all (<q>**</q>)</td>
</tr>
<tr>
- <td valign="top">includesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an include pattern</td>
- <td valign="top" align="center">No</td>
+ <td>includesfile</td>
+ <td>name of a file. Each line of this file is taken to be an include pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">excludes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- excluded. No files (except default excludes) are excluded when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>excludes</td>
+ <td>comma- or space-separated list of patterns of files that must be excluded.</td>
+ <td>No; defaults to default excludes or none if <var>defaultexcludes</var> is <q>no</q></td>
</tr>
<tr>
- <td valign="top">excludesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an exclude pattern</td>
- <td valign="top" align="center">No</td>
+ <td>excludesfile</td>
+ <td>name of a file. Each line of this file is taken to be an exclude pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top">indicates whether default excludes should be used or not
- ("yes"/"no"). Default excludes are used when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
+ <td>No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">compression</td>
- <td valign="top">compression method. Allowable values are
- "none", "gzip", "xz" and "bzip2". Default is
- "none".</td>
- <td valign="top" align="center">No</td>
+ <td>compression</td>
+ <td>compression method. Allowable values are <q>none</q>, <q>gzip</q>, <q>xz</q>
+ and <q>bzip2</q>.</td>
+ <td>No; default is <q>warn</q></td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">The character encoding to use for filenames
- inside the tar file. For a list of possible values see the <a
- href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>.<br/>
- Defaults to the platform's default character encoding.
- <em>Since Ant 1.9.5</em>
- <td align="center" valign="top">No</td>
+ <td>encoding</td>
+ <td>The character encoding to use for filenames inside the tar file. For a list of possible
+ values see
+ the <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Supported
+ Encodings</a>.<br/><em>Since Ant 1.9.5</em>
+ <td>No; defaults to default JVM character encoding</td>
</tr>
</table>
<h3>Nested Elements</h3>
-The tar task supports nested <a
-href="../Types/tarfileset.html">tarfileset</a> elements. These are
-extended <a href="../Types/fileset.html">FileSets</a> which,
-in addition to the standard elements, support one additional
-attributes
+<p>The tar task supports nested <a href="../Types/tarfileset.html">tarfileset</a> elements. These
+are extended <a href="../Types/fileset.html">FileSets</a> which, in addition to the standard
+elements, support one additional attributes</p>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top" align="center"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">preserveLeadingSlashes</td>
- <td valign="top">Indicates whether leading `/'s should
- be preserved in the file names. Default is <code>false</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>preserveLeadingSlashes</td>
+ <td>Indicates whether leading <q>/</q> should be preserved in the file names.</td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
<h4>any other resource collection</h4>
-<p><a href="../Types/resources.html#collection">Resource
-Collection</a>s are used to select groups of files to archive.</p>
-<p>Prior to Apache Ant 1.7 only <code><fileset></code> has been
-supported as a nested element.</p>
+<p><a href="../Types/resources.html#collection">Resource Collection</a>s are used to select groups
+of files to archive.</p>
+<p>Prior to Apache Ant 1.7 only <code><fileset></code> has been supported as a nested
+element.</p>
<h3>Examples</h3>
<pre>
<tar destfile="${dist}/manual.tar" basedir="htdocs/manual"/>
<gzip destfile="${dist}/manual.tar.gz" src="${dist}/manual.tar"/></pre>
-<p>tars all files in the <code>htdocs/manual</code> directory into a file called <code>manual.tar</code>
-in the <code>${dist}</code> directory, then applies the gzip task to compress
-it.</p>
+
+<p>tars all files in the <samp>htdocs/manual</samp> directory into a file
+called <samp>manual.tar</samp> in the <samp>${dist}</samp> directory, then applies
+the <code>gzip</code> task to compress it.</p>
<pre>
<tar destfile="${dist}/manual.tar"
basedir="htdocs/manual"
excludes="mydocs/**, **/todo.html"/></pre>
-<p>tars all files in the <code>htdocs/manual</code> directory into a file called <code>manual.tar</code>
-in the <code>${dist}</code> directory. Files in the directory <code>mydocs</code>,
-or files with the name <code>todo.html</code> are excluded.</p>
+
+<p>tars all files in the <samp>htdocs/manual</samp> directory into a file
+called <samp>manual.tar</samp> in the <samp>${dist}</samp> directory. Files in the
+directory <samp>mydocs</samp>, or files with the name <samp>todo.html</samp> are excluded.</p>
<pre>
<tar destfile="${basedir}/docs.tar">
@@ -214,14 +193,11 @@ or files with the name <code>todo.html</code> are excluded.</p>
<include name="*.html"/>
</tarfileset>
</tar></pre>
-<p>
- Writes the file <code>docs/readme.txt</code> as
- <code>/usr/doc/ant/README</code> into the archive. All
- <code>*.html</code> files in the <code>docs</code> directory are
- prefixed by <code>/usr/doc/ant</code>, so for example
- <code>docs/index.html</code> is written as
- <code>/usr/doc/ant/index.html</code> to the archive.
-</p>
+
+<p>Writes the file <samp>docs/readme.txt</samp> as <samp>/usr/doc/ant/README</samp> into the
+archive. All <samp>*.html</samp> files in the <samp>docs</samp> directory are prefixed
+by <samp>/usr/doc/ant</samp>, so for example <samp>docs/index.html</samp> is written
+as <samp>/usr/doc/ant/index.html</samp> to the archive.</p>
<pre>
<tar longfile="gnu"
@@ -235,43 +211,35 @@ or files with the name <code>todo.html</code> are excluded.</p>
<exclude name="${dist.name}/bootstrap.sh"/>
<exclude name="${dist.name}/build.sh"/>
</tarfileset>
-</tar>
-</pre>
-<p>This example shows building a tar which uses the GNU extensions for long paths and
-where some files need to be marked as executable (mode 755)
-and the rest are use the default mode (read-write by owner). The first
-fileset selects just the executable files. The second fileset must exclude
-the executable files and include all others.</p>
+</tar></pre>
-<p><strong>Note</strong>: The tar task does not ensure that a file is only selected
-by one resource collection. If the same file is selected by more than one collection, it will be included in the
-tar file twice, with the same path.</p>
+<p>This example shows building a tar which uses the GNU extensions for long paths and where some
+files need to be marked as executable (mode 755) and the rest are use the default mode (read-write
+by owner). The first fileset selects just the executable files. The second fileset must exclude the
+executable files and include all others.</p>
-<p><strong>Note</strong>: The patterns in the include and exclude
-elements are considered to be relative to the corresponding dir
-attribute as with all other filesets. In the example above,
-<code>${dist.name}</code> is not an absolute path, but a simple name
-of a directory, so <code>${dist.name}</code> is a valid path relative
-to <code>${dist.name}/..</code>.</p>
+<p><strong>Note</strong>: The <code>tar</code> task does not ensure that a file is only selected by
+one resource collection. If the same file is selected by more than one collection, it will be
+included in the tar file twice, with the same path.</p>
+<p><strong>Note</strong>: The patterns in the <code>include</code> and <code>exclude</code> elements
+are considered to be relative to the corresponding <var>dir</var> attribute as with all other
+filesets. In the example above, <samp>${dist.name}</samp> is not an absolute path, but a simple
+name of a directory, so <samp>${dist.name}</samp> is a valid path relative
+to <samp>${dist.name}/..</samp>.</p>
<pre>
<tar destfile="release.tar.gz" compression="gzip">
<zipfileset src="release.zip"/>
-</tar>
-</pre>
-<p>Re-packages a ZIP archive as a GZip compressed tar archive. If
-Unix file permissions have been stored as part of the ZIP file, they
-will be retained in the resulting tar archive.</p>
+</tar></pre>
+<p>Re-packages a ZIP archive as a GZip compressed tar archive. If Unix file permissions have been
+stored as part of the ZIP file, they will be retained in the resulting tar archive.</p>
-<p><strong>Note</strong>:
- Please note the tar task creates a tar file, it does not append
- to an existing tar file. The existing tar file is replaced instead.
- As with most tasks in Ant, the task only takes action if the output
- file (the tar file in this case) is older than the input files, or
- if the output file does not exist.
-</p>
+<p><strong>Note</strong>: Please note the <code>tar</code> task creates a tar file, it does not
+append to an existing tar file. The existing tar file is replaced instead. As with most tasks in
+Ant, the task only takes action if the output file (the tar file in this case) is older than the
+input files, or if the output file does not exist.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/taskdef.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/taskdef.html b/manual/Tasks/taskdef.html
index a83def4..653b486 100644
--- a/manual/Tasks/taskdef.html
+++ b/manual/Tasks/taskdef.html
@@ -26,17 +26,16 @@
<h2 id="taskdef">Taskdef</h2>
<h3>Description</h3>
- <p>Adds a task definition to the current project, such that this new task can be
- used in the current project.</p>
- <p>This task is a form of <a href="typedef.html">Typedef</a> with the
- attributes "adapter" and "adaptto" set to the values
- "org.apache.tools.ant.TaskAdapter" and "org.apache.tools.ant.Task"
- respectively. Anything said in the <a href="typedef.html">manual
- page of typedef</a> applies to taskdef as well.</p>
+<p>Adds a task definition to the current project, such that this new task can be used in the current
+project.</p>
+<p>This task is a form of <a href="typedef.html">Typedef</a> with the attributes <var>adapter</var>
+and <var>adaptto</var> set to the values <q>org.apache.tools.ant.TaskAdapter</q>
+and <q>org.apache.tools.ant.Task</q> respectively. Anything said in
+the <a href="typedef.html">manual page of typedef</a> applies to <code>taskdef</code> as well.</p>
<h3>Examples</h3>
-<pre> <taskdef name="myjavadoc" classname="com.mydomain.JavadocTask"/></pre>
-<p>makes a task called <code>myjavadoc</code> available to Apache Ant. The class <code>com.mydomain.JavadocTask</code>
-implements the task.</p>
+<pre><taskdef name="myjavadoc" classname="com.mydomain.JavadocTask"/></pre>
+<p>makes a task called <code>myjavadoc</code> available to Apache Ant. The
+class <code>com.mydomain.JavadocTask</code> implements the task.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/telnet.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/telnet.html b/manual/Tasks/telnet.html
index c2c9dc9..5f19231 100644
--- a/manual/Tasks/telnet.html
+++ b/manual/Tasks/telnet.html
@@ -26,90 +26,83 @@
<h2 id="telnet">Telnet</h2>
<h3>Description</h3>
-Task to automate a remote telnet session. The task uses
-nested <tt><read></tt> to indicate strings to wait for, and
-<tt><write></tt> tags to specify text to send.
+<q>Task to automate a remote telnet session. The task uses nested <code><read></code> to
+indicate strings to wait for, and <code><write></code> tags to specify text to send.</q>
-<p>If you do specify a userid and password, the system will
-assume a common unix prompt to wait on. This behavior can be easily over-ridden.</p>
-<p><strong>Note</strong>: This task depends on external libraries not included in the Apache Ant distribution.
-See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p>
+<p>If you do specify a userid and password, the system will assume a common Unix prompt to wait
+on. This behavior can be easily overridden.</p>
+<p><strong>Note</strong>: This task depends on external libraries not included in the Apache Ant
+distribution. See <a href="../install.html#librarydependencies">Library Dependencies</a> for more
+information.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
- <td>userid</td>
- <td>the login id to use on the telnet server.</td>
- <td>Only if password is specified</td>
+ <td>userid</td>
+ <td>the login id to use on the telnet server.</td>
+ <td>Only if <var>password</var> is specified</td>
</tr>
<tr>
- <td>password</td>
- <td>the login password to use on the telnet server.</td>
- <td>Only if userid is specified</td>
+ <td>password</td>
+ <td>the login password to use on the telnet server.</td>
+ <td>Only if <var>userid</var> is specified</td>
</tr>
<tr>
- <td>server</td>
- <td>the address of the remote telnet server.</td>
- <td>Yes</td>
+ <td>server</td>
+ <td>the address of the remote telnet server.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td>port</td>
- <td>the port number of the remote telnet server. Defaults to port 23.</td>
- <td>No</td>
+ <td>port</td>
+ <td>the port number of the remote telnet server.</td>
+ <td>No; defaults to <q>23</q></td>
</tr>
<tr>
- <td>initialCR</td>
- <td>send a cr after connecting ("yes"). Defaults to "no".</td>
- <td>No</td>
+ <td>initialCR</td>
+ <td>send a cr after connecting if <q>yes</q>.</td>
+ <td>No; defaults to <q>no</q></td>
</tr>
<tr>
- <td>timeout</td>
- <td>set a default timeout to wait for a response. Specified in seconds. Default is no timeout.</td>
- <td>No</td>
+ <td>timeout</td>
+ <td>set a default timeout to wait for a response. Specified in seconds.</td>
+ <td>No; default is no timeout</td>
</tr>
</table>
<h3 id="nested">Nested Elements</h3>
-The commands to send to the server, and responses to wait for, are
-described as nested elements.
+<p>The commands to send to the server, and responses to wait for, are described as nested
+elements.</p>
<h4>read</h4>
-<p>declare (as a text child of this element) a string to wait for.
-The element supports the timeout attribute, which overrides any
-timeout specified for the task as a whole. It also has a <tt>string</tt>
-attribute, which is an alternative to specifying the string as
-a text element.
-</p>
-<i>Always declare an opening and closing
-<code><read></code> element to ensure that statements are not sent before
-the connection is ready, and that the connection is not broken before
-the final command has completed.
-</i>
+<p>declare (as a text child of this element) a string to wait for. The element supports
+the <var>timeout</var> attribute, which overrides any timeout specified for the task as a whole. It
+also has a <var>string</var> attribute, which is an alternative to specifying the string as a text
+element.</p>
+<p><em>Always declare an opening and closing <code><read></code> element to ensure that
+statements are not sent before the connection is ready, and that the connection is not broken before
+the final command has completed.</em></p>
+
<h4>write</h4>
+<p>describes the text to send to the server. The <var>echo</var> boolean attribute controls whether
+the string is echoed to the local log; this is <q>true</q> by default.</p>
-<p>describes the text to send to the server. The <tt>echo</tt> boolean
-attribute controls whether the string is echoed to the local log;
-this is "true" by default
-</p>
<h3>Examples</h3>
-A simple example of connecting to a server and running a command. This assumes
- a prompt of "ogin:" for the userid, and a prompt of "assword:"
- for the password.
+<p>A simple example of connecting to a server and running a command. This assumes a prompt
+of <q>ogin:</q> for the userid, and a prompt of <q>assword:</q> for the password.</p>
<pre>
<telnet userid="bob" password="badpass" server="localhost">
<read>/home/bob</read>
<write>ls</write>
<read string="/home/bob"/>
-</telnet>
-</pre>
+</telnet></pre>
-This task can be rewritten as:
+<p>This task can be rewritten as:</p>
<pre>
<telnet server="localhost">
<read>ogin:</read>
@@ -119,35 +112,32 @@ This task can be rewritten as:
<read>/home/bob</read>
<write>ls</write>
<read>/home/bob</read>
-</telnet>
-</pre>
+</telnet></pre>
+
+<p>A timeout can be specified at the <code><telnet></code> level or at
+the <code><read></code> level. This will connect, issue a <code>sleep</code> command that is
+suppressed from displaying and wait 10 seconds before quitting.</p>
-A timeout can be specified at the <code><telnet></code> level or at the <code><read></code> level.
-This will connect, issue a sleep command that is suppressed from displaying and wait
-10 seconds before quitting.
<pre>
<telnet userid="bob" password="badpass" server="localhost" timeout="20">
<read>/home/bob</read>
<write echo="false">sleep 15</write>
<read timeout="10">/home/bob</read>
-</telnet>
-</pre>
+</telnet></pre>
-The task can be used with other ports as well:
+<p>The task can be used with other ports as well:</p>
<pre>
<telnet port="80" server="localhost" timeout="20">
<read/>
<write>GET / http/0.9</write>
<write/>
<read timeout="10">&lt;/HTML&gt;</read>
-</telnet>
-</pre>
-<p>
-To use this task against the WinNT telnet service, you need to configure the service to use
-classic authentication rather than NTLM negotiated authentication.
-This can be done in the Telnet Server Admin app:
-select "display/change registry settings", then "NTLM", then set the value of NTLM to 1.
-</p>
+</telnet></pre>
+
+<p>To use this task against the Windows NT telnet service, you need to configure the service to use
+classic authentication rather than NTLM negotiated authentication. This can be done in the Telnet
+Server Admin app: select <q>display/change registry settings</q>, then <q>NTLM</q>, then set the
+value of NTLM to 1.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/tempfile.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/tempfile.html b/manual/Tasks/tempfile.html
index e1c930a..d2f0c5b 100644
--- a/manual/Tasks/tempfile.html
+++ b/manual/Tasks/tempfile.html
@@ -25,110 +25,63 @@
<body>
<h2>Tempfile Task</h2>
<h3 id="description">Description</h3>
- This task sets a property to the name of a temporary file.
- Unlike <code>java.io.File.createTempFile</code>,
- this task does not actually create the temporary file, but it does guarantee that the
- file did not exist when the task was executed.
-<h3>Examples:</h3>
- <pre><tempfile property="temp.file"/></pre>
-
- create a temporary file
-
- <pre><tempfile property="temp.file" suffix=".xml"/></pre>
-
- create a temporary file with the <code>.xml</code> suffix
-
- <pre><tempfile property="temp.file" destDir="build"/></pre>
-
- create a temporary file in the <code>build</code> subdirectory
+<p>This task sets a property to the name of a temporary file.
+Unlike <code>java.io.File.createTempFile</code>, this task does not actually create the temporary
+file, but it does guarantee that the file did not exist when the task was executed.</p>
<h3 id="attributes">Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top" align="left">
- <b>Attribute</b>
- </td>
- <td valign="top" align="left">
- <b>Description</b>
- </td>
- <td valign="top" align="left">
- <b>Type</b>
- </td>
- <td valign="top" align="left">
- <b>Requirement</b>
- </td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Type</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top" align="left">
- property
- </td>
- <td valign="top" align="left">
- Sets the property you wish to assign the temporary file to.
- </td>
- <td valign="top" align="left">
- String
- </td>
- <td valign="top" align="left" rowspan="1">
- Required
- </td>
+ <td>property</td>
+ <td>Sets the property you wish to assign the temporary file to.</td>
+ <td>String</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top" align="left">
- destdir
- </td>
- <td valign="top" align="left">
- Sets the destination directory. If not set, the basedir directory is used instead.
- </td>
- <td valign="top" align="left">
- File
- </td>
- <td valign="top" align="left" rowspan="5">
- Optional
- </td>
+ <td>destdir</td>
+ <td>Sets the destination directory.</td>
+ <td>File</td>
+ <td>No; defaults to <var>basedir</var></td>
</tr>
<tr>
- <td valign="top" align="left">
- prefix
- </td>
- <td valign="top" align="left">
- Sets the optional prefix string for the temp file.
- </td>
- <td valign="top" align="left">
- String
- </td>
+ <td>prefix</td>
+ <td>Sets the optional prefix string for the temp file.</td>
+ <td>String</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top" align="left">
- suffix
- </td>
- <td valign="top" align="left">
- Sets the optional suffix string for the temp file.
- </td>
- <td valign="top" align="left">
- String
- </td>
+ <td>suffix</td>
+ <td>Sets the optional suffix string for the temp file.</td>
+ <td>String</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top" align="left">
- deleteonexit
- </td>
- <td valign="top" align="left">
- Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default <em>false</em>. <em>Since Apache Ant 1.7</em>
- </td>
- <td valign="top" align="left">
- boolean
- </td>
+ <td>deleteonexit</td>
+ <td>Whether the temp file will be marked for deletion on normal exit of JVM (even though the
+ file may never be created). <em>Since Apache Ant 1.7</em></td>
+ <td>boolean</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top" align="left">
- createfile
- </td>
- <td valign="top" align="left">
- Whether the temp file should be created by this task; default <em>false</em>. <em>Since Ant 1.8</em>
- </td>
- <td valign="top" align="left">
- boolean
- </td>
+ <td>createfile</td>
+ <td>Whether the temp file should be created by this task. <em>Since Ant 1.8</em></td>
+ <td>boolean</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
</table>
+<h3>Examples</h3>
+<pre><tempfile property="temp.file"/></pre>
+<p>create a temporary file</p>
+
+<pre><tempfile property="temp.file" suffix=".xml"/></pre>
+<p>create a temporary file with the <code>.xml</code> suffix</p>
+
+<pre><tempfile property="temp.file" destDir="build"/></pre>
+<p>create a temporary file in the <code>build</code> subdirectory</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/touch.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/touch.html b/manual/Tasks/touch.html
index c265f50..08c76c0 100644
--- a/manual/Tasks/touch.html
+++ b/manual/Tasks/touch.html
@@ -27,132 +27,120 @@
<h2 id="touch">Touch</h2>
<h3>Description</h3>
-<p>Changes the modification time of a resource and possibly creates it
-at the same time. In addition to working with a single file, this Task
-can also work on <a href="../Types/resources.html">resources</a> and
-resource collections (which also includes directories). Prior to Apache Ant
-1.7 only FileSet or <a href="../Types/filelist.html">Filelist</a>
-(<em>since Ant 1.6</em>) have been supported.</p>
-
-<p>Ant uses the API of <code>java.io.File</code> to set the last
- modification time which has some limitations. For example the
- timestamp granularity depends on the operating system and sometimes
- the operating system may allow a granularity smaller than
- milliseconds. If you need more control you have to fall back to
- the <code><exec></code> task and native commands.</p>
-
-<p><em>Since Ant 1.8.2</em>, a warning message is logged upon failure
- to change the file modification time. This will happen if you try
- to change the modification time of a file you do not own on many
- Unix systems, for example.</p>
+<p>Changes the modification time of a resource and possibly creates it at the same time. In addition
+to working with a single file, this Task can also work
+on <a href="../Types/resources.html">resources</a> and resource collections (which also includes
+directories). Prior to Apache Ant 1.7 only FileSet or <a href="../Types/filelist.html">Filelist</a>
+(<em>since Ant 1.6</em>) were supported.</p>
+
+<p>Ant uses the API of <code>java.io.File</code> to set the last modification time which has some
+limitations. For example, the timestamp granularity depends on the operating system and sometimes
+the operating system may allow a granularity smaller than milliseconds. If you need more control
+you have to fall back to the <code><exec></code> task and native commands.</p>
+
+<p><em>Since Ant 1.8.2</em>, a warning message is logged upon failure to change the file
+modification time. This will happen if you try to change the modification time of a file you do not
+own on many Unix systems, for example.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">The name of the file.</td>
- <td valign="top" align="center">Unless a nested resource collection element
- has been specified.</td>
+ <td>file</td>
+ <td>The name of the file.</td>
+ <td>Unless a nested resource collection element has been specified</td>
</tr>
<tr>
- <td valign="top">millis</td>
- <td valign="top">Specifies the new modification time of the file
- in milliseconds since midnight Jan 1 1970.</td>
- <td valign="center" align="center" rowspan="2">No--datetime takes
- precedence, however if both are omitted the current time is assumed.</td>
+ <td>millis</td>
+ <td>Specifies the new modification time of the file in milliseconds since midnight Jan 1
+ 1970.</td>
+ <td rowspan="2">No; <var>datetime</var> takes precedence, however if both are omitted then
+ current time is assumed</td>
</tr>
<tr>
- <td valign="top">datetime</td>
- <td valign="top">Specifies the new modification time of the file.
- <em>since Ant 1.8</em>, the
- special value "now" indicates the current time.</td>
+ <td>datetime</td>
+ <td class="left">Specifies the new modification time of the file. <em>Since Ant 1.8</em>, the
+ special value <q>now</q> indicates the current time.</td>
</tr>
<tr>
- <td valign="top">pattern</td>
- <td valign="top">SimpleDateFormat-compatible pattern string using
- the current locale.
- Defaults to "MM/dd/YYYY hh:mm a" or "MM/dd/yyyy hh:mm:ss a"
- using the US locale.
- <em>Since Ant 1.6.3</em></td>
- <td valign="top" align="center">No</td>
+ <td>pattern</td>
+ <td>SimpleDateFormat-compatible pattern string using the current locale. <em>Since Ant
+ 1.6.3</em></td>
+ <td>No; defaults to <q>MM/dd/YYYY hh:mm a</q> or <q>MM/dd/yyyy hh:mm:ss a</q> using the US
+ locale.</td>
</tr>
<tr>
- <td valign="top">mkdirs</td>
- <td valign="top">Whether to create nonexistent parent
- directories when touching new files. <em>Since Ant 1.6.3</em></td>
- <td valign="top" align="center">No, default <i>false</i>.</td>
+ <td>mkdirs</td>
+ <td>Whether to create nonexistent parent directories when touching new files. <em>Since Ant
+ 1.6.3</em></td>
+ <td>No; default <q>false</q></td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">Whether to log the creation of new files.
- <em>Since Ant 1.6.3</em></td>
- <td valign="top" align="center">No, default <i>true</i>.</td>
+ <td>verbose</td>
+ <td>Whether to log the creation of new files. <em>Since Ant 1.6.3</em></td>
+ <td>No; default <q>true</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>any resource collection</h4>
-<p>You can use any number of nested resource collection elements to
-define the resources for this task and refer to resources defined
-elsewhere. <strong>Note</strong>: resources passed to this task must implement
-the <code>org.apache.tools.ant.types.resources.Touchable</code>
-interface, this is true for all filesystem-based resources like those
-returned by path, fileset ot filelist.</p>
+<p>You can use any number of nested resource collection elements to define the resources for this
+task and refer to resources defined elsewhere. <strong>Note</strong>: resources passed to this task
+must implement the <code>org.apache.tools.ant.types.resources.Touchable</code> interface, this is
+true for all filesystem-based resources like those returned by path, fileset ot filelist.</p>
-<p>For backwards compatibility directories matched by nested filesets
-will be "touched" as well, use a <type> selector to suppress
-this. This only applies to filesets nested into the task directly,
-not to filesets nested into a path or any other resource
-collection.</p>
+<p>For backwards compatibility directories matched by nested filesets will be "touched" as well, use
+a <var>type</var> selector to suppress this. This only applies to filesets nested into the task
+directly, not to filesets nested into a path or any other resource collection.</p>
<h4>mapper</h4>
-<p><em>Since Ant 1.6.3</em>, a nested <a href="../Types/mapper.html">
- mapper</a> can be specified. Files specified via nested
- <code>fileset</code>s, <code>filelist</code>s, or the <code>file</code>
- attribute are mapped using the specified mapper. For each file mapped,
- the resulting files are touched. If no time has been specified and
- the original file exists its timestamp will be used.
- If no time has been specified and the original file does not exist the
- current time is used. <em>Since Ant 1.8</em> the task settings (<code>millis</code>,
- and <code>datetime</code>) have priority over the timestamp of the original
- file.</p>
+<p><em>Since Ant 1.6.3</em>, a nested <a href="../Types/mapper.html"> mapper</a> can be specified.
+Files specified via nested <code>fileset</code>s, <code>filelist</code>s, or the <code>file</code>
+attribute are mapped using the specified mapper. For each file mapped, the resulting files are
+touched. If no time has been specified and the original file exists its timestamp will be used. If
+no time has been specified and the original file does not exist the current time is used. <em>Since
+Ant 1.8</em>, the task settings (<var>millis</var>, and <var>datetime</var>) have priority over the
+timestamp of the original file.</p>
<h3>Examples</h3>
-<pre> <touch file="myfile"/></pre>
-<p>creates <code>myfile</code> if it doesn't exist and changes the
-modification time to the current time.</p>
-<pre> <touch file="myfile" datetime="06/28/2000 2:02 pm"/></pre>
-<p>creates <code>myfile</code> if it doesn't exist and changes the
-modification time to Jun, 28 2000 2:02 pm (14:02 for those used to 24
-hour times).</p>
-<pre> <touch datetime="09/10/1974 4:30 pm">
+
+<pre><touch file="myfile"/></pre>
+<p>creates <samp>myfile</samp> if it doesn't exist and changes the modification time to the current
+time.</p>
+
+<pre><touch file="myfile" datetime="06/28/2000 2:02 pm"/></pre>
+<p>creates <samp>myfile</samp> if it doesn't exist and changes the modification time to Jun, 28 2000
+2:02 pm (14:02 for those used to 24 hour time).</p>
+
+<pre>
+<touch datetime="09/10/1974 4:30 pm">
<fileset dir="src_dir"/>
- </touch></pre>
-<p>changes the modification time to Oct, 09 1974 4:30 pm of all files and directories
- found in <code>src_dir</code>.</p>
-<pre> <touch file="myfile" datetime="06/28/2000 2:02:17 pm"/></pre>
-<p>creates <code>myfile</code> if it doesn't exist and changes the
-modification time to Jun, 28 2000 2:02:17 pm (14:02:17 for those used to 24
-hour times), if the filesystem allows a precision of one second - a
-time close to it otherwise.</p>
-<pre> <touch file="foo">
- <mapper type="glob" from="foo" to="bar" />
- </touch>
-</pre>
-<p>creates <code>bar</code> if it doesn't exist and changes the
-modification time to that of <code>foo</code>.</p>
-
-<pre> <touch file="foo" datetime="now">
- <mapper type="regexp" from="^src(.*)\.java" to="shadow\1.empty" />
- </touch>
-</pre>
-<p>creates files in the <code>shadow</code> directory for every java file in the
- <code>src</code> directory if it doesn't exist and changes the modification
- time of those files to the current time.</p>
+</touch></pre>
+<p>changes the modification time to Oct, 09 1974 4:30 pm of all files and directories found
+in <samp>src_dir</samp>.</p>
+
+<pre><touch file="myfile" datetime="06/28/2000 2:02:17 pm"/></pre>
+<p>creates <samp>myfile</samp> if it doesn't exist and changes the modification time to Jun, 28 2000
+2:02:17 pm (14:02:17 for those used to 24 hour time), if the filesystem allows a precision of one
+second—a time close to it otherwise.</p>
+
+<pre>
+<touch file="foo">
+ <mapper type="glob" from="foo" to="bar"/>
+</touch></pre>
+<p>creates <samp>bar</samp> if it doesn't exist and changes the modification time to that
+of <samp>foo</samp>.</p>
+
+<pre>
+<touch file="foo" datetime="now">
+ <mapper type="regexp" from="^src(.*)\.java" to="shadow\1.empty"/>
+</touch></pre>
+<p>creates files in the <samp>shadow</samp> directory for every <samp>.java</samp> file in
+the <samp>src</samp> directory if it doesn't exist and changes the modification time of those files
+to the current time.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/translate.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/translate.html b/manual/Tasks/translate.html
index ee5c2e4..ea1f5a5 100644
--- a/manual/Tasks/translate.html
+++ b/manual/Tasks/translate.html
@@ -26,25 +26,17 @@
<h2 id="translate">Translate</h2>
<h3>Description</h3>
-<p>Identifies keys in files delimited by special tokens
-and translates them with values read from resource bundles.
-</p>
-<p>
-A resource bundle contains locale-specific key-value pairs.
-A resource bundle is a hierarchical set of property files.
-A bundle name makes up its base family name. Each file that
-makes up this bundle has this name plus its locale. For example,
-if the resource bundle name is MyResources, the file that contains
-German text will take the name MyResources_de. In addition to
-language, country and variant are also used to form the files in
-the bundle.
-</p>
-<p>
-The resource bundle lookup searches for resource files with various
-suffixes on the basis of (1) the desired locale and (2) the default
-locale (basebundlename), in the following order from lower-level
-(more specific) to parent-level (less specific):
-</p>
+<p>Identifies keys in files delimited by special tokens and translates them with values read from
+resource bundles.</p>
+<p>A resource bundle contains locale-specific key-value pairs. A resource bundle is a hierarchical
+set of property files. A bundle name makes up its base family name. Each file that makes up this
+bundle has this name plus its locale. For example, if the resource bundle name
+is <samp>MyResources</samp>, the file that contains German text will take the
+name <samp>MyResources_de</samp>. In addition to language, country and variant are also used to
+form the files in the bundle.</p>
+<p>The resource bundle lookup searches for resource files with various suffixes on the basis of (1)
+the desired locale and (2) the default locale (basebundlename), in the following order from
+lower-level (more specific) to parent-level (less specific):</p>
<pre>
basebundlename + "_" + language1 + "_" + country1 + "_" + variant1
basebundlename + "_" + language1 + "_" + country1
@@ -54,128 +46,103 @@ basebundlename + "_" + language2 + "_" + country2 + "_&
basebundlename + "_" + language2 + "_" + country2
basebundlename + "_" + language2
</pre>
-<p>
-The file names generated thus are appended with the string ".properties"
-to make up the file names that are to be used.
-</p>
-<p>
-File encoding is supported. The encoding scheme of the source files,
-destination files and the bundle files can be specified.
-
-Destination files can be explicitly overwritten using the
-<var>forceoverwrite</var> attribute. If <var>forceoverwrite</var>
-is false, the destination file is overwritten only if either the
-source file or any of the files that make up the bundle have been
-modified after the destination file was last modified.
-</p>
-<p>
-<em>New in Apache Ant 1.6:</em><br>
-Line endings of source files are preserved in the translated files.
-</p>
-<p><a href="../Types/fileset.html">FileSet</a>s are used to select files to
-translate.
-</p>
+<p>The file names generated thus are appended with the string <samp>.properties</samp> to make up
+the file names that are to be used.</p>
+<p>File encoding is supported. The encoding scheme of the source files, destination files and the
+bundle files can be specified.</p>
+<p>Destination files can be explicitly overwritten using the <var>forceoverwrite</var> attribute.
+If <var>forceoverwrite</var> is <q>false</q>, the destination file is overwritten only if either the
+source file or any of the files that make up the bundle have been modified after the destination
+file was last modified.</p>
+<p><em>Since Apache Ant 1.6</em>:<br/>Line endings of source files are preserved in the translated
+files.</p>
+<p><a href="../Types/fileset.html">FileSet</a>s are used to select files to translate.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">todir</td>
- <td valign="top">Destination directory where destination files are
- to be created.</td>
- <td valign="top" align="center">Yes</td>
+ <td>todir</td>
+ <td>Destination directory where destination files are to be created.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">starttoken</td>
- <td valign="top">The starting token to identify keys.</td>
- <td valign="top" align="center">Yes</td>
+ <td>starttoken</td>
+ <td>The starting token to identify keys.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">endtoken</td>
- <td valign="top">The ending token to identify keys.</td>
- <td valign="top" align="center">Yes</td>
+ <td>endtoken</td>
+ <td>The ending token to identify keys.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">bundle</td>
- <td valign="top">Family name of resource bundle.</td>
- <td valign="top" align="center">Yes</td>
+ <td>bundle</td>
+ <td>Family name of resource bundle.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">bundlelanguage</td>
- <td valign="top">
- Locale specific language of resource bundle. Defaults to
- default locale's language.
- </td>
- <td valign="top" align="center">No</td>
+ <td>bundlelanguage</td>
+ <td>Locale specific language of resource bundle.</td>
+ <td>No; defaults to default locale's language</td>
</tr>
<tr>
- <td valign="top">bundlecountry</td>
- <td valign="top">
- Locale specific country of resource bundle. Defaults to
- default locale's country.
- </td>
- <td valign="top" align="center">No</td>
+ <td>bundlecountry</td>
+ <td>Locale specific country of resource bundle.</td>
+ <td>No; defaults to default locale's country</td>
</tr>
<tr>
- <td valign="top">bundlevariant</td>
- <td valign="top">
- Locale specific variant of resource bundle. Defaults to
- the default variant of the country and language being used.
- </td>
- <td valign="top" align="center">No</td>
+ <td>bundlevariant</td>
+ <td>Locale specific variant of resource bundle.</td>
+ <td>No; defaults to <var>bundlelanguage</var>_<var>bundlecountry</var></td>
</tr>
<tr>
- <td valign="top">srcencoding</td>
- <td valign="top">Source file encoding scheme. Defaults to
- system default file encoding.</td>
- <td valign="top" align="center">No</td>
+ <td>srcencoding</td>
+ <td>Source file encoding scheme.</td>
+ <td>No; defaults to default JVM character encoding</td>
</tr>
<tr>
- <td valign="top">destencoding</td>
- <td valign="top">Destination file encoding scheme. Defaults to
- source file encoding.</td>
- <td valign="top" align="center">No</td>
+ <td>destencoding</td>
+ <td>Destination file encoding scheme.</td>
+ <td>No; defaults to <var>srcencoding</var></td>
</tr>
<tr>
- <td valign="top">bundleencoding</td>
- <td valign="top">Resource Bundle file encoding scheme. Defaults to
- source file encoding.</td>
- <td valign="top" align="center">No</td>
+ <td>bundleencoding</td>
+ <td>Resource Bundle file encoding scheme.</td>
+ <td>No; defaults to <var>srcencoding</var></td>
</tr>
<tr>
- <td valign="top">forceoverwrite</td>
- <td valign="top">Overwrite existing files even if the destination
- files are newer. Defaults to "no".</td>
- <td valign="top" align="center">No</td>
+ <td>forceoverwrite</td>
+ <td>Overwrite existing files even if the destination files are newer.</td>
+ <td>No; defaults to <q>no</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>fileset</h4>
- <p><a href="../Types/fileset.html">FileSets</a> are used to select files that
- contain keys for which value translated files are to be generated.
-</p>
+<p><a href="../Types/fileset.html">FileSets</a> are used to select files that contain keys for which
+value translated files are to be generated.</p>
+
<h3>Examples</h3>
-<p><b>Translate source file encoded in english into its japanese
-equivalent using a resource bundle encoded in japanese.</b></p>
+<p><strong>Translate source file encoded in English into its Japanese equivalent using a resource
+bundle encoded in Japanese.</strong></p>
<pre>
- <translate toDir="$(dest.dir}/ja"
- starttoken="#"
- endtoken="#"
- bundle="resource/BaseResource"
- bundlelanguage="ja"
- forceoverwrite="yes"
- srcencoding="ISO8859_1"
- destencoding="SJIS"
- bundleencoding="SJIS">
- <fileset dir="${src.dir}">
- <include name="**/*.jsp"/>
- </fileset>
- </translate>
-</pre>
+<translate toDir="$(dest.dir}/ja"
+ starttoken="#"
+ endtoken="#"
+ bundle="resource/BaseResource"
+ bundlelanguage="ja"
+ forceoverwrite="yes"
+ srcencoding="ISO8859_1"
+ destencoding="SJIS"
+ bundleencoding="SJIS">
+ <fileset dir="${src.dir}">
+ <include name="**/*.jsp"/>
+ </fileset>
+</translate></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/truncate.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/truncate.html b/manual/Tasks/truncate.html
index 2dabff6..2aeca23 100644
--- a/manual/Tasks/truncate.html
+++ b/manual/Tasks/truncate.html
@@ -27,83 +27,75 @@
<h2 id="touch">Truncate</h2>
<h3>Description</h3>
-<p>Set the length of one or more files, as the intermittently available
-<code>truncate</code> Unix utility/function. In addition to working with
-a single file, this Task can also work on
-<a href="../Types/resources.html">resources</a> and resource collections.
-<em>Since Apache Ant 1.7.1</em>.
-</p>
+<p>Set the length of one or more files, as the intermittently available <code>truncate</code> Unix
+utility/function. In addition to working with a single file, this Task can also work
+on <a href="../Types/resources.html">resources</a> and resource collections. <em>Since Apache Ant
+1.7.1</em>.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">The name of the file.</td>
- <td valign="top" align="center">Unless a nested resource collection element
- has been specified.</td>
+ <td>file</td>
+ <td>The name of the file.</td>
+ <td>Unless a nested resource collection element has been specified</td>
</tr>
<tr>
- <td valign="top">length</td>
- <td valign="top">Specifies the new file length (in bytes) to set.
- The following suffixes are supported:
+ <td>length</td>
+ <td>Specifies the new file length (in bytes) to set. The following suffixes are supported:
<ul>
- <li>K : Kilobytes (1024 bytes)</li>
- <li>M : Megabytes (1024 K)</li>
- <li>G : Gigabytes (1024 M)</li>
- <li>T : Terabytes (1024 G)</li>
- <li>P : Petabytes (1024 T)</li>
+ <li><q>K</q> : Kilobytes (1024 bytes)</li>
+ <li><q>M</q> : Megabytes (1024 K)</li>
+ <li><q>G</q> : Gigabytes (1024 M)</li>
+ <li><q>T</q> : Terabytes (1024 G)</li>
+ <li><q>P</q> : Petabytes (1024 T)</li>
</ul>
</td>
- <td valign="center" align="center" rowspan="2">At most one of these.
- Omitting both implies <code>length="0"</code>.
+ <td rowspan="2">At most one of these; omitting both implies <var>length</var>=<q>0</q>
</td>
</tr>
<tr>
- <td valign="top">adjust</td>
- <td valign="top">Specifies the number of bytes
- (and positive/negative direction)
- by which to adjust file lengths. The same suffixes are supported
- for this attribute as for the <code>length</code> attribute.
+ <td>adjust</td>
+ <td class="left">Specifies the number of bytes (and positive/negative direction) by which to
+ adjust file lengths. The same suffixes are supported for this attribute as for
+ the <var>length</var> attribute.
</td>
</tr>
<tr>
- <td valign="top">create</td>
- <td valign="top">Whether to create nonexistent files.</td>
- <td valign="top" align="center">No, default <i>true</i>.</td>
+ <td>create</td>
+ <td>Whether to create nonexistent files.</td>
+ <td>No; default <q>true</q></td>
</tr>
<tr>
- <td valign="top">mkdirs</td>
- <td valign="top">Whether to create nonexistent parent
- directories when creating new files.</td>
- <td valign="top" align="center">No, default <i>false</i>.</td>
+ <td>mkdirs</td>
+ <td>Whether to create nonexistent parent directories when creating new files.</td>
+ <td>No; default <q>false</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>any resource collection</h4>
-<p>You can use any number of nested resource collection elements to
-define the resources for this task and refer to resources defined
-elsewhere. <strong>Note</strong>: resources passed to this task are expected
-to be filesystem-based.</p>
+<p>You can use any number of nested resource collection elements to define the resources for this
+task and refer to resources defined elsewhere. <strong>Note</strong>: resources passed to this task
+are expected to be filesystem-based.</p>
<h3>Examples</h3>
-<pre> <truncate file="foo" /></pre>
-<p>Sets the length of file <code>foo</code> to zero.</p>
+<pre><truncate file="foo"/></pre>
+<p>Sets the length of file <samp>foo</samp> to zero.</p>
-<pre> <truncate file="foo" length="1K" /></pre>
-<p>Sets the length of file <code>foo</code> to 1 kilobyte (1024 bytes).</p>
+<pre><truncate file="foo" length="1K"/></pre>
+<p>Sets the length of file <samp>foo</samp> to 1 kilobyte (1024 bytes).</p>
-<pre> <truncate file="foo" adjust="1K" /></pre>
-<p>Adjusts the length of file <code>foo</code> upward by 1 kilobyte.</p>
+<pre><truncate file="foo" adjust="1K"/></pre>
+<p>Adjusts the length of file <samp>foo</samp> upward by 1 kilobyte.</p>
-<pre> <truncate file="foo" adjust="-1M" /></pre>
-<p>Adjusts the length of file <code>foo</code> downward by 1 megabyte.</p>
+<pre><truncate file="foo" adjust="-1M"/></pre>
+<p>Adjusts the length of file <samp>foo</samp> downward by 1 megabyte.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/tstamp.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/tstamp.html b/manual/Tasks/tstamp.html
index 8a290ba..3d83e8a 100644
--- a/manual/Tasks/tstamp.html
+++ b/manual/Tasks/tstamp.html
@@ -27,141 +27,126 @@
<h2 id="tstamp">Tstamp</h2>
<h3>Description</h3>
-<p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and <code>TODAY</code>
-properties in the current project. By default,
-the <code>DSTAMP</code> property is in the
-format "yyyyMMdd", <code>TSTAMP</code> is in the
-format "hhmm", and <code>TODAY</code> is in the
-format "MMMM dd yyyy". Use the nested <code><format></code> element
-to specify a different format.</p>
-
-<p>These properties can be used in the build-file, for instance, to create
-time-stamped filenames, or used to replace placeholder tags inside documents
-to indicate, for example, the release date. The best place for this task is
-probably in an initialization target.</p>
-
-<p><em>Since Ant 1.10.2</em> the magic
-property <code>ant.tstamp.now</code> can be used to specify a fixed
-date value in order to create reproducible builds. Its value must be
-a number and is interpreted as seconds since the epoch (midnight
-1970-01-01). With <code>ant.tstamp.now.iso</code> you could also specify that
-value in ISO-8601 format (<code>1972-04-17T08:07:00Z</code>). If you specify a value
-in an invalid format an INFO message will be logged and the value will be ignored.</p>
+<p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and <code>TODAY</code> properties in the
+current project. By default, the <code>DSTAMP</code> property is in the
+format <q>yyyyMMdd</q>, <code>TSTAMP</code> is in the format <q>hhmm</q>, and <code>TODAY</code> is
+in the format <q>MMMM dd yyyy</q>. Use the nested <code><format></code> element to specify a
+different format.</p>
+
+<p>These properties can be used in the build file, for instance, to create timestamped filenames, or
+used to replace placeholder tags inside documents to indicate, for example, the release date. The
+best place for this task is probably in an initialization target.</p>
+
+<p><em>Since Ant 1.10.2</em> the magic property <code>ant.tstamp.now</code> can be used to specify a
+fixed date value in order to create reproducible builds. Its value must be a number and is
+interpreted as seconds since the epoch (midnight 1970-01-01). With <code>ant.tstamp.now.iso</code>
+you could also specify that value in ISO-8601 format (<code>1972-04-17T08:07:00Z</code>). If you
+specify a value in an invalid format an INFO message will be logged and the value will be
+ignored.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">prefix</td>
- <td valign="top">Prefix used for all properties set. The default is no prefix.</td>
- <td align="center" valign="top">No</td>
+ <td>prefix</td>
+ <td>Prefix used for all properties set.</td>
+ <td>No; default is no prefix</td>
</tr>
</table>
<h3>Nested Elements</h3>
-<p>
-The Tstamp task supports a <code><format></code> nested element that
-allows a property to be set to the current date and time in a given format.
-The date/time patterns are as defined in the Java
-<a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a> class.
-The format element also allows offsets to be applied to the time to generate different time values.
-</p>
-<table>
+<p>The <code>Tstamp</code> task supports a <code><format></code> nested element that allows a
+property to be set to the current date and time in a given format. The date/time patterns are as
+defined in the
+Java <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>
+class. The format element also allows offsets to be applied to the time to generate different time
+values.</p>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">property</td>
- <td valign="top">
- The property to receive the date/time string in the given pattern.
- </td>
- <td align="center" valign="top">Yes</td>
+ <td>property</td>
+ <td>The property to receive the date/time string in the given pattern.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">pattern</td>
- <td valign="top">The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class.</td>
- <td align="center" valign="top">Yes</td>
+ <td>pattern</td>
+ <td>The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat
+ class.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">timezone</td>
- <td valign="top">The timezone to use for displaying time. The values are as defined by the Java <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html">TimeZone</a> class.</td>
- <td align="center" valign="top">No</td>
+ <td>timezone</td>
+ <td>The timezone to use for displaying time. The values are as defined by the
+ Java <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html">TimeZone</a>
+ class.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">offset</td>
- <td valign="top">The numeric offset to the current time</td>
- <td align="center" valign="top">No</td>
+ <td>offset</td>
+ <td>The numeric offset to the current time</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">unit</td>
- <td valign="top">The unit of the offset to be applied to the current time.
- Valid Values are
- <ul>
- <li>millisecond</li>
- <li>second</li>
- <li>minute</li>
- <li>hour</li>
- <li>day</li>
- <li>week</li>
- <li>month</li>
- <li>year</li>
- </ul>
+ <td>unit</td>
+ <td>The unit of the offset to be applied to the current time. Valid values are
+ <ul>
+ <li><q>millisecond</q></li>
+ <li><q>second</q></li>
+ <li><q>minute</q></li>
+ <li><q>hour</q></li>
+ <li><q>day</q></li>
+ <li><q>week</q></li>
+ <li><q>month</q></li>
+ <li><q>year</q></li>
+ </ul>
</td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">locale</td>
- <td valign="top">The locale used to create date/time string. The general
- form is "language, country, variant" but either variant or variant and
- country may be omitted. For more information please refer to documentation
- for the
- <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html">Locale</a>
+ <td>locale</td>
+ <td>The locale used to create date/time string. The general form is <q>language[, country[,
+ variant]]</q> (either <q>variant</q> or both <q>variant</q> and <q>country</q> may be
+ omitted). For more information please refer to documentation for
+ the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html">Locale</a>
class.</td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
</table>
<h3>Examples</h3>
-<pre>
- <tstamp/>
-</pre>
+<pre><tstamp/></pre>
+<p>sets the standard <code>DSTAMP</code>, <code>TSTAMP</code>, and <code>TODAY</code> properties
+according to the default formats.</p>
-<p>
-sets the standard <code>DSTAMP</code>, <code>TSTAMP</code>,
-and <code>TODAY</code> properties according to the default formats.</p>
<pre>
- <tstamp>
+<tstamp>
<format property="TODAY_GB" pattern="d-MMMM-yyyy" locale="en,GB"/>
- </tstamp>
-</pre>
-<p>
-sets the standard properties as well as the property
-<code>TODAY_UK</code> with the date/time pattern "d-MMMM-yyyy"
-using English locale (eg. 21-May-2001).</p>
-
-<pre>
- <tstamp>
- <format property="touch.time" pattern="MM/dd/yyyy hh:mm aa"
- offset="-5" unit="hour"/>
- </tstamp>
-</pre>
-<p>
-Creates a timestamp, in the property touch.time, 5 hours before the current time. The format in this example
-is suitable for use with the <code><touch></code> task. The standard properties are set also.</p>
+</tstamp></pre>
+<p>sets the standard properties as well as the property <code>TODAY_UK</code> with the date/time
+pattern <q>d-MMMM-yyyy</q> using English locale (eg. 21-May-2001).</p>
<pre>
- <tstamp prefix="start"/>
-</pre>
-<p>
-Sets three properties with the standard formats, prefixed with "start.":
-<code>start.DSTAMP</code>, <code>start.TSTAMP</code>, and <code>start.TODAY</code>.</p>
+<tstamp>
+ <format property="touch.time" pattern="MM/dd/yyyy hh:mm aa"
+ offset="-5" unit="hour"/>
+</tstamp></pre>
+<p>Creates a timestamp, in the property <code>touch.time</code>, 5 hours before the current
+time. The format in this example is suitable for use with the <code><touch></code> task. The
+standard properties are set also.</p>
+
+<pre><tstamp prefix="start"/></pre>
+<p>Sets three properties with the standard formats, prefixed
+with <q>start.</q>: <code>start.DSTAMP</code>, <code>start.TSTAMP</code>,
+and <code>start.TODAY</code>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/typedef.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/typedef.html b/manual/Tasks/typedef.html
index 3d4155d..a756cc0 100644
--- a/manual/Tasks/typedef.html
+++ b/manual/Tasks/typedef.html
@@ -26,239 +26,174 @@
<h2 id="typedef">Typedef</h2>
<h3>Description</h3>
- <p>
- Adds a task or a data type definition to the current project
- such that this new type or task can be used in the current project.
- </p>
- <p>
- A Task is any class that extends org.apache.tools.ant.Task or
- can be adapted as a Task using an adapter class.
- </p>
- <p>
- Data types are things like <a href="../using.html#path">paths</a> or
- <a href="../Types/fileset.html">filesets</a> that can be defined at
- the project level and referenced via their ID attribute.
- Custom data types usually need custom tasks to put them to good use.
- </p>
- <p>
- Two attributes are needed to make a definition: the name that
- identifies this data type uniquely, and the full name of the class
- (including its package name) that implements this type.
- </p>
- <p>
- You can also define a group of definitions at once using the file or
- resource attributes. These attributes point to files in the format of
- Java property files or an xml format.
- </p>
- <p>
- For property files each line defines a single data type in the
- format:</p>
- <pre>
- typename=fully.qualified.java.classname
- </pre>
-
- <p>
- The xml format is described in the
- <a href="../Types/antlib.html">Antlib</a> section.
- </p>
-
- <p>If you are defining tasks or types that share the same classpath
- with multiple taskdef or typedef tasks, the corresponding classes
- will be loaded by different
- Java <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassLoader.html">ClassLoaders</a>.
- Two classes with the same name loaded via different ClassLoaders
- are not the same class from the point of view of the Java VM, they
- don't share static variables and instances of these classes can't
- access private methods or attributes of instances defined by "the
- other class" of the same name. They don't even belong to the same
- Java package and can't access package private code, either.</p>
-
- <p>The best way to load several tasks/types that are supposed to
- cooperate with each other via shared Java code is to use the
- resource attribute and an antlib descriptor. If this is not
- possible, the second best option is to use the loaderref attribute
- and specify the same name for each and every typedef/taskdef -
- this way the classes will share the same ClassLoader. Note that
- the typedef/taskdef tasks must use identical classpath definitions
- (this includes the order of path components) for the loaderref
- attribute to work.</p>
+<p>Adds a task or a data type definition to the current project such that this new type or task can
+be used in the current project.</p>
+<p>A Task is any class that extends <code>org.apache.tools.ant.Task</code> or can be adapted as a
+Task using an adapter class.</p>
+<p>Data types are things like <a href="../using.html#path">paths</a>
+or <a href="../Types/fileset.html">filesets</a> that can be defined at the project level and
+referenced via their <var>id</var> attribute. Custom data types usually need custom tasks to put
+them to good use.</p>
+<p>Two attributes are needed to make a definition: the name that identifies this data type uniquely,
+and the full name of the class (including its package name) that implements this type.</p>
+<p>You can also define a group of definitions at once using the file or resource attributes. These
+attributes point to files in the format of Java property files or an xml format.</p>
+<p>For property files each line defines a single data type in the format:</p>
+<pre>typename=fully.qualified.java.classname</pre>
+<p>The xml format is described in the <a href="../Types/antlib.html">Antlib</a> section.</p>
+
+<p>If you are defining tasks or types that share the same classpath with
+multiple <code>taskdef</code> or <code>typedef</code> tasks, the corresponding classes will be
+loaded by different
+Java <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html">ClassLoaders</a>.
+Two classes with the same name loaded via different ClassLoaders are not the same class from the
+point of view of JVM, they don't share static variables and instances of these classes can't access
+private methods or attributes of instances defined by "the other class" of the same name. They
+don't even belong to the same Java package and can't access package private code, either.</p>
+
+<p>The best way to load several tasks/types that are supposed to cooperate with each other via
+shared Java code is to use the <var>resource</var> attribute and an <code>antlib</code> descriptor.
+If this is not possible, the second best option is to use the <var>loaderref</var> attribute and
+specify the same name for each and every <code>typedef</code>/<code>taskdef</code> -- this way the
+classes will share the same <code>ClassLoader</code>. Note that
+the <code>typedef</code>/<code>taskdef</code> tasks must use identical classpath definitions (this
+includes the order of path components) for the <var>loaderref</var> attribute to work.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">the name of the data type</td>
- <td valign="top" align="center">Yes, unless the file or resource type
- attributes have been specified.</td>
+ <td>name</td>
+ <td>the name of the data type</td>
+ <td rowspan="2">Yes, unless <var>file</var> or <var>resource</var> attributes have been
+ specified.</td>
</tr>
<tr>
- <td valign="top">classname</td>
- <td valign="top">the full class name implementing the data type</td>
- <td valign="top" align="center">Yes, unless file or resource
- have been specified.</td>
+ <td>classname</td>
+ <td class="left">the full class name implementing the data type</td>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">Name of the file to load definitions from.</td>
- <td valign="top" align="center">No</td>
+ <td>file</td>
+ <td>Name of the file to load definitions from.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">resource</td>
- <td valign="top">
- Name of the resource to load definitions from.
- If multiple resources by this name are found along the classpath,
- and the format is "properties", the first resource will be loaded;
- otherwise all such resources will be loaded.
- </td>
- <td valign="top" align="center">No</td>
+ <td>resource</td>
+ <td>Name of the resource to load definitions from. If multiple resources by this name are found
+ along the classpath, and <var>format</var> is <q>properties</q>, the first resource will be
+ loaded; otherwise all such resources will be loaded.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">format</td>
- <td valign="top">The format of the file or resource. The values
- are "properties" or "xml". If the value is "properties" the file/resource
- is a property file contains name to classname pairs. If the value
- is "xml", the file/resource is an xml file/resource structured according
- to <a href="../Types/antlib.html">Antlib</a>.
- The default is "properties" unless the file/resource name ends with
- ".xml", in which case the format attribute will have the value "xml".
- <em>Since Ant 1.6</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>format</td>
+ <td>The format of the file or resource. The values are <q>properties</q>" or <q>xml</q>. If the
+ value is <q>properties</q> the file/resource is a property file contains name-classname
+ pairs. If the value is <q>xml</q>, the file/resource is an XML file/resource structured
+ according to <a href="../Types/antlib.html">Antlib</a>. The default is <q>properties</q>
+ unless the file/resource name ends with <samp>.xml</samp>, in which case the <var>format</var>
+ attribute will have the value <q>xml</q>. <em>Since Ant 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">the classpath to
- use when looking up <code>classname</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>classpath</td>
+ <td>the classpath to use when looking up <var>classname</var>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">
- a reference to a classpath to use when looking up <code>classname</code>.
- </td>
- <td align="center" valign="top">No</td>
+ <td>classpathref</td>
+ <td>a reference to a classpath to use when looking up <var>classname</var>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">loaderRef</td>
- <td valign="top">the name of the loader that is
- used to load the class, constructed from the specified classpath. Use
- this to allow multiple tasks/types to be loaded with the same loader,
- so they can call each other. <em>Since Ant 1.5</em></td>
- <td align="center" valign="top">No</td>
+ <td>loaderRef</td>
+ <td>the name of the loader that is used to load the class, constructed from the specified
+ classpath. Use this to allow multiple tasks/types to be loaded with the same loader, so they
+ can call each other. <em>Since Ant 1.5</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">onerror</td>
- <td valign="top">The action to take if there was a failure in defining the
- type. The values are <i>fail</i>: cause a build exception; <i>report</i>:
- output a warning, but continue; <i>ignore</i>: do nothing.
- <em>Since Ant 1.6</em>,
- an additional value is <i>failall</i>: cause all behavior of fail,
- as well as a build exception for the resource or file attribute
- if the resource or file is not found. <em>Since Ant 1.7</em>,
- the default is <i>fail</i>.
- </td>
- <td valign="top" align="center">No</td>
+ <td>onerror</td>
+ <td>The action to take if there was a failure in defining the type. The values are <q>fail</q>:
+ cause a build exception; <q>report</q>: output a warning, but continue; <q>ignore</q>: do
+ nothing. <em>Since Ant 1.6</em>, an additional value is <q>failall</q>: cause all behavior of
+ fail, as well as a build exception for the resource or file attribute if the resource or file
+ is not found.</td>
+ <td>No; default is <q>fail</q> (<em>since Ant 1.7</em>)</td>
</tr>
<tr>
- <td valign="top">adapter</td>
- <td valign="top">A class that is used to adapt the defined class to
- another interface/class. The adapter class must implement the interface
- "org.apache.tools.ant.TypeAdapter". The adapter class will be used
- to wrap the defined class unless the defined class implements/extends
- the class defined by the attribute "adaptto".
- If "adaptto" is not set, the defined class will always be wrapped.
- <em>Since Ant 1.6</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>adapter</td>
+ <td>A class that is used to adapt the defined class to another interface/class. The adapter
+ class must implement the interface <code>org.apache.tools.ant.TypeAdapter</code>. The adapter
+ class will be used to wrap the defined class unless the defined class implements/extends the
+ class defined by the attribute <q>adaptto</q>. If <q>adaptto</q> is not set, the defined
+ class will always be wrapped. <em>Since Ant 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">adaptto</td>
- <td valign="top">This attribute is used in conjunction with the
- adapter attribute.
- If the defined class does not implement/extend the interface/class
- specified by this attribute, the adaptor class will be used
- to wrap the class. <em>Since Ant 1.6</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>adaptto</td>
+ <td>This attribute is used in conjunction with the adapter attribute. If the defined class does
+ not implement/extend the interface/class specified by this attribute, the adaptor class will
+ be used to wrap the class. <em>Since Ant 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">uri</td>
- <td valign="top">
- The uri that this definition should live in.
- <em>Since Ant 1.6</em>
- </td>
- <td valign="top" align="center">No</td>
+ <td>uri</td>
+ <td>The uri that this definition should live in. <em>Since Ant 1.6</em></td>
+ <td>No</td>
</tr>
</table>
- <h3>Parameters specified as nested elements</h3>
- <h4>classpath</h4>
- <p><code>Typedef</code>'s <i>classpath</i> attribute is a
- <a href="../using.html#path">path-like structure</a> and can also be set
- via a nested <i>classpath</i> element.</p>
+<h3>Parameters specified as nested elements</h3>
+<h4>classpath</h4>
+<p><code>Typedef</code>'s <var>classpath</var> attribute is a <a href="../using.html#path">path-like
+structure</a> and can also be set via a nested <code>classpath</code> element.</p>
<h3>Examples</h3>
- The following fragment defines define a type called <i>urlset</i>.
- <pre>
- <typedef name="urlset" classname="com.mydomain.URLSet"/></pre>
- The data type is now available to Ant. The
- class <code>com.mydomain.URLSet</code> implements this type.
-
- <p>
- Assuming a class <i>org.acme.ant.RunnableAdapter</i> that
- extends Task and implements <i>org.apache.tools.ant.TypeAdapter</i>,
- and in the execute method invokes <i>run</i> on the proxied object,
- one may use a Runnable class as an Ant task. The following fragment
- defines a task called <i>runclock</i>.
- </p>
- <pre>
- <typedef name="runclock"
- classname="com.acme.ant.RunClock"
- adapter="org.acme.ant.RunnableAdapter"/>
- </pre>
-
-
- <p>
- The following fragment shows the use of the classpathref and
- loaderref to load up two definitions.
- </p>
- <pre>
- <path id="lib.path">
- <fileset dir="lib" includes="lib/*.jar"/>
- </path>
-
- <typedef name="filter1"
- classname="org.acme.filters.Filter1"
- classpathref="lib.path"
- loaderref="lib.path.loader"/>
- <typedef name="filter2"
- classname="org.acme.filters.Filter2"
- loaderref="lib.path.loader"/>
- </pre>
-
- <p>
- If you want to load an antlib into a special xml-namespace, the <tt>uri</tt> attribute
- is important:
- </p>
- <pre>
- <project xmlns:antcontrib="antlib:net.sf.antcontrib">
+<p>The following fragment defines define a type called <code>urlset</code>.</p>
+<pre><typedef name="urlset" classname="com.mydomain.URLSet"/></pre>
+<p>The data type is now available to Ant. The class <code>com.mydomain.URLSet</code> implements this
+type.</p>
+
+<p>Assuming a class <code>org.acme.ant.RunnableAdapter</code> that extends Task and
+implements <code>org.apache.tools.ant.TypeAdapter</code>, and in the execute method
+invokes <code>run()</code> on the proxied object, one may use a Runnable class as an Ant task. The
+following fragment defines a task called <code>runclock</code>.</p>
+<pre>
+<typedef name="runclock"
+ classname="com.acme.ant.RunClock"
+ adapter="org.acme.ant.RunnableAdapter"/></pre>
+
+<p>The following fragment shows the use of the <var>classpathref</var> and <var>loaderref</var> to
+load up two definitions.</p>
+<pre>
+<path id="lib.path">
+ <fileset dir="lib" includes="lib/*.jar"/>
+</path>
+
+<typedef name="filter1"
+ classname="org.acme.filters.Filter1"
+ classpathref="lib.path"
+ loaderref="lib.path.loader"/>
+<typedef name="filter2"
+ classname="org.acme.filters.Filter2"
+ loaderref="lib.path.loader"/></pre>
+
+<p>If you want to load an antlib into a special xml-namespace, the <tt>uri</tt> attribute is
+important:</p>
+<pre>
+<project xmlns:antcontrib="antlib:net.sf.antcontrib">
<taskdef uri="antlib:net.sf.antcontrib"
resource="net/sf/antcontrib/antlib.xml"
- classpath="path/to/ant-contrib.jar"/>
- </pre>
+ classpath="path/to/ant-contrib.jar"/></pre>
-<p>Here the namespace
- declaration <code>xmlns:antcontrib="antlib:net.sf.antcontrib"</code>
- allows tasks and types of the AntContrib Antlib to be used with the
- <code>antcontrib</code> prefix
- like <code><antcontrib:if></code>.
- The normal rules of XML namespaces apply and you can declare the
- prefix at any element to make it usable for the element it is
- declared on as well as all its child elements.</p>
+<p>Here the namespace declaration <code>xmlns:antcontrib="antlib:net.sf.antcontrib"</code> allows
+tasks and types of the AntContrib Antlib to be used with the <samp>antcontrib</samp> prefix
+like <code><antcontrib:if></code>. The normal rules of XML namespaces apply and you can
+declare the prefix at any element to make it usable for the element it is declared on as well as all
+its child elements.</p>
</body>
</html>