Browse Source

Reviewed documentation:

- stripped trailing whitespace;
- corrected the tag soup;
- corrected Java versions (1.4 followed by 5);
- stripped inline styling (use CSS for uniformity).
master
Gintas Grigelionis 7 years ago
parent
commit
a04350e0bd
100 changed files with 1337 additions and 1647 deletions
  1. +5
    -8
      manual/Tasks/BorlandEJBTasks.html
  2. +2
    -4
      manual/Tasks/BorlandGenerateClient.html
  3. +9
    -11
      manual/Tasks/ant.html
  4. +5
    -7
      manual/Tasks/antcall.html
  5. +4
    -7
      manual/Tasks/antlr.html
  6. +5
    -5
      manual/Tasks/antstructure.html
  7. +5
    -5
      manual/Tasks/antversion.html
  8. +9
    -15
      manual/Tasks/apply.html
  9. +7
    -9
      manual/Tasks/attrib.html
  10. +1
    -1
      manual/Tasks/augment.html
  11. +2
    -4
      manual/Tasks/available.html
  12. +4
    -8
      manual/Tasks/basename.html
  13. +2
    -2
      manual/Tasks/bindtargets.html
  14. +2
    -5
      manual/Tasks/buildnumber.html
  15. +6
    -13
      manual/Tasks/cab.html
  16. +17
    -22
      manual/Tasks/ccm.html
  17. +16
    -24
      manual/Tasks/changelog.html
  18. +9
    -13
      manual/Tasks/checksum.html
  19. +9
    -13
      manual/Tasks/chgrp.html
  20. +11
    -12
      manual/Tasks/chmod.html
  21. +7
    -10
      manual/Tasks/chown.html
  22. +109
    -115
      manual/Tasks/clearcase.html
  23. +2
    -5
      manual/Tasks/common.html
  24. +2
    -3
      manual/Tasks/componentdef.html
  25. +14
    -17
      manual/Tasks/concat.html
  26. +3
    -8
      manual/Tasks/condition.html
  27. +92
    -92
      manual/Tasks/conditions.html
  28. +7
    -9
      manual/Tasks/copy.html
  29. +4
    -8
      manual/Tasks/copydir.html
  30. +2
    -4
      manual/Tasks/copyfile.html
  31. +5
    -8
      manual/Tasks/cvs.html
  32. +3
    -6
      manual/Tasks/cvspass.html
  33. +16
    -24
      manual/Tasks/cvstagdiff.html
  34. +3
    -7
      manual/Tasks/cvsversion.html
  35. +5
    -8
      manual/Tasks/defaultexcludes.html
  36. +4
    -6
      manual/Tasks/delete.html
  37. +2
    -4
      manual/Tasks/deltree.html
  38. +68
    -60
      manual/Tasks/depend.html
  39. +5
    -7
      manual/Tasks/dependset.html
  40. +4
    -6
      manual/Tasks/diagnostics.html
  41. +4
    -7
      manual/Tasks/dirname.html
  42. +6
    -9
      manual/Tasks/ear.html
  43. +4
    -9
      manual/Tasks/echo.html
  44. +3
    -7
      manual/Tasks/echoproperties.html
  45. +1
    -2
      manual/Tasks/echoxml.html
  46. +93
    -98
      manual/Tasks/ejb.html
  47. +22
    -28
      manual/Tasks/exec.html
  48. +3
    -4
      manual/Tasks/fail.html
  49. +5
    -8
      manual/Tasks/filter.html
  50. +18
    -19
      manual/Tasks/fixcrlf.html
  51. +89
    -125
      manual/Tasks/ftp.html
  52. +5
    -7
      manual/Tasks/genkey.html
  53. +20
    -22
      manual/Tasks/get.html
  54. +1
    -2
      manual/Tasks/gunzip.html
  55. +1
    -2
      manual/Tasks/gzip.html
  56. +10
    -10
      manual/Tasks/hostinfo.html
  57. +53
    -56
      manual/Tasks/image.html
  58. +5
    -7
      manual/Tasks/import.html
  59. +3
    -5
      manual/Tasks/include.html
  60. +15
    -20
      manual/Tasks/input.html
  61. +32
    -36
      manual/Tasks/jar.html
  62. +2
    -5
      manual/Tasks/jarlib-available.html
  63. +2
    -5
      manual/Tasks/jarlib-display.html
  64. +2
    -5
      manual/Tasks/jarlib-manifest.html
  65. +6
    -9
      manual/Tasks/jarlib-resolve.html
  66. +20
    -22
      manual/Tasks/java.html
  67. +32
    -46
      manual/Tasks/javac.html
  68. +4
    -8
      manual/Tasks/javacc.html
  69. +14
    -17
      manual/Tasks/javadoc.html
  70. +15
    -15
      manual/Tasks/javah.html
  71. +40
    -47
      manual/Tasks/jdepend.html
  72. +24
    -30
      manual/Tasks/jjdoc.html
  73. +63
    -75
      manual/Tasks/jjtree.html
  74. +21
    -23
      manual/Tasks/jlink.html
  75. +2
    -2
      manual/Tasks/jspc.html
  76. +34
    -35
      manual/Tasks/junit.html
  77. +11
    -12
      manual/Tasks/junitreport.html
  78. +3
    -5
      manual/Tasks/length.html
  79. +5
    -10
      manual/Tasks/loadfile.html
  80. +2
    -4
      manual/Tasks/loadproperties.html
  81. +4
    -6
      manual/Tasks/loadresource.html
  82. +1
    -2
      manual/Tasks/local.html
  83. +11
    -12
      manual/Tasks/macrodef.html
  84. +11
    -13
      manual/Tasks/mail.html
  85. +9
    -13
      manual/Tasks/manifest.html
  86. +4
    -6
      manual/Tasks/manifestclasspath.html
  87. +2
    -4
      manual/Tasks/mimemail.html
  88. +2
    -3
      manual/Tasks/mkdir.html
  89. +2
    -4
      manual/Tasks/move.html
  90. +13
    -9
      manual/Tasks/native2ascii.html
  91. +2
    -4
      manual/Tasks/netrexxc.html
  92. +2
    -4
      manual/Tasks/nice.html
  93. +2
    -3
      manual/Tasks/pack.html
  94. +15
    -17
      manual/Tasks/parallel.html
  95. +16
    -19
      manual/Tasks/patch.html
  96. +15
    -17
      manual/Tasks/pathconvert.html
  97. +9
    -16
      manual/Tasks/presetdef.html
  98. +1
    -2
      manual/Tasks/projecthelper.html
  99. +25
    -27
      manual/Tasks/property.html
  100. +9
    -13
      manual/Tasks/propertyfile.html

+ 5
- 8
manual/Tasks/BorlandEJBTasks.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="log">BorlandDeploy</a>Tool</h2>
<h2 id="log">BorlandDeploy Tool</h2>
<p>by Benoit Moussaud (<a href="mailto:benoit.moussaud@criltelecom.com">benoit.moussaud@criltelecom.com</a>)</p>


@@ -40,7 +40,7 @@ href="http://www.moussaud.org/ejbjar.html">FAQ</a> for this task at
his homepage.</p>

<h3>Borland element</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top" width="63"><b>Attribute</b></td>
<td valign="top" width="915"><b>Description</b></td>
@@ -92,11 +92,11 @@ his homepage.</p>
if you have borland in your classpath. If you do not, you should use a
nested <a href="ejb.html#ejbjar-dtd"><code>&lt;dtd&gt;</code></a> element,
described in the ejbjar task
documentation. </td>
documentation.</td>
<td align="center" valign="middle" width="62">no</td>
</tr>
<tr>
<td valign="top" width="63">generateclient </td>
<td valign="top" width="63">generateclient</td>
<td valign="top" width="915">If true, turn on the generation of the corresponding
ejbjar (default = false)</td>
<td align="center" valign="middle" width="62">no</td>
@@ -112,7 +112,7 @@ his homepage.</p>
<td align="center" valign="middle" width="62">No, defaults to 4</td>
</tr>
<tr>
<td valign="top" width="63">java2iiopParams </td>
<td valign="top" width="63">java2iiopParams</td>
<td valign="top" width="915">If filled, the params are added to the java2iiop command (ex: -no_warn_missing_define)</td>
<td align="center" valign="middle" width="62">no</td>
</tr>
@@ -136,8 +136,5 @@ his homepage.</p>
The verify phase is turned on and the generate client phase as well.
</pre>

<h3>&nbsp;</h3>

</body>
</html>


+ 2
- 4
manual/Tasks/BorlandGenerateClient.html View File

@@ -24,14 +24,14 @@

<body>

<h2><a name="log">BorlandGenerateClient</a></h2>
<h2 id="log">BorlandGenerateClient</h2>
<p>by Benoit Moussaud (<a href="mailto:benoit.moussaud@criltelecom.com">benoit.moussaud@criltelecom.com</a>)</p>
<h3>Description</h3>
<p>The BorlandGenerateClient is a task dedicated to Borland Application Server
v 4.5. It offers to generate the client jar file corresponding to an ejb jar
file.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top" width="63"><b>Attribute</b></td>
<td valign="top" width="915"><b>Description</b></td>
@@ -83,8 +83,6 @@
&lt;/classpath&gt;
&lt;/blgenclient&gt;
</pre>
<pre>&nbsp;</pre>

</body>
</html>


+ 9
- 11
manual/Tasks/ant.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="ant">Ant</a></h2>
<h2 id="ant">Ant</h2>
<h3>Description</h3>

<p>Runs Apache Ant on a supplied buildfile. This can be used to build
@@ -81,7 +81,7 @@ defined outside of targets in the new project - but not those defined
inside of targets.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -115,7 +115,7 @@ inside of targets.</p>
</tr>
<tr>
<td valign="top">output</td>
<td valign="top">Filename to write the ant output to. This is
<td valign="top">Filename to write the Ant output to. This is
relative to the value of the dir attribute if it has been set or
to the base directory of the current project otherwise.
</td>
@@ -156,11 +156,11 @@ false (see above). <br>
Note that the <code>refid</code> attribute points to a
reference in the calling project, not in the new one.</p>

<h4><a name="reference">reference</a></h4>
<h4 id="reference">reference</h4>
<p>Used to choose references that shall be copied into the new project,
optionally changing their id.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -192,7 +192,7 @@ href="../Types/propertyset.html">propertyset</a>s.</p>
instead of using the target attribute. These will be executed as if
Ant had been invoked with a single target whose dependencies are the
targets so specified, in the order specified.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -215,7 +215,7 @@ targets so specified, in the order specified.</p>
no matter what any other attribute of this task says and no matter
how deeply nested into levels of
<code>&lt;ant&gt;</code> invocations this task lives.</p>
<p>If you haven't set <code>useNativeBasedir</code> or set it to
false, the following rules apply:</p>

@@ -231,7 +231,7 @@ targets so specified, in the order specified.</p>
different <code>&lt;ant&gt;</code> (or <code>&lt;antcall&gt;</code>)
task "higher up", the following table shows the details:</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>dir attribute</b></td>
<td valign="top"><b>inheritAll attribute</b></td>
@@ -267,7 +267,7 @@ targets so specified, in the order specified.</p>
attribute will always win, but if the dir attribute has been omitted
an even more complex situation arises:</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>parent dir attribute</b></td>
<td valign="top"><b>parent inheritAll attribute</b></td>
@@ -407,7 +407,5 @@ a <code>&lt;path&gt;</code> with the id <code>path1</code>, but
<p>will copy the parent's definition of <code>path1</code> into the
new project using the id <code>path2</code>.</p>



</body>
</html>

+ 5
- 7
manual/Tasks/antcall.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="antcall">AntCall</a></h2>
<h2 id="antcall">AntCall</h2>
<h3>Description</h3>

<p>Call another target within the same buildfile optionally
@@ -75,7 +75,7 @@ persist back to the calling project.</p>
behavior of this task is undefined.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -122,11 +122,11 @@ down, even through additional <code>&lt;*ant*&gt;</code> tasks with inheritall s
false (see above).
</p>

<h4><a name="reference">reference</a></h4>
<h4 id="reference">reference</h4>
<p>Used to choose references that shall be copied into the new project,
optionally changing their id.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -158,7 +158,7 @@ href="../Types/propertyset.html">propertyset</a>s.</p>
instead of using the target attribute. These will be executed as if
Ant had been invoked with a single target whose dependencies are the
targets so specified, in the order specified.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -195,7 +195,5 @@ targets so specified, in the order specified.</p>
<p>will copy the parent's definition of <code>path1</code> into the
new project using the id <code>path2</code>.</p>



</body>
</html>

+ 4
- 7
manual/Tasks/antlr.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="antlr">ANTLR</a></h2>
<h2 id="antlr">ANTLR</h2>
<h3>Description</h3>
<p>
Invokes the <a HREF="http://www.antlr.org/" target="_top">ANTLR</a> Translator generator
@@ -63,7 +63,7 @@ for more information.</p>
</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -160,7 +160,7 @@ for more information.</p>
</tr>
</table>

<h3><a name="nested">Nested Elements</a></h3>
<h3 id="nested">Nested Elements</h3>

<p><code>ANTLR</code> supports a nested <code>&lt;classpath&gt;</code>
element, that represents a <a href="../using.html#path">PATH like
@@ -189,15 +189,12 @@ href="../using.html#arg">Command line arguments</a>.</p>
<blockquote><pre>
&lt;antlr
target=&quot;etc/java.g&quot;
outputdirectory=&quot;build/src&quot;
/&gt;
outputdirectory=&quot;build/src&quot;/&gt;
</pre></blockquote>
<p>
This invokes ANTLR on grammar file etc/java.g, writing the generated
files to build/src.
</p>


</body>
</html>


+ 5
- 5
manual/Tasks/antstructure.html View File

@@ -24,8 +24,8 @@

<body>

<h2><a name="antstructure">AntStructure</a></h2>
<h3>Description</h3>
<h2 id="antstructure">AntStructure</h2>
<h3>Description</h3>

<p>Generates an DTD for Apache Ant buildfiles which contains information
about all tasks currently known to Ant.</p>
@@ -51,11 +51,11 @@ listed as <code>#IMPLIED</code>.</p>
instead of the one that emits a DTD. In order to plug in your own
structure, you have to implement the interface
<code>org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter</code>
and <code>&lt;typedef&gt; your class and use the new type as a nested
element of this task - see the example below.</code>
and <code>&lt;typedef&gt;</code> your class and use the new type as a nested
element of this task - see the example below.

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>


+ 5
- 5
manual/Tasks/antversion.html View File

@@ -24,15 +24,15 @@

<body>

<h2><a name="antversion">Antversion</a></h2>
<h2 id="antversion">Antversion</h2>
<h3>Description</h3>
<p>
Stores the Apache Ant version (when used as task) or checks for a specific Ant version
Stores the Apache Ant version (when used as task) or checks for a specific Ant version
(when used as condition).
<b>Since Ant 1.7.0</b>
</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -41,14 +41,14 @@ Stores the Apache Ant version (when used as task) or checks for a specific Ant v
</tr>
<tr>
<td valign="top">atleast</td>
<td valign="top">The version that this at least.
<td valign="top">The version that this Ant is of at least.
The format is major.minor.point.</td>
<td valign="top" align="center">No</td>
<td valign="top" rowspan="2" align="center">One of these.</td>
</tr>
<tr>
<td valign="top">exactly</td>
<td valign="top">The version that this ant is exactly.
<td valign="top">The version that this Ant is of exactly.
The format is <tt>major.minor.point</tt>.</td>
<td valign="top" align="center">No</td>
</tr>


+ 9
- 15
manual/Tasks/apply.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="apply">Apply/<i>ExecOn</i></a></h2>
<h2 id="apply">Apply/<i>ExecOn</i></h2>
<p><i>The name <code>execon</code> is deprecated and only kept for backwards
compatibility.</i></p>
<h3>Description</h3>
@@ -40,8 +40,7 @@ href="../Types/resources.html#collection">Resource Collection</a>s
(<em>since&nbsp;Ant&nbsp;1.6</em>) or
<a href="../Types/filelist.html">FileList</a>s
(<em>since&nbsp;Ant&nbsp;1.6</em>)
&ndash;
are passed as arguments to the system command.</p>
&ndash; are passed as arguments to the system command.</p>
<p>If you specify a nested <a href="../Types/mapper.html">mapper</a>,
the timestamp of each source file is compared to the timestamp of a
target file which is defined by the nested mapper element and searched
@@ -52,8 +51,8 @@ and you must not specify more than one mapper.</p>
<p>Note that you cannot interact with the forked program, the only way
to send input to it is via the input and inputstring attributes.</p>

<h4><a name="background">Running Ant as a background process on
Unix(-like) systems</a></h4>
<h4 id="background">Running Ant as a background process on
Unix(-like) systems</h4>

<p>If you run Ant as a background process (like <code>ant &</code>)
and use the <code>&lt;apply&gt;</code> task with <code>spawn</code>
@@ -62,7 +61,7 @@ to send input to it is via the input and inputstring attributes.</p>
from the standard input.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -85,7 +84,7 @@ to send input to it is via the input and inputstring attributes.</p>
<tr>
<td valign="top">spawn</td>
<td valign="top">whether or not you want the commands to be spawned.<br>
If you spawn a command, its output will not be logged by ant.<br>
If you spawn a command, its output will not be logged by Ant.<br>
The input, output, error, and result property settings are not active when spawning a process.<br>
<em>since&nbsp;Ant&nbsp;1.6</em>
</td>
@@ -211,7 +210,7 @@ to send input to it is via the input and inputstring attributes.</p>
<tr>
<td valign="top">failifexecutionfails</td>
<td valign="top">Stop the build if we can't start the program.
Defaults to true. </td>
Defaults to true.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
@@ -338,7 +337,7 @@ end of the command line (unless you set addsourcefile to
<code>false</code>). If you need to place it somewhere different,
use a nested <code>&lt;srcfile&gt;</code> element between your
<code>&lt;arg&gt;</code> elements to mark the insertion point.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -363,7 +362,7 @@ use a nested <code>&lt;srcfile&gt;</code> element between your
filename on the command line. If omitted, the target filenames will
not be added to the command line at all. This element can only be
specified if you also define a nested mapper.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -495,10 +494,5 @@ all files in the src-directory. Because the filename itself should not be passed
to the <code>jsmin</code> program, the <code>addsourcefile</code> is set to
<code>false</code>.






</body>
</html>

+ 7
- 9
manual/Tasks/attrib.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="attrib">Attrib</a></h2>
<h2 id="attrib">Attrib</h2>
<p><em>Since Apache Ant 1.6.</em></p>
<h3>Description</h3>

@@ -33,10 +33,10 @@ directories. Right now it has effect only under Windows. Each of the
4 possible permissions has its own attribute, matching the arguments
for the attrib command.</p>

<p><a href="../Types/fileset.html">FileSet</a>s,
<p><a href="../Types/fileset.html">FileSet</a>s,
<a href="../Types/dirset.html">DirSet</a>s or <a
href="../Types/filelist.html">FileList</a>s can be specified using
nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and
nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and
<code>&lt;filelist&gt;</code> elements.</p>

<p>Starting with Ant 1.7, this task supports arbitrary <a
@@ -61,23 +61,23 @@ directory tree), so you'll have to experiment a little.</p-->
platform independent alternative.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<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" align="center"><b>Required</b></td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">the file or directory of which the permissions must be
changed.</td>
<td valign="top" valign="middle">Yes or nested
<td valign="top" align="center">Yes or nested
<code>&lt;fileset/list&gt;</code> elements.</td>
</tr>
<tr>
<td valign="top">readonly</td>
<td valign="top">the readonly permission.</td>
<td valign="top" rowspan="4">at least one of the four. </td>
<td valign="top" rowspan="4">at least one of the four.</td>
</tr>
<tr>
<td valign="top">archive</td>
@@ -164,7 +164,5 @@ directory tree), so you'll have to experiment a little.</p-->
to a FileSet with <code>id</code> <code>other.shared.sources</code> get the
same attributes.</p>


</body>
</html>


+ 1
- 1
manual/Tasks/augment.html View File

@@ -35,7 +35,7 @@ original element.
<b>Since Apache Ant 1.8.1</b></p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>


+ 2
- 4
manual/Tasks/available.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="available">Available</a></h2>
<h2 id="available">Available</h2>
<h3>Description</h3>
<p>Sets a property if a resource is available at runtime. This resource can be a
file, a directory, a class in the classpath, or a JVM system resource.</p>
@@ -34,7 +34,7 @@ something other than the default by specifying the <code>value</code> attribute.
<p>Normally, this task is used to set properties that are useful to avoid target
execution depending on system parameters.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -154,7 +154,5 @@ if the class <code>javax.xml.transform.Transformer</code> is found in the classp
if the resource-file <code>extratasks.properties</code> is found.
</p>


</body>
</html>


+ 4
- 8
manual/Tasks/basename.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="echo">Basename</a></h2>
<h2 id="echo">Basename</h2>
<h3>Description</h3>
<p>
Task to determine the basename of a specified file, optionally minus a
@@ -37,9 +37,9 @@ directory, the basename will be the last directory element. If
<code>file</code> is a full-path, relative-path, or simple filename,
the basename will be the simple file name, without any directory elements.
</p>
<p>
<p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -81,12 +81,8 @@ will set <code>cmdname</code> to <code>foo</code>.
&lt;property environment=&quot;env&quot;/&gt;
&lt;basename property=&quot;temp.dirname&quot; file=&quot;${env.TEMP}&quot;/&gt;
</pre></blockquote>

will set <code>temp.dirname</code> to the last directory element of
the path defined for the <code>TEMP</code> environment variable.</p>


the path defined for the <code>TEMP</code> environment variable.

</body>
</html>


+ 2
- 2
manual/Tasks/bindtargets.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="ant">Bindtargets</a></h2>
<h2 id="ant">Bindtargets</h2>
<h3>Description</h3>

<p>Make some target the extension of some defined
@@ -58,7 +58,7 @@ and predictable as soon as every build file is loaded.</p>
<p><b>Since Apache Ant 1.8.2</b></p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>


+ 2
- 5
manual/Tasks/buildnumber.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="buildnumber">BuildNumber</a></h2>
<h2 id="buildnumber">BuildNumber</h2>
<h3>Description</h3>
<p>This is a basic task that can be used to track build numbers.</p>
<p>It will first attempt to read a build number from a file (by default,
@@ -39,7 +39,7 @@ the number format.)
</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -67,8 +67,5 @@ the number format.)
<p>Read, increment, and write a build number to the file
<code>mybuild.number</code>.</p>



</body>
</html>


+ 6
- 13
manual/Tasks/cab.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="cab">Cab</a></h2>
<h2 id="cab">Cab</h2>
<h3>Description</h3>
<p>The cab task creates Microsoft cab archive files. It is invoked
similar to the <a href="../Tasks/jar.html">jar</a> or <a href="../Tasks/zip.html">zip</a> tasks.
@@ -42,7 +42,7 @@ supports most attributes of <code>&lt;fileset&gt;</code>
<code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and
<code>&lt;patternset&gt;</code> elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -120,16 +120,14 @@ element to specify the files to be included in the archive.
<h3>Examples</h3>
<blockquote><pre>
&lt;cab cabfile=&quot;${dist}/manual.cab&quot;
basedir=&quot;htdocs/manual&quot;
/&gt;
basedir=&quot;htdocs/manual&quot;/&gt;
</pre></blockquote>
<p>cabs all files in the htdocs/manual directory into a file called
manual.cab in the ${dist} directory.</p>
<blockquote><pre>
&lt;cab cabfile=&quot;${dist}/manual.cab&quot;
basedir=&quot;htdocs/manual&quot;
excludes=&quot;mydocs/**, **/todo.html&quot;
/&gt;
excludes=&quot;mydocs/**, **/todo.html&quot;/&gt;
</pre></blockquote>
<p>cabs all files in the htdocs/manual directory into a file called
manual.cab in the ${dist} directory. Files in the directory mydocs,
@@ -139,8 +137,7 @@ or files with the name todo.html are excluded.</p>
basedir=&quot;htdocs/manual&quot;
includes=&quot;api/**/*.html&quot;
excludes=&quot;**/todo.html&quot;
verbose=&quot;yes&quot;
/&gt;
verbose=&quot;yes&quot;/&gt;
</pre></blockquote>
<p>Cab all files in the htdocs/manual directory into a file called
manual.cab in the ${dist} directory. Only html files under the
@@ -154,14 +151,10 @@ output.</p>
&lt;fileset
dir=&quot;htdocs/manual&quot;
includes=&quot;api/**/*.html&quot;
excludes=&quot;**/todo.html&quot;
/&gt;
excludes=&quot;**/todo.html&quot;/&gt;
&lt;/cab&gt;
</pre></blockquote>
<p>is equivalent to the example above.</p>



</body>
</html>


+ 17
- 22
manual/Tasks/ccm.html View File

@@ -35,12 +35,12 @@

<p>These Apache Ant tasks are wrappers around Continuus Source Manager. They have been tested
against versions 5.1/6.2 on Windows 2000, but should work on other platforms with ccm installed.</p>
<hr>
<h2><a name="ccmcheckin">CCMCheckin</a></h2>
<hr/>
<h2 id="ccmcheckin">CCMCheckin</h2>
<h3>Description</h3>
Task to checkin a file
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0" width="598">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -76,12 +76,12 @@ Task to checkin a file
<p>Checks in the file <i>c:/wa/com/foo/MyFile.java</i>.
Comment attribute <i>mycomment</i> is added as a task comment. The task
used is the one set as the default.</p>
<hr>
<h2><a name="ccmcheckout">CCMCheckout</a></h2>
<hr/>
<h2 id="ccmcheckout">CCMCheckout</h2>
<h3>Description</h3>
Task to perform a Checkout command to Continuus
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0" width="614">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -90,7 +90,7 @@ Task to perform a Checkout command to Continuus
<tr>
<td>file</td>
<td>Path to the file that the command will operate on</td>
<td rowspan=2">Yes (file|fileset)</td>
<td rowspan="2">Yes (file|fileset)</td>
</tr>
<tr>
<td>fileset</td>
@@ -134,15 +134,12 @@ Task to perform a Checkout command to Continuus
<p>Check out all the files in the <i>lib</i> directory having the <i>.jar</i> extension.
Comment attribute <i>mycomment</i> is added as a task comment
The used task is the one set as the default.</p>



<hr>
<h2><a name="ccmcheckintask">CCMCheckinTask</a></h2>
<hr/>
<h2 id="ccmcheckintask">CCMCheckinTask</h2>
<h3>Description</h3>
Task to perform a check in default task command to Continuus
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -164,18 +161,18 @@ Task to perform a check in default task command to Continuus
<td>No</td>
</tr>
</table>
<h3>Examples </h3>
<h3>Examples</h3>
<blockquote>
<pre>&lt;ccmcheckintask comment=&quot;blahblah/&gt;
</pre>
</blockquote>
<p>Does a Checkin default task on all the checked out files in the current task.</p>
<hr>
<h2><a name="ccmreconfigure">CCMReconfigure</a></h2>
<hr/>
<h2 id="ccmreconfigure">CCMReconfigure</h2>
<h3>Description</h3>
Task to perform an reconfigure command to Continuus.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -210,12 +207,12 @@ Task to perform an reconfigure command to Continuus.
</blockquote>
<p>Does a Continuus <i>reconfigure</i> on the project <i>ANTCCM_TEST#BMO_1</i>.
</p>
<hr>
<h2><a name="ccmcreatetask">CCMCreateTask</a></h2>
<hr/>
<h2 id="ccmcreatetask">CCMCreateTask</h2>
<h3>Description</h3>
Create a Continuus task.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -266,7 +263,5 @@ Create a Continuus task.
<p>Creates a task for the release <i>ANTCCM_TEST</i> with the
current user as the resolver for this task.</p>


</body>

</html>

+ 16
- 24
manual/Tasks/changelog.html View File

@@ -24,10 +24,10 @@

<body>

<h2><a name="changelog">CvsChangeLog</a></h2>
<h2 id="changelog">CvsChangeLog</h2>
<h3>Description</h3>
<p>Generates an XML-formatted report file of the change logs recorded in a
<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository. </p>
<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository.</p>
<p><b>Important:</b> This task needs &quot;<code>cvs</code>&quot; on the path. If it isn't, you will get
an error (such as error <code>2</code> on windows). If <code>&lt;cvs&gt;</code> doesn't work, try to execute <code>cvs.exe</code>
from the command line in the target directory in which you are working.
@@ -37,7 +37,7 @@ for certain other cvs clients - like CVSNT for example - and some
operation may fail when using such an incompatible client.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -129,7 +129,7 @@ operation may fail when using such an incompatible client.
<td valign="top">remote</td>
<td valign="top">If set to true, works against the repository
(using rlog) without a working copy. Default is
false. <em>Since Ant 1.8.0</em></td>
false. <em>Since Ant 1.8.0</em></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
@@ -137,7 +137,7 @@ operation may fail when using such an incompatible client.
<td valign="top">The start of a tag range. If endTag is also
specified, they must both be on the same branch. If endTag is not
specified, the end of the range will be the latest on the same
branch on which startTag lives. <em>Since Ant 1.8.0</em></td>
branch on which startTag lives. <em>Since Ant 1.8.0</em></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
@@ -145,14 +145,13 @@ operation may fail when using such an incompatible client.
<td valign="top">The end of a tag range. If startTag is also
specified, they must both be on the same branch. If startTag is
not specified, the start of the range will be the top of the
branch on which endTag lives.</td> included in the report.
<em>Since Ant 1.8.0</em></td>
branch on which endTag lives. <em>Since Ant 1.8.0</em></td>
<td align="center" valign="top">No</td>
</tr>
</table>

<h3>Parameters specified as nested elements</h3>
<h4><a name="user">user</a></h4>
<h4 id="user">user</h4>
<p>The nested <code>&lt;user&gt;</code> element allows you to specify a
mapping between a user ID as it appears on the CVS server and a name to
include in the formatted report.
@@ -161,7 +160,7 @@ Anytime the specified user ID has made a change in the repository, the
the name specified in <code>displayname</code> rather than the user ID.
</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -186,7 +185,7 @@ the name specified in <code>displayname</code> rather than the user ID.
modules specified using this attribute can contain spaces in their
name.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -201,8 +200,7 @@ the name specified in <code>displayname</code> rather than the user ID.

<h3>Examples</h3>
<pre> &lt;cvschangelog dir=&quot;dve/network&quot;
destfile=&quot;changelog.xml&quot;
/&gt;</pre>
destfile=&quot;changelog.xml&quot;/&gt;</pre>

<p>Generates a change log report for all the changes that have been made
under the <code>dve/network</code> directory.
@@ -210,8 +208,7 @@ It writes these changes into the file <code>changelog.xml</code>.</p>

<pre> &lt;cvschangelog dir=&quot;dve/network&quot;
destfile=&quot;changelog.xml&quot;
daysinpast=&quot;10&quot;
/&gt;</pre>
daysinpast=&quot;10&quot;/&gt;</pre>

<p>Generates a change log report for any changes that were made
under the <code>dve/network</code> directory in the past 10 days.
@@ -220,8 +217,7 @@ It writes these changes into the file <code>changelog.xml</code>.</p>
<pre> &lt;cvschangelog dir=&quot;dve/network&quot;
destfile=&quot;changelog.xml&quot;
start=&quot;20 Feb 2002&quot;
end=&quot;20 Mar 2002&quot;
/&gt;</pre>
end=&quot;20 Mar 2002&quot;/&gt;</pre>

<p>Generates a change log report for any changes that were made
between February 20, 2002 and March 20, 2002
@@ -230,8 +226,7 @@ It writes these changes into the file <code>changelog.xml</code>.</p>

<pre> &lt;cvschangelog dir=&quot;dve/network&quot;
destfile=&quot;changelog.xml&quot;
start=&quot;20 Feb 2002&quot;
/&gt;</pre>
start=&quot;20 Feb 2002&quot;/&gt;</pre>

<p>Generates a change log report for any changes that were made
after February 20, 2002 under the <code>dve/network</code> directory.
@@ -254,13 +249,13 @@ It writes these changes into the file <code>changelog.xml</code>.</p>
destfile=&quot;changelogant.xml&quot; tag=&quot;ANT_16_BRANCH&quot;/&gt;
</pre>
<h4>Generate Report</h4>
<p>Ant includes a basic XSLT stylesheet that you can use to generate
<p>Ant includes a basic XSLT stylesheet that you can use to generate
a HTML report based on the xml output. The following example illustrates
how to generate a HTML report from the XML report.</p>

<pre>
&lt;style in="changelog.xml"
out="changelog.html"
&lt;style in="changelog.xml"
out="changelog.html"
style="${ant.home}/etc/changelog.xsl"&gt;
&lt;param name="title" expression="Ant ChangeLog"/&gt;
&lt;param name="module" expression="ant"/&gt;
@@ -287,8 +282,5 @@ This allows templates to be stored inside jar]]&gt;&lt;/msg&gt;
&lt;/changelog&gt;
</pre>



</body>
</html>


+ 9
- 13
manual/Tasks/checksum.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="checksum">Checksum</a></h2>
<h2 id="checksum">Checksum</h2>
<h3>Description</h3>
<p>
Generates checksum for files. This task can also be used to
@@ -53,7 +53,7 @@ or set the <tt>fileext</tt> attribute. The names of common hashing algorithms ca
</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -129,27 +129,27 @@ or set the <tt>fileext</tt> attribute. The names of common hashing algorithms ca
<tr>
<td valign="top">format</td>
<td valign="top">Specifies the pattern to use as one of a
well-known format. Supported values are
<table border="1">
well-known format. Supported values are
<table>
<tr>
<th>name</th>
<th>pattern</th>
<th>description</th>
</tr>
<tr>
<td>CHECKSUM </td>
<td>CHECKSUM</td>
<td><tt>{0}</tt></td>
<td>only the checksum itself </td>
<td>only the checksum itself</td>
</tr>
<tr>
<td>MD5SUM </td>
<td>MD5SUM</td>
<td><tt>{0} *{1}</tt></td>
<td>the format of GNU textutils md5sum</td>
</tr>
<tr>
<td>SVF </td>
<td>SVF</td>
<td><tt>MD5 ({1}) = {0}</tt></td>
<td>the format of BSDs md5 command </td>
<td>the format of BSDs md5 command</td>
</tr>
</table>
<em>Since Ant 1.7.0</em>
@@ -256,14 +256,10 @@ Works like Example 4, but only sets isChecksumEqual to true, if the
checksum matches - it will never be set to false. This example
demonstrates use with the Condition task.


<h3>Note:</h3>
When working with more than one file, if condition and/or verifyproperty is used,
the result will be true only if the checksums matched correctly for all files being
considered.



</body>
</html>


+ 9
- 13
manual/Tasks/chgrp.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="Chgrp">Chgrp</a></h2>
<h2 id="chgrp">Chgrp</h2>
<p><em>Since Apache Ant 1.6.</em></p>
<h3>Description</h3>

@@ -33,10 +33,10 @@ directories. Right now it has effect only under Unix. The group
attribute is equivalent to the corresponding argument for the chgrp
command.</p>

<p><a href="../Types/fileset.html">FileSet</a>s,
<p><a href="../Types/fileset.html">FileSet</a>s,
<a href="../Types/dirset.html">DirSet</a>s or <a
href="../Types/filelist.html">FileList</a>s can be specified using
nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and
nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and
<code>&lt;filelist&gt;</code> elements.</p>

<p>Starting with Ant 1.7, this task supports arbitrary <a
@@ -61,17 +61,17 @@ could use as initial value for these experiments.</p>
value to your current os.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<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" align="center"><b>Required</b></td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">the file or directory of which the group must be
changed.</td>
<td valign="top" valign="middle">Yes, unless nested
<td valign="top" align="center">Yes, unless nested
<code>&lt;fileset|filelist|dirset&gt;</code>
elements are specified</td>
</tr>
@@ -153,7 +153,7 @@ belong to the coders group on a UNIX system.</p>
</pre>
</blockquote>
<p>makes all files below <code>shared/sources1</code> (except those
below any directory named trial) belong to the coders group on a UNIX
below any directory named trial) belong to the coders group on a UNIX
system. In addition all files belonging to a FileSet
with <code>id</code> <code>other.shared.sources</code> get the same
group.</p>
@@ -172,14 +172,10 @@ group.</p>
</pre>
</blockquote>

<p>makes all <code>.test.jsp</code>, and <code>.new</code> files belong to
group webdev. Directories beginning with <code>test_</code> also will belong
<p>makes all <code>.test.jsp</code>, and <code>.new</code> files belong to
group webdev. Directories beginning with <code>test_</code> also will belong
to webdev, but if there is a directory that ends in <code>.new</code> or a file
that begins with <code>test_</code> it will be unaffected.</p>




</body>
</html>


+ 11
- 12
manual/Tasks/chmod.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="chmod">Chmod</a></h2>
<h2 id="chmod">Chmod</h2>
<h3>Description</h3>
<p>Changes the permissions of a file or all files inside specified
directories. Right now it has effect only under Unix or NonStop Kernel (Tandem).
@@ -37,7 +37,7 @@ write patterns.</p>
href="../Types/fileset.html">FileSet</a> and supports all of
FileSet's attributes and nested elements directly. More sets can be
specified using nested <code>&lt;fileset&gt;</code> or
<code>&lt;dirset&gt;</code> (<em>since Apache Ant 1.6</em>) elements. </p>
<code>&lt;dirset&gt;</code> (<em>since Apache Ant 1.6</em>) elements.</p>

<p>Starting with Ant 1.6, this task also supports nested <a
href="../Types/filelist.html">filelist</a>s.</p>
@@ -67,21 +67,21 @@ could use as initial value for these experiments.</p>
platform independent alternative.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<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" align="center"><b>Required</b></td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">the file or single directory of which the permissions
<td valign="top">the file or single directory of which the permissions
must be changed.</td>
<td valign="top" valign="middle" rowspan="2">exactly one of the two or nested <code>&lt;fileset/list&gt;</code> elements.</td>
<td valign="top" align="center" rowspan="2">exactly one of the two or nested <code>&lt;fileset/list&gt;</code> elements.</td>
</tr>
<tr>
<td valign="top">dir</td>
<td valign="top">the directory which holds the files whose permissions
<td valign="top">the directory which holds the files whose permissions
must be changed.<br/>
<b>Note:</b> for backwards compatibility
reasons <code>&lt;chmod&nbsp;dir="some-dir"/&gt;</code> will
@@ -167,7 +167,7 @@ UNIX system.</p>
UNIX system.</p>
<blockquote>
<pre>
&lt;chmod dir=&quot;${dist}/bin&quot; perm=&quot;ugo+rx&quot;
&lt;chmod dir=&quot;${dist}/bin&quot; perm=&quot;ugo+rx&quot;
includes=&quot;**/*.sh&quot;/&gt;
</pre>
</blockquote>
@@ -204,7 +204,7 @@ permissions.</p>
</blockquote>

<p>keeps non-owners from touching cgi scripts, files with a <code>.old</code>
extension or directories beginning with <code>private_</code>. A directory
extension or directories beginning with <code>private_</code>. A directory
ending in <code>.old</code> or a file beginning with private_ would remain
unaffected.</p>

@@ -212,17 +212,16 @@ unaffected.</p>
<h3>Note on maxparallel attribute</h3>
<p>
Some shells have a limit of the number of characters that
a command line may contain.
a command line may contain.
This maximum limit varies from shell to shell and from operating
system to operating system.
If one has a large number of files to change mode on, consider
using the <em>maxparallel</em> attribute. For example
when using AIX and the limit is reached, the system responds
with a warning: "Warning:
with a warning: "Warning:
UNIXProcess.forkAndExec native error: The parameter or environment lists
are too long". A value of about 300 seems to result in a
command line that is acceptable.
</p>
</body>
</html>


+ 7
- 10
manual/Tasks/chown.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="Chown">Chown</a></h2>
<h2 id="chown">Chown</h2>
<p><em>Since Apache Ant 1.6.</em></p>
<h3>Description</h3>

@@ -33,10 +33,10 @@ directories. Right now it has effect only under Unix. The owner
attribute is equivalent to the corresponding argument for the chown
command.</p>

<p><a href="../Types/fileset.html">FileSet</a>s,
<p><a href="../Types/fileset.html">FileSet</a>s,
<a href="../Types/dirset.html">DirSet</a>s or <a
href="../Types/filelist.html">FileList</a>s can be specified using
nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and
nested <code>&lt;fileset&gt;</code>, <code>&lt;dirset&gt;</code> and
<code>&lt;filelist&gt;</code> elements.</p>

<p>Starting with Ant 1.7, this task supports arbitrary <a
@@ -61,7 +61,7 @@ could use as initial value for these experiments.</p>
value to your current os.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -71,7 +71,7 @@ could use as initial value for these experiments.</p>
<td valign="top">file</td>
<td valign="top">the file or directory of which the owner must be
changed.</td>
<td valign="top" valign="middle">Yes or nested
<td valign="top" align="center">Yes or nested
<code>&lt;fileset/list&gt;</code> elements.</td>
</tr>
<tr>
@@ -152,7 +152,7 @@ belong to coderjoe on a UNIX system.</p>
</pre>
</blockquote>
<p>makes all files below <code>shared/sources1</code> (except those
below any directory named trial) belong to coderjoe on a UNIX
below any directory named trial) belong to coderjoe on a UNIX
system. In addition all files belonging to a FileSet
with <code>id</code> <code>other.shared.sources</code> get the same
owner.</p>
@@ -173,11 +173,8 @@ owner.</p>

<p>makes cgi scripts, files with a <code>.old</code> extension or
directories beginning with <code>private_</code> belong to the user named
webadmin. A directory ending in <code>.old</code> or a file beginning with
webadmin. A directory ending in <code>.old</code> or a file beginning with
<code>private_</code> would remain unaffected.</p>



</body>
</html>


+ 109
- 115
manual/Tasks/clearcase.html View File

@@ -35,25 +35,25 @@ Sean Egan (sean at cm-logic dot com)</p>
<h1>ClearCase Support</h1>
<h2>Table of Contents</h2>
<ul>
<li><A href="#introduction">Introduction</a>
<li><A href="#cccheckin">CCCheckin</a>
<li><A href="#cccheckout">CCCheckout</a>
<li><A href="#ccuncheckout">CCUnCheckout</a>
<li><A href="#ccupdate">CCUpdate</a>
<li><A href="#ccmklbtype">CCMklbtype</a>
<li><A href="#ccmklabel">CCMklabel</a>
<li><A href="#ccrmtype">CCRmtype</a>
<li><A href="#cclock">CCLock</a>
<li><A href="#ccunlock">CCUnlock</a>
<li><A href="#ccmkbl">CCMkbl</a>
<li><A href="#ccmkattr">CCMkattr</a>
<li><A href="#ccmkdir">CCMkdir</a>
<li><A href="#ccmkelem">CCMkelem</a></li>
<li><a href="#introduction">Introduction</a>
<li><a href="#cccheckin">CCCheckin</a>
<li><a href="#cccheckout">CCCheckout</a>
<li><a href="#ccuncheckout">CCUnCheckout</a>
<li><a href="#ccupdate">CCUpdate</a>
<li><a href="#ccmklbtype">CCMklbtype</a>
<li><a href="#ccmklabel">CCMklabel</a>
<li><a href="#ccrmtype">CCRmtype</a>
<li><a href="#cclock">CCLock</a>
<li><a href="#ccunlock">CCUnlock</a>
<li><a href="#ccmkbl">CCMkbl</a>
<li><a href="#ccmkattr">CCMkattr</a>
<li><a href="#ccmkdir">CCMkdir</a>
<li><a href="#ccmkelem">CCMkelem</a></li>

</ul>

<hr>
<h2><a name="introduction">Introduction</a></h2>
<hr/>
<h2 id="introduction">Introduction</h2>
<p>Apache Ant provides several optional tasks for working with ClearCase. These tasks correspond to various
ClearCase commands using the Cleartool program. The current tasks available for Ant correspond to only
a few of the significant ClearCase commands.</p>
@@ -67,12 +67,12 @@ functionality that is specific to that ClearCase command.</p>
</p>


<hr>
<h2><a name="cccheckin">CCCheckin</a></h2>
<hr/>
<h2 id="cccheckin">CCCheckin</h2>
<h3>Description</h3>
Task to perform a "cleartool checkin" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -135,12 +135,12 @@ Task to perform a "cleartool checkin" command to ClearCase.
Comment text from the file <i>acomment.txt</i> is added to ClearCase as a comment.
All warning messages are suppressed. The file is checked in even if it is
<i>identical</i> to the original.</p>
<hr>
<h2><a name="cccheckout">CCCheckout</a></h2>
<hr/>
<h2 id="cccheckout">CCCheckout</h2>
<h3>Description</h3>
Task to perform a "cleartool checkout" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -197,13 +197,13 @@ Task to perform a "cleartool checkout" command to ClearCase.
<tr>
<td>notco</td>
<td>Fail if it's already checked out to the current view. Set to false to ignore it.<br>
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true.<br>
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>
</table>
@@ -221,12 +221,12 @@ Task to perform a "cleartool checkout" command to ClearCase.
It is checked out as <i>reserved</i> on branch called <i>abranch</i>. All
warning messages are suppressed. A <i>Some comment text</i> is added to
ClearCase as a comment.</p>
<hr>
<h2><a name="ccuncheckout">CCUnCheckout</a></h2>
<hr/>
<h2 id="ccuncheckout">CCUnCheckout</h2>
<h3>Description</h3>
Task to perform a UnCheckout command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -246,8 +246,8 @@ Task to perform a UnCheckout command to ClearCase.
</tr>
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true<br>
Since ant 1.6.1</td>
<td>Throw an exception if the command fails. Default is true.<br>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>
</table>
@@ -260,12 +260,12 @@ Task to perform a UnCheckout command to ClearCase.
</blockquote>
<p>Does a ClearCase <i>uncheckout</i> on the file <i>c:/views/viewdir/afile</i>.
A copy of the file called <i>c:/views/viewdir/afile.keep</i> is kept.</p>
<hr>
<h2><a name="ccupdate">CCUpdate</a></h2>
<hr/>
<h2 id="ccupdate">CCUpdate</h2>
<h3>Description</h3>
Task to perform an "cleartool update" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -314,7 +314,7 @@ Task to perform an "cleartool update" command to ClearCase.
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true.<br>
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>
</table>
@@ -333,15 +333,12 @@ Task to perform an "cleartool update" command to ClearCase.
A graphical dialog will be displayed. The output will be logged to
<i>log.log</i> and it will overwrite any hijacked files. The modified
time will be set to the current time.</p>



<hr>
<h2><a name="ccmklbtype">CCMklbtype</a></h2>
<hr/>
<h2 id="ccmklbtype">CCMklbtype</h2>
<h3>Description</h3>
Task to perform a "mklbtype" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -369,7 +366,7 @@ Task to perform a "mklbtype" command to ClearCase.
<tr>
<tr>
<td>ordinary</td>
<td>Either global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. <B>Default</B></td>
<td>Either global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. <b>Default</b></td>
<td>No</td>
<tr>
<tr>
@@ -394,8 +391,8 @@ Task to perform a "mklbtype" command to ClearCase.
<tr></tr>
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true<br>
Since ant 1.6.1</td>
<td>Throw an exception if the command fails. Default is true.<br>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>
</table>
@@ -411,14 +408,12 @@ Task to perform a "mklbtype" command to ClearCase.
<p>Does a ClearCase <i>mklbtype</i> to create a label type named <i>VERSION_1</i>.
It is created as <i>ordinary</i> so it is available only to the current VOB.
The text <i>Development version 1</i> is added as a comment.</p>


<hr>
<h2><a name="ccmklabel">CCMklabel</a></h2>
<hr/>
<h2 id="ccmklabel">CCMklabel</h2>
<h3>Description</h3>
Task to perform a "mklabel" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -466,8 +461,8 @@ Task to perform a "mklabel" command to ClearCase.
<tr></tr>
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true<br>
Since ant 1.6.1</td>
<td>Throw an exception if the command fails. Default is true.<br>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>
</table>
@@ -485,14 +480,12 @@ Task to perform a "mklabel" command to ClearCase.
<p>Does a ClearCase <i>mklabel</i> on the file <i>c:/views/viewdir/afile</i> under
the main branch for version 2 (<i>\main\2</i>). Text <i>Some comment text</i> is added
as a comment. It will <i>recurse</i> all subdirectories.


<hr>
<h2><a name="ccrmtype">CCRmtype</a></h2>
<hr/>
<h2 id="ccrmtype">CCRmtype</h2>
<h3>Description</h3>
Task to perform a "rmtype" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -501,30 +494,41 @@ Task to perform a "rmtype" command to ClearCase.
<tr>
<td>typekind</td>
<td>The kind of type to create. Valid types are:
<table border="0" width="40%">
<table>
<tr>
<td>Kind</td>
<td>&nbsp;</td>
<td>Description</td>
</tr>
<tr>
<td width="15%"> </td>
<td><b>attype</b><br>
<b>brtype</b><br>
<b>eltype</b><br>
<b>hltype</b><br>
<b>lbtype</b><br>
<b>trtype</b>
</td>
<td>- <br>
- <br>
- <br>
- <br>
- <br>
-
</td>
<td>attribute type<br>
branch type<br>
element type<br>
hyperlink type<br>
label type<br>
trigger type
</td>
<td><b>attype</b></td>
<td>-</td>
<td>attribute type</td>
</tr>
<tr>
<td><b>brtype</b></td>
<td>-</td>
<td>branch type</td>
</tr>
<tr>
<td><b>eltype</b></td>
<td>-</td>
<td>element type</td>
</tr>
<tr>
<td><b>hltype</b></td>
<td>-</td>
<td>hyperlink type</td>
</tr>
<tr>
<td><b>lbtype</b></td>
<td>-</td>
<td>label type</td>
</tr>
<tr>
<td><b>trtype</b></td>
<td>-</td>
<td>trigger type</td>
</tr>
</table>
</td>
@@ -558,7 +562,7 @@ Task to perform a "rmtype" command to ClearCase.
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>
</table>
@@ -575,13 +579,12 @@ Task to perform a "rmtype" command to ClearCase.
<p>Does a ClearCase <i>rmtype</i> to remove a label type (<i>lbtype</i>) named <i>VERSION_1</i>.
Comment text from the file <i>acomment.txt</i> is added as a comment. All instances of the type
are removed, including the type object itself.</p>
<hr>

<h2><a name="cclock">CCLock</a></h2>
<hr/>
<h2 id="cclock">CCLock</h2>
<h3>Description</h3>
Task to perform a "cleartool lock" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -619,13 +622,13 @@ Task to perform a "cleartool lock" command to ClearCase.
<tr>
<td>objsel</td>
<td>Specifies the object(s) to be locked.<br>
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
<tr>
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true.<br>
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>

@@ -634,18 +637,16 @@ Task to perform a "cleartool lock" command to ClearCase.
<blockquote>
<pre>
&lt;cclock
objsel="stream:Application_Integration@\MyProject_PVOB"
/&gt;
objsel="stream:Application_Integration@\MyProject_PVOB"/&gt;
</pre>
</blockquote>
<p>Does a ClearCase <i>lock</i> on the object <i>stream:Application_Integration@\MyProject_PVOB</i>.</p>
<hr>

<h2><a name="ccunlock">CCUnlock</a></h2>
<h2 id="ccunlock">CCUnlock</h2>
<h3>Description</h3>
Task to perform a "cleartool unlock" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -668,13 +669,13 @@ Task to perform a "cleartool unlock" command to ClearCase.
<tr>
<td>objsel</td>
<td>Specifies the object(s) to be unlocked.<br>
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
<tr>
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true.<br>
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>

@@ -683,18 +684,16 @@ Task to perform a "cleartool unlock" command to ClearCase.
<blockquote>
<pre>
&lt;ccunlock
objsel="stream:Application_Integration@\MyProject_PVOB"
/&gt;
objsel="stream:Application_Integration@\MyProject_PVOB"/&gt;
</pre>
</blockquote>
<p>Does a ClearCase <i>unlock</i> on the object <i>stream:Application_Integration@\MyProject_PVOB</i>.</p>
<hr>

<h2><a name="ccmkbl">CCMkbl</a></h2>
<h2 id="ccmkbl">CCMkbl</h2>
<h3>Description</h3>
Task to perform a "cleartool mkbl" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -741,7 +740,7 @@ previous baseline.</td>
<tr>
<td>failonerr</td>
<td>Throw an exception if the command fails. Default is true.<br>
Since ant 1.6.1</td>
<em>Since Ant 1.6.1</em></td>
<td>No</td>
</tr>
</table>
@@ -752,21 +751,19 @@ previous baseline.</td>
baselinerootname="Application_Baseline_AUTO"
identical="yes"
full="no"
viewpath="v:\ApplicationCC"
/&gt;
viewpath="v:\ApplicationCC"/&gt;
</pre>
</blockquote>
<p>Does a ClearCase <i>mkbl</i> on the Integration view at <i>v:\ApplicationCC</i>
even if it is <i>identical</i> to a previous baseline. The new baseline with be
incremental and named "Application_Baseline_AUTO".</p>
<hr>

<h2><a name="ccmkattr">CCMkattr</a></h2>
<h2 id="ccmkattr">CCMkattr</h2>
<h3>Description</h3>
Task to perform a &quot;cleartool mkattr&quot; command to ClearCase.<br>
Since ant 1.6.1
<em>Since Ant 1.6.1</em>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -823,20 +820,18 @@ Since ant 1.6.1
<pre>
&lt;ccmkattr viewpath=&quot;c:/views/viewdir/afile&quot;
typename=&quot;BugFix&quot;
typevalue=&quot;34445&quot;
/&gt;
typevalue=&quot;34445&quot;/&gt;
</pre>
</blockquote>
<p>Does a ClearCase <i>mkattr</i> on the file <i>c:/views/viewdir/afile</i> and
attaches the attribute <i>BugFix</i> with a value of <i>34445</i> to it.</p>
<hr>

<h2><a name="ccmkdir">CCMkdir</a></h2>
<hr/>
<h2 id="ccmkdir">CCMkdir</h2>
<h3>Description</h3>
Task to perform a &quot;cleartool mkdir&quot; command to ClearCase.<br>
Since ant 1.6.1
<em>Since Ant 1.6.1</em>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -878,14 +873,13 @@ Since ant 1.6.1
</blockquote>
<p>Does a ClearCase <i>mkdir</i> on the dir <i>c:/views/viewdir/adir</i> and
does not automatically check it out.</p>
<hr>

<h2><a name="ccmkelem">CCMkelem</a></h2>
<hr/>
<h2 id="ccmkelem">CCMkelem</h2>
<h3>Description</h3>
Task to perform a &quot;cleartool mkelem&quot; command to ClearCase.<br>
Since ant 1.6.1
<em>Since Ant 1.6.1</em>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<th>Attribute</th>
<th>Values</th>


+ 2
- 5
manual/Tasks/common.html View File

@@ -24,10 +24,10 @@

<body>

<h2><a name="javac">Common Attributes of all Tasks</a></h2>
<h2 id="javac">Common Attributes of all Tasks</h2>
<p>All tasks share the following attributes:</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -52,8 +52,5 @@
</tr>
</table>



</body>
</html>


+ 2
- 3
manual/Tasks/componentdef.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="componentdef">componentdef</a></h2>
<h2 id="componentdef">componentdef</h2>
<h3>Description</h3>
<p>
Adds a component definition to the current project.
@@ -54,9 +54,8 @@
classname="com.apache.tools.ant.types.resources.selectors.Or"/&gt;</pre>
<p>
defines two components with the same name "or"; one is a condition
(see <a href="conditions.html">conditions</a>) and one is
(see <a href="conditions.html">conditions</a>) and one is
a selector (see <a href="../Types/selectors.html">selectors</a>).
</p>
</body>
</html>


+ 14
- 17
manual/Tasks/concat.html View File

@@ -19,17 +19,17 @@
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Concat</title>
<title>Concat</title>
</head>

<body>

<h2><a name="Concat">Concat</a></h2>
<h2 id="concat">Concat</h2>

<h3>Description</h3>

<p>
Concatenates one or more
Concatenates one or more
<a href="../Types/resources.html">resource</a>s
to a single file or to the console. The destination
file will be created if it does not exist unless the resource
@@ -38,7 +38,7 @@

<p><strong>Since Apache Ant 1.7.1</strong>, this task can be used as a
<a href="../Types/resources.html#collection">Resource Collection</a>
that will return exactly one
that will return exactly one
<a href="../Types/resources.html">resource</a>.
</p>

@@ -51,7 +51,7 @@ Resource Collection</a>s are used to

<h3>Parameters</h3>

<table border="1" cellpadding="2" cellspacing="0">
<table>

<tr>
<td valign="top"><b>Attribute</b></td>
@@ -93,7 +93,7 @@ Resource Collection</a>s are used to
<td valign="top">
Specifies whether or not the file specified by 'destfile'
should be written to even if it is newer than all source files.
<em>since Ant 1.8.2</em>.
<em>Since Ant 1.8.2</em>.
Defaults to &quot;yes&quot;.
</td>
<td valign="top" align="center">No</td>
@@ -102,7 +102,7 @@ Resource Collection</a>s are used to
<tr>
<td valign="top">forceReadOnly</td>
<td valign="top">Overwrite read-only destination
files. <em>since Ant 1.8.2</em></td>
files. <em>Since Ant 1.8.2</em></td>
<td valign="top" align="center">No; defaults to false.</td>
</tr>

@@ -121,7 +121,7 @@ Resource Collection</a>s are used to
<td valign="top">outputencoding</td>
<td valign="top">
The encoding to use when writing the output file
<em>since Ant 1.6</em>.
<em>Since Ant 1.6</em>.
Defaults to the value of the encoding attribute
if given or the default JVM encoding otherwise.
</td>
@@ -135,7 +135,7 @@ Resource Collection</a>s are used to
a new line. If this attribute is &quot;yes&quot;
a new line will be appended to the stream if
the file did not end in a new line.
<em>since Ant 1.6</em>.
<em>Since Ant 1.6</em>.
Defaults to &quot;no&quot;.
This attribute does not apply to embedded text.
</td>
@@ -146,7 +146,7 @@ Resource Collection</a>s are used to
<td valign="top">
Specifies what the end of line character are
for use by the fixlastline attribute.
<em>since Ant 1.6</em>
<em>Since Ant 1.6</em>
Valid values for this property are:
<ul>
<li>cr: a single CR</li>
@@ -167,7 +167,7 @@ Resource Collection</a>s are used to
<tr>
<td valign="top">binary</td>
<td valign="top">
<em>since Ant 1.6.2</em>
<em>Since Ant 1.6.2</em>
If this attribute is set to true, the task concatenates the files
in a byte by byte fashion. If this attribute is false, concat will
not normally work for binary files due to character encoding
@@ -221,7 +221,7 @@ Resource Collection</a>s are used to
<p><em>since Ant 1.6</em>.</p>
<p>Used to prepend or postpend text into the concatenated stream.</p>
<p>The text may be in-line or be in a file.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -292,7 +292,7 @@ Resource Collection</a>s are used to
&lt;/concat&gt;
</pre>

<p><b>Concatenate a series of files, expanding ant properties</b></p>
<p><b>Concatenate a series of files, expanding Ant properties</b></p>
<pre>
&lt;concat destfile="${build.dir}/subs"&gt;
&lt;path&gt;
@@ -330,8 +330,5 @@ Resource Collection</a>s are used to
&lt;/concat&gt;
</pre>


</body>

</html>
</html>

+ 3
- 8
manual/Tasks/condition.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="Condition">Condition</a></h2>
<h2 id="condition">Condition</h2>
<h3>Description</h3>
<p>Sets a property if a certain condition holds true - this is a
generalization of <a href="available.html">Available</a> and <a
@@ -36,7 +36,7 @@ attribute.</p>
<p>Conditions are specified as <a href="#nested">nested elements</a>,
you must specify exactly one condition.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -62,7 +62,7 @@ you must specify exactly one condition.</p>
<td valign="top" align="center">No</td>
</tr>
</table>
<h3><a name="nested">Parameters specified as nested elements</a></h3>
<h3 id="nested">Parameters specified as nested elements</h3>
<p>All conditions to test are specified as nested elements, for a
complete list see <a href="conditions.html">here</a>.</p>

@@ -83,10 +83,8 @@ classpath.</p>
&lt;condition property=&quot;isMacOsButNotMacOsX&quot;&gt;
&lt;and&gt;
&lt;os family=&quot;mac&quot;/&gt;

&lt;not&gt;
&lt;os family=&quot;unix&quot;/&gt;

&lt;/not&gt;
&lt;/and&gt;
&lt;/condition&gt;
@@ -98,13 +96,10 @@ in the Unix family as well.</p>
<pre>
&lt;condition property=&quot;isSunOSonSparc&quot;&gt;
&lt;os name=&quot;SunOS&quot; arch=&quot;sparc&quot;/&gt;

&lt;/condition&gt;
</pre>
<p>sets the property <code>isSunOSonSparc</code> if the current
operating system is SunOS and if it is running on a sparc architecture.</p>



</body>
</html>

+ 92
- 92
manual/Tasks/conditions.html View File

@@ -24,8 +24,8 @@

<body>

<h2><a name="Conditions">Conditions</a></h2>
<p>Conditions are nested elements of the
<h2 id="conditions">Conditions</h2>
<p>Conditions are nested elements of the
<a href="condition.html"><code>&lt;condition&gt;</code></a> and
<a href="waitfor.html"><code>&lt;waitfor&gt;</code></a> tasks.
There are core conditions and custom conditions. Custom
@@ -34,20 +34,20 @@
Custom Conditions</a>.
Core Conditions are described below.
</p>
<h3><a name="coreconditions">Core Conditions</a></h3>
<h3 id="coreconditions">Core Conditions</h3>

<p>These are the nested elements that can be used as conditions in the
<a href="condition.html"><code>&lt;condition&gt;</code></a> and
<a href="waitfor.html"><code>&lt;waitfor&gt;</code></a> tasks.</p>

<h4><a name="not">not</a></h4>
<h4 id="not">not</h4>
<p>The <code>&lt;not&gt;</code> element expects exactly one other
condition to be nested into this element, negating the result of the
condition. It doesn't have any attributes and accepts all nested
elements of the condition task as nested elements as well.</p>

<h4><a name="and">and</a></h4> <p>
The <code>&lt;and&gt;</code> element doesn't have any attributes and
<h4 id="and">and</h4>
<p>The <code>&lt;and&gt;</code> element doesn't have any attributes and
accepts an arbitrary number of conditions as nested elements - all
nested elements of the condition task are supported. This condition
is true if all of its contained conditions are, conditions will be
@@ -56,17 +56,18 @@ evaluated in the order they have been specified in the build file.</p>
semantics as the Java &amp;&amp; operator, as soon as one of the
nested conditions is false, no other condition will be evaluated.</p>

<h4><a name="or">or</a></h4> <p>
The <code>&lt;or&gt;</code> element doesn't have any attributes and
<h4 id="or">or</h4>
<p>The <code>&lt;or&gt;</code> element doesn't have any attributes and
accepts an arbitrary number of conditions as nested elements - all
nested elements of the condition task are supported. This condition
is true if at least one of its contained conditions is, conditions
will be evaluated in the order they have been specified in the build
file.</p> <p>The <code>&lt;or&gt;</code> condition has the same
file.</p>
<p>The <code>&lt;or&gt;</code> condition has the same
shortcut semantics as the Java || operator, as soon as one of the
nested conditions is true, no other condition will be evaluated.</p>

<h4><a name="xor">xor</a></h4>
<h4 id="xor">xor</h4>
<p>The <code>&lt;xor&gt;</code> element performs an exclusive
or on all nested elements, similar to the <code>^</code> operator
in Java. It only evaluates to true if an odd number of nested conditions
@@ -75,24 +76,24 @@ and <code>&lt;or&gt;</code> tests.
It doesn't have any attributes and accepts all nested
elements of the condition task as nested elements as well.</p>

<h4><a name="available">available</a></h4>
<h4 id="available">available</h4>
<p>This condition is identical to the <a
href="available.html">Available</a> task, all attributes and nested
elements of that task are supported, the property and value attributes
are redundant and will be ignored.</p>

<h4><a name="uptodate">uptodate</a></h4>
<h4 id="uptodate">uptodate</h4>
<p>This condition is identical to the <a
href="uptodate.html">Uptodate</a> task, all attributes and nested
elements of that task are supported, the property and value attributes
are redundant and will be ignored.</p>

<h4><a name="os">os</a></h4>
<h4 id="os">os</h4>
<p>Test whether the current operating system is of a given type. Each
defined attribute is tested and the result is true only if <i>all</i>
the tests succeed.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -137,9 +138,9 @@ the tests succeed.
<li>openvms for OpenVMS</li>
</ul>

<h4><a name="equals">equals</a></h4>
<h4 id="equals">equals</h4>
<p>Tests whether the two given values are equal.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -176,9 +177,9 @@ the tests succeed.
</tr>
</table>

<h4><a name="isset">isset</a></h4>
<h4 id="isset">isset</h4>
<p>Test whether a given property has been set in this project.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -191,17 +192,17 @@ the tests succeed.
</tr>
</table>

<h4><a name="checksum">checksum</a></h4>
<h4 id="checksum">checksum</h4>
<p>This condition is identical to the <a href="checksum.html">Checksum</a>
task, all attributes and nested elements of that task are supported,
the property and overwrite attributes are redundant and will be
ignored.</p>

<h4><a name="http">http</a></h4>
<h4 id="http">http</h4>
<p>The <code>http</code> condition checks for a valid response from a
web server of the specified url. By default, HTTP responses errors
of 400 or greater are viewed as invalid.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -238,10 +239,10 @@ of 400 or greater are viewed as invalid.</p>
</tr>
</table>

<h4><a name="socket">socket</a></h4>
<h4 id="socket">socket</h4>
<p>The <code>socket</code> condition checks for the existence of a
TCP/IP listener at the specified host and port.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -259,7 +260,7 @@ TCP/IP listener at the specified host and port.</p>
</tr>
</table>

<h4><a name="filesmatch">filesmatch</a></h4>
<h4 id="filesmatch">filesmatch</h4>
<p>Test two files for matching. Nonexistence of one file results in "false",
although if neither exists they are considered equal in terms of content.
This test does a byte for byte comparison, so test time scales with
@@ -267,7 +268,7 @@ byte size. NB: if the files are different sizes, one of them is missing
or the filenames match the answer is so obvious the detailed test is omitted.

</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -287,15 +288,15 @@ or the filenames match the answer is so obvious the detailed test is omitted.
<td valign="top">textfile</td>
<td valign="top">Whether to ignore line endings when comparing
files; defaults to <i>false</i> which triggers a binary
comparison. <b>Since Ant 1.7</b>
comparison. <i>Since Ant 1.7</i>
</td>
<td align="center">No</td>
</tr>
</table>

<h4><a name="contains">contains</a></h4>
<h4 id="contains">contains</h4>
<p>Tests whether a string contains another one.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -319,10 +320,10 @@ or the filenames match the answer is so obvious the detailed test is omitted.
</tr>
</table>

<h4><a name="istrue">istrue</a></h4>
<p>Tests whether a string equals any of the ant definitions of true,
<h4 id="istrue">istrue</h4>
<p>Tests whether a string equals any of the Ant definitions of true,
that is "true","yes", or "on"</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -339,10 +340,10 @@ that is "true","yes", or "on"</p>
&lt;istrue value=&quot;false&quot;/&gt;
</pre></blockquote>

<h4><a name="isfalse">isfalse</a></h4>
<h4 id="isfalse">isfalse</h4>
<p>Tests whether a string is not true, the negation of &lt;istrue&gt;
</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -359,14 +360,13 @@ that is "true","yes", or "on"</p>
&lt;isfalse value=&quot;false&quot;/&gt;
</pre></blockquote>

<h4><a name="isreference">isreference</a></h4>

<h4 id="isreference">isreference</h4>
<p>Test whether a given reference has been defined in this project and
- optionally - is of an expected type.</p>

<p>This condition has been added in Apache Ant 1.6.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -385,7 +385,7 @@ that is "true","yes", or "on"</p>
</tr>
</table>

<h4><a name="issigned">issigned</a></h4>
<h4 id="issigned">issigned</h4>
<p>
Test whether a jarfile is signed.
If the name of the
@@ -397,7 +397,7 @@ that is "true","yes", or "on"</p>
<p>
This condition was added in Apache Ant 1.7.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -418,7 +418,7 @@ that is "true","yes", or "on"</p>
</tr>
</table>

<h4><a name="isfileselected">isfileselected</a></h4>
<h4 id="isfileselected">isfileselected</h4>
<p>
Test whether a file passes an embedded
<a href="../Types/selectors.html">selector</a>.
@@ -426,7 +426,7 @@ that is "true","yes", or "on"</p>
<p>
This condition was added in Apache Ant 1.6.3.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -455,7 +455,7 @@ that is "true","yes", or "on"</p>
&lt;/isfileselected&gt;
</pre></blockquote>

<h4><a name="typefound">typefound</a></h4>
<h4 id="typefound">typefound</h4>

<p>Test whether a given type is defined, and that
its implementation class can be loaded. Types include
@@ -463,7 +463,7 @@ tasks, datatypes, scriptdefs, macrodefs and presetdefs.</p>

<p>This condition was added in Apache Ant 1.7.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -491,7 +491,7 @@ tasks, datatypes, scriptdefs, macrodefs and presetdefs.</p>
&lt;typefound uri="antlib:org.apache.maven.artifact.ant" name="artifact"/&gt;
</pre></blockquote>

<h4><a name="scriptcondition">scriptcondition</a></h4>
<h4 id="scriptcondition">scriptcondition</h4>

<p>Evaluate a condition based on a script in any
<a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a>
@@ -506,7 +506,7 @@ an explanation of scripts and dependencies.

<p>This condition was added in Apache Ant 1.7.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -529,8 +529,8 @@ an explanation of scripts and dependencies.
<tr>
<td valign="top">value</td>
<td valign="top">default boolean value</td>
<td valign="top" align="center">No -default is "false"</td>
</tr>
<td valign="top" align="center">No - default is "false"</td>
</tr>
<tr>
<td valign="top">src</td>
<td valign="top">filename of script source</td>
@@ -585,10 +585,10 @@ Example:
&lt;/scriptcondition&gt;
</pre></blockquote>

Sets the default value of the condition to true, then in the script,
Sets the default value of the condition to true, then in the script,
sets the value to false. This condition always evaluates to "false"

<h4><a name="parsersupports">parsersupports</a></h4>
<h4 id="parsersupports">parsersupports</h4>

<p>Tests whether Ant's XML parser supports a given
feature or property, as per the SAX/JAXP specifications, by
@@ -596,7 +596,7 @@ attempting to set the appropriate property/feature/</p>

<p>This condition was added in Apache Ant 1.7.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -642,12 +642,12 @@ Check for XML Schema support.

Check for Xerces-specific definition of the location of the no namespace schema.

<h4><a name="isreachable">isreachable</a></h4>
<h4 id="isreachable">isreachable</h4>

<p>Uses Java1.5+ networking APIs to probe for a (remote) system being
<p>Uses Java 5+ networking APIs to probe for a (remote) system being
reachable. Exactly what probe mechanisms are used is an implementation
feature of the JVM. They may include ICMP "ping" packets, UDP or TCP connections
to port 7 "echo service" or other means. On Java1.4 and earlier, being able
to port 7 "echo service" or other means. On Java 1.4 and earlier, being able
to resolve the hostname is considered success. This means that if DNS is not
working or a URL/hostname is bad, the test will fail, but otherwise succeed
even if the remote host is actually absent.
@@ -672,7 +672,7 @@ not reachable on other ports (i.e. port 80), because of firewalls.

This condition was added in Apache Ant 1.7.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -715,10 +715,10 @@ Probe for the maven repository being reachable.
Probe for the maven repository being reachable using the hostname, ten second timeout..
</p>

<h4><a name="length">length</a></h4>
<h4 id="length">length</h4>
<p>This condition is a facet of the <a href="length.html">Length</a> task.
It is used to test the length of a string or one or more files.
<b>Since Ant 1.6.3</b>
<i>Since Ant 1.6.3</i>
</p>

<blockquote><pre>
@@ -731,12 +731,12 @@ Probe for the maven repository being reachable using the hostname, ten second ti
</pre></blockquote>
<p>Verify that file <i>foo</i> is not empty.</p>

<h4><a name="isfailure">isfailure</a></h4>
<h4 id="isfailure">isfailure</h4>

<p>Test the return code of an executable (see the
<a href="exec.html">Exec</a> task) for failure. <b>Since Ant 1.7</b></p>
<a href="exec.html">Exec</a> task) for failure. <i>Since Ant 1.7</i></p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -749,12 +749,12 @@ Probe for the maven repository being reachable using the hostname, ten second ti
</tr>
</table>

<h4><a name="resourcecount">resourcecount</a></h4>
<h4 id="resourcecount">resourcecount</h4>
<p>This condition is a facet of the
<a href="resourcecount.html">ResourceCount</a> task.
It is used to test the size of a
It is used to test the size of a
<a href="../Types/resources.html#collection">resource collection</a>.
<b>Since Ant 1.7</b>
<i>Since Ant 1.7</i>
</p>

<blockquote><pre>
@@ -762,7 +762,7 @@ Probe for the maven repository being reachable using the hostname, ten second ti
</pre></blockquote>
<p>Verify that a resource collection is not empty.</p>

<h4><a name="resourcesmatch">resourcesmatch</a></h4>
<h4 id="resourcesmatch">resourcesmatch</h4>
<p>Test resources for matching. Nonexistence of one or more resources results in
"false", although if none exists they are considered equal in terms of content.
By default this test does a byte for byte comparison, so test time scales with
@@ -771,9 +771,9 @@ or the filenames match the answer is so obvious the detailed test is omitted.
The resources to check are specified as nested
<a href="../Types/resources.html#collection">resource collections</a>,
meaning that more than two resources can be checked; in this case all resources
must match. <b>Since Ant 1.7</b>
must match. <i>Since Ant 1.7</i>
</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -789,12 +789,12 @@ must match. <b>Since Ant 1.7</b>
</tr>
</table>

<h4><a name="resourcecontains">resourcecontains</a></h4>
<h4 id="resourcecontains">resourcecontains</h4>
<p>Tests whether a resource contains a given (sub)string.</p>
<p>The resources to check are specified via references or - in the
case of file resources via the resource attribute. <b>Since Ant 1.7.1</b>
case of file resources via the resource attribute. <i>Since Ant 1.7.1</i>
</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -823,15 +823,16 @@ must match. <b>Since Ant 1.7</b>
</tr>
</table>

<h4><a name="hasmethod">hasmethod</a></h4>
<h4 id="hasmethod">hasmethod</h4>

<p>
Tests for a class having a method or field. If the class is not found
or fails to load, the build fails.

<p> Tests for a class having a method or field. If the class is not found
or fails to load, the build fails.
<b>Since Ant 1.7</b>
<i>Since Ant 1.7</i>
</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -852,7 +853,7 @@ must match. <b>Since Ant 1.7</b>
<td valign="top">name of a method to look for</td>
<td align="center">one of field or method</td>
</tr>
<tr>
<td valign="top">ignoreSystemClasses</td>
<td valign="top">should system classes be ignored?</td>
@@ -871,7 +872,7 @@ must match. <b>Since Ant 1.7</b>
</table>

<p>
There is also a nested &lt;classpath&gt; element, which can be used to specify
There is also a nested &lt;classpath&gt; element, which can be used to specify
a classpath.
</p>
<blockquote><pre>
@@ -880,14 +881,14 @@ must match. <b>Since Ant 1.7</b>

<p>Looks for the method trimToSize in the ArrayList class.</p>

<h4><a name="matches">matches</a></h4>
<h4 id="matches">matches</h4>

<p>
Test if the specified string matches the specified regular
expression pattern.
<b>Since Ant 1.7</b></p>
<i>Since Ant 1.7</i></p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -986,18 +987,18 @@ must match. <b>Since Ant 1.7</b>
&lt;/au:assertFalse&gt;
</pre></blockquote>

<h4><a name="antversion">antversion</a></h4>
<h4 id="antversion">antversion</h4>
<p>This condition is identical to the <a
href="antversion.html">Antversion</a> task, all attributes are supported, the property attribute
is redundant and will be ignored.</p>


<h4><a name="hasfreespace">hasfreespace</a></h4>
<h4 id="hasfreespace">hasfreespace</h4>

<p>
Tests a partition to see if there is enough space.
<b>Since Ant 1.7.0</b></p>
<p>Needed attribute can be specified using standard computing terms:<br/>
<i>Since Ant 1.7.0</i></p>
<p>Needed attribute can be specified using standard computing terms:</p>
<ul>
<li>K : Kilobytes (1024 bytes)</li>
<li>M : Megabytes (1024 K)</li>
@@ -1005,9 +1006,8 @@ is redundant and will be ignored.</p>
<li>T : Terabytes (1024 G)</li>
<li>P : Petabytes (1024 T)</li>
</ul>
</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -1031,12 +1031,12 @@ is redundant and will be ignored.</p>
&lt;hasfreespace partition="c:" needed="100M"/&gt;
</pre></blockquote>

<h4><a name="islastmodified">islastmodified</a></h4>
<h4 id="islastmodified">islastmodified</h4>

<p>Tests the last modified date of a resource. <em>Since Ant
1.8.0</em></p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -1081,7 +1081,7 @@ is redundant and will be ignored.</p>
&lt;/islastmodified&gt;
</pre></blockquote>

<h4><a name="resourceexists">resourceexists</a></h4>
<h4 id="resourceexists">resourceexists</h4>

<p>Tests a resource for existence. <em>since Ant 1.8.0</em></p>

@@ -1096,12 +1096,12 @@ is redundant and will be ignored.</p>
&lt;/resourceexists&gt;
</pre></blockquote>

<h4><a name="javaversion">javaversion</a></h4>
<h4 id="javaversion">javaversion</h4>

<p>Tests the version of the JVM executing Ant. <em>Since Ant
1.10.2</em></p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -1110,7 +1110,7 @@ is redundant and will be ignored.</p>
<tr>
<td valign="top">atleast</td>
<td valign="top">The version that this JVM is at least.
The format is major.minor.point. Starting with Java9 really
The format is major.minor.point. Starting with Java 9 really
only the major number is determined.</td>
<td valign="top" align="center">No</td>
<td valign="top" rowspan="2" align="center">One of these.</td>
@@ -1118,7 +1118,7 @@ is redundant and will be ignored.</p>
<tr>
<td valign="top">exactly</td>
<td valign="top">The version that this JVM is exactly.
The format is <tt>major.minor.point</tt>. Starting with Java9 really
The format is <tt>major.minor.point</tt>. Starting with Java 9 really
only the major number is determined.</td>
<td valign="top" align="center">No</td>
</tr>
@@ -1132,7 +1132,7 @@ is redundant and will be ignored.</p>
&lt;javaversion atleast=&quot;9&quot;/&gt;
</pre></blockquote>

<p>will evaluate to true if the current JVM is Java9 or above.</p>
<p>will evaluate to true if the current JVM is Java 9 or above.</p>

</body>
</html>

+ 7
- 9
manual/Tasks/copy.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="copy">Copy</a></h2>
<h2 id="copy">Copy</h2>
<h3>Description</h3>
<p>Copies a file or resource collection to a new file or directory. By default, files are
only copied if the source file is newer than the destination file,
@@ -41,7 +41,7 @@ using a nested mapper (or the flatten attribute) may not be what you
expect.</p>

<p>
<strong>Note: </strong>If you employ filters in your copy operation,
<strong>Note:</strong> If you employ filters in your copy operation,
you should limit the copy to text files. Binary files will be corrupted
by the copy operation.
This applies whether the filters are implicitly defined by the
@@ -50,7 +50,7 @@ operation as <a href="../Types/filterset.html">filtersets</a>.
<em>See <a href="#encoding">encoding note</a></em>.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -331,8 +331,8 @@ the copied file takes on the case of the original. The workaround is to
<a href="delete.html">delete</a>
the file in the destination directory before you copy it.
</p>
<p>
<strong><a name="encoding">Important Encoding Note:</a></strong>
<p id="encoding">
<strong>Important Encoding Note:</strong>
The reason that binary files when filtered get corrupted is that
filtering involves reading in the file using a Reader class. This
has an encoding specifying how files are encoded. There are a number
@@ -369,8 +369,6 @@ the file in the destination directory before you copy it.
Another trick is to change the LANG environment variable from
something like "us.utf8" to "us".
</p>



</body></html>
</body>
</html>

+ 4
- 8
manual/Tasks/copydir.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="copydir">Copydir</a></h2>
<h2 id="copydir">Copydir</h2>
<h3><i>Deprecated</i></h3>
<p><i>This task has been deprecated. Use the Copy task instead.</i></p>
<h3>Description</h3>
@@ -44,7 +44,7 @@ supports most attributes of <code>&lt;fileset&gt;</code>
<code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and
<code>&lt;patternset&gt;</code> elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -112,14 +112,12 @@ supports most attributes of <code>&lt;fileset&gt;</code>
</table>
<h3>Examples</h3>
<pre> &lt;copydir src=&quot;${src}/resources&quot;
dest=&quot;${dist}&quot;
/&gt;</pre>
dest=&quot;${dist}&quot;/&gt;</pre>
<p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>.</p>
<pre> &lt;copydir src=&quot;${src}/resources&quot;
dest=&quot;${dist}&quot;
includes=&quot;**/*.java&quot;
excludes=&quot;**/Test.java&quot;
/&gt;</pre>
excludes=&quot;**/Test.java&quot;/&gt;</pre>
<p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>
recursively. All java files are copied, except for files with the name <code>Test.java</code>.</p>
<pre> &lt;copydir src=&quot;${src}/resources&quot;
@@ -130,7 +128,5 @@ recursively. All java files are copied, except for files with the name <code>Tes
recursively. All java files are copied, except for the files under the <code>mypackage/test</code>
directory.</p>


</body>
</html>


+ 2
- 4
manual/Tasks/copyfile.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="copyfile">Copyfile</a></h2>
<h2 id="copyfile">Copyfile</h2>
<h3><i>Deprecated</i></h3>
<p><i>This task has been deprecated. Use the Copy task instead.</i></p>
<h3>Description</h3>
@@ -32,7 +32,7 @@
the source file is newer than the destination file, or when the destination file
does not exist.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -67,7 +67,5 @@ does not exist.</p>
<p><code>&lt;copyfile src=&quot;${src}/index.html&quot; dest=&quot;${dist}/help/index.html&quot;/&gt;</code></p>
</blockquote>


</body>
</html>


+ 5
- 8
manual/Tasks/cvs.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="cvs">Cvs</a></h2>
<h2 id="cvs">Cvs</h2>
<h3>Description</h3>
<p>Handles packages/modules retrieved from a
<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository.</p>
@@ -45,7 +45,7 @@ href="http://issues.apache.org/bugzilla/show_bug.cgi?id=21657#c5">bugzilla
report 21657</a> for recommended workarounds.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -163,7 +163,7 @@ report 21657</a> for recommended workarounds.</p>
modules specified using this attribute can contain spaces in their
name.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -179,8 +179,7 @@ report 21657</a> for recommended workarounds.</p>
<h3>Examples</h3>
<pre> &lt;cvs cvsRoot=&quot;:pserver:anoncvs@cvs.apache.org:/home/cvspublic&quot;
package=&quot;ant&quot;
dest=&quot;${ws.dir}&quot;
/&gt;</pre>
dest=&quot;${ws.dir}&quot;/&gt;</pre>
<p>checks out the package/module &quot;ant&quot; from the CVS
repository pointed to by the <code>cvsRoot</code> attribute, and stores the files in &quot;<code>${ws.dir}</code>&quot;.</p>
<pre> &lt;cvs dest=&quot;${ws.dir}&quot; command=&quot;update&quot;/&gt;</pre>
@@ -211,7 +210,7 @@ or:
&lt;/cvs&gt;
</pre>
<p>
You may include as many <code>&lt;commandline&gt;</code> elements as you like.
You may include as many <code>&lt;commandline&gt;</code> elements as you like.
Each will inherit the <code>failonerror</code>, <code>compression</code>, and other &quot;global&quot; parameters
from the <code>&lt;cvs&gt;</code> element.
</p>
@@ -224,7 +223,5 @@ before the command, and any command options should appear after the command as i
above. See <a href="http://ximbiot.com/cvs/wiki/index.php?title=Category:User_Documentation" target="_top">the cvs manual</a> for details,
specifically the <a href="http://ximbiot.com/cvs/wiki/index.php?title=CVS--Concurrent_Versions_System_v1.12.12.1:_Guide_to_CVS_commands#SEC116" target="_top">Guide to CVS commands</a></p>


</body>
</html>


+ 3
- 6
manual/Tasks/cvspass.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="cvs">cvspass</a></h2>
<h2 id="cvs">cvspass</h2>
<h3>Description</h3>
<p>Adds entries to a .cvspass file. Adding entries to this file has the same affect as a cvs login command.</p>

@@ -36,7 +36,7 @@ href="http://issues.apache.org/bugzilla/show_bug.cgi?id=21657#c5">bug
zilla report 21657</a> for recommended workarounds.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -60,11 +60,8 @@ zilla report 21657</a> for recommended workarounds.</p>
</table>
<h3>Examples</h3>
<pre> &lt;cvspass cvsroot=&quot;:pserver:anoncvs@cvs.apache.org:/home/cvspublic&quot;
password=&quot;anoncvs&quot;
/&gt;</pre>
password=&quot;anoncvs&quot;/&gt;</pre>
<p>Adds an entry into the ~/.cvspass password file.</p>


</body>
</html>


+ 16
- 24
manual/Tasks/cvstagdiff.html View File

@@ -21,10 +21,10 @@
<title>CvsTagDiff Task</title>
</head>
<body>
<h2><a name="cvstagdiff">CvsTagDiff</a></h2>
<h2 id="cvstagdiff">CvsTagDiff</h2>
<h3>Description</h3>
<p>Generates an XML-formatted report file of the changes between two tags or dates recorded in a
<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository. </p>
<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository.</p>
<p><b>Important:</b> This task needs &quot;<code>cvs</code>&quot; on the path. If it isn't, you will get
an error (such as error <code>2</code> on windows). If <code>&lt;cvs&gt;</code> doesn't work, try to execute <code>cvs.exe</code>
from the command line in the target directory in which you are working.
@@ -34,7 +34,7 @@ for certain other cvs clients - like CVSNT for example - and some
operation may fail when using such an incompatible client.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -77,7 +77,7 @@ operation may fail when using such an incompatible client.
</table>

<h3>Parameters inherited from the <code>cvs</code> task</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -107,8 +107,6 @@ operation may fail when using such an incompatible client.
Use a nested &lt;module&gt; element if you want to specify a module with
spaces in its name.</td>
<td align="center" valign="top">No</td>
</tr>
<td align="center" valign="top">Yes</td>
</tr>
<tr>
<td valign="top">quiet</td>
@@ -141,7 +139,7 @@ operation may fail when using such an incompatible client.
modules specified using this attribute can contain spaces in their
name.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -159,8 +157,7 @@ operation may fail when using such an incompatible client.
destfile=&quot;tagdiff.xml&quot;
package=&quot;ant&quot;
startTag=&quot;ANT_14&quot;
endTag=&quot;ANT_141&quot;
/&gt;</pre>
endTag=&quot;ANT_141&quot;/&gt;</pre>

<p>Generates a tagdiff report for all the changes that have been made
in the <code>ant</code> module between the tags <code>ANT_14</code> and <code>ANT_141</code>.
@@ -170,8 +167,7 @@ It writes these changes into the file <code>tagdiff.xml</code>.</p>
destfile=&quot;tagdiff.xml&quot;
package=&quot;ant&quot;
startDate=&quot;2002-01-01&quot;
endDate=&quot;2002-31-01&quot;
/&gt;</pre>
endDate=&quot;2002-31-01&quot;/&gt;</pre>

<p>Generates a tagdiff report for all the changes that have been made
in the <code>ant</code> module in january 2002. In this example <code>cvsRoot</code>
@@ -183,8 +179,7 @@ It writes these changes into the file <code>tagdiff.xml</code>.</p>
destfile=&quot;tagdiff.xml&quot;
package=&quot;ant jakarta-gump&quot;
startDate=&quot;2003-01-01&quot;
endDate=&quot;2003-31-01&quot;
/&gt;</pre>
endDate=&quot;2003-31-01&quot;/&gt;</pre>

<p>Generates a tagdiff report for all the changes that have been made
in the <code>ant</code> and <code>jakarta-gump</code> modules in january 2003.
@@ -194,13 +189,13 @@ from a folder stored in <code>cvs</code>.
It writes these changes into the file <code>tagdiff.xml</code>.</p>

<h4>Generate Report</h4>
<p>Ant includes a basic XSLT stylesheet that you can use to generate
<p>Ant includes a basic XSLT stylesheet that you can use to generate
a HTML report based on the xml output. The following example illustrates
how to generate a HTML report from the XML report.</p>

<pre>
&lt;style in="tagdiff.xml"
out="tagdiff.html"
&lt;style in="tagdiff.xml"
out="tagdiff.html"
style="${ant.home}/etc/tagdiff.xsl"&gt;
&lt;param name="title" expression="Ant Diff"/&gt;
&lt;param name="module" expression="ant"/&gt;
@@ -210,19 +205,19 @@ how to generate a HTML report from the XML report.</p>

<h4>Output</h4>
<p>
The cvsroot and package attributes of the tagdiff element are new in ant 1.6.<br>
Notes on entry attributes :
<table border="1">
The cvsroot and package attributes of the tagdiff element are new in Ant 1.6.<br>
Notes on entry attributes:
</p>
<table>
<tr><th>Attribute</th><th>Comment</th></tr>
<tr><td>name</td><td>when reporting on one package, the package name is removed from the output</td></tr>
<tr><td>revision</td><td>supplied for files which exist at the end of the reporting period</td></tr>
<tr><td>prevrevision</td><td>supplied for files which exist at the beginning of the reporting period.<br>
Old CVS servers do not supply it for deleted files. CVS 1.12.2 supplies it.</td></tr>
</table>
</p>
<pre>
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;tagdiff startTag=&quot;ANT_14&quot; endTag=&quot;ANT_141&quot;
&lt;tagdiff startTag=&quot;ANT_14&quot; endTag=&quot;ANT_141&quot;
cvsroot=&quot;:pserver:anoncvs@cvs.apache.org:/home/cvspublic&quot; package=&quot;ant&quot;&gt;
&lt;entry&gt;
&lt;file&gt;
@@ -234,8 +229,5 @@ cvsroot=&quot;:pserver:anoncvs@cvs.apache.org:/home/cvspublic&quot; package=&quo
&lt;/tagdiff&gt;
</pre>



</body>
</html>


+ 3
- 7
manual/Tasks/cvsversion.html View File

@@ -24,14 +24,14 @@

<body>

<h2><a name="cvs">CvsVersion</a></h2>
<h2 id="cvs">CvsVersion</h2>
<h3>Description</h3>
<p>
This task allows to retrieve a CVS client and server version.
<i>Since Apache Ant 1.6.1.</i>
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -96,13 +96,9 @@ This task allows to retrieve a CVS client and server version.
<pre> &lt;cvsversion cvsRoot=&quot;:pserver:anoncvs@cvs.apache.org:/home/cvspublic&quot;
passfile=&quot;/home/myself/.cvspass&quot;
serverversionproperty=&quot;apachecvsversion&quot;
clientversionproperty=&quot;localcvsversion&quot;
/&gt;</pre>
clientversionproperty=&quot;localcvsversion&quot;/&gt;</pre>
<p>finds out the cvs client and server versions and stores the versions in the
properties called apachecvsversion and localcvsversion</p>



</body>
</html>


+ 5
- 8
manual/Tasks/defaultexcludes.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="echo">DefaultExcludes</a></h2>
<h2 id="echo">DefaultExcludes</h2>

<p><em>since Apache Ant 1.6</em></p>

@@ -33,7 +33,7 @@
build, and prints out the current default excludes if desired.

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -86,10 +86,10 @@ backup files and then restore normal behavior</p>
</pre>

<h3>Notes</h3>
By default the pattern <tt>**/.svn</tt> and <tt>**/.svn/**</tt> are set as default
excludes. With version 1.3 Subversion supports the
By default the pattern <tt>**/.svn</tt> and <tt>**/.svn/**</tt> are set as default
excludes. With version 1.3 Subversion supports the
<a target="_blank" href="http://subversion.apache.org/docs/release-notes/1.3.html#_svn-hack">&quot;_svn hack&quot;</a>.
That means, that the svn-libraries evaluate environment variables and use <i>.svn</i>
That means, that the svn-libraries evaluate environment variables and use <i>.svn</i>
or <i>_svn</i> directory regarding to that value. We had chosen not to evaluate environment variables to
get a more reliable build. Instead you have to change the settings by yourself by changing
the exclude patterns:
@@ -100,8 +100,5 @@ the exclude patterns:
&lt;defaultexcludes add=&quot;**/_svn/**&quot;/&gt;
</pre>




</body>
</html>

+ 4
- 6
manual/Tasks/delete.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="delete">Delete</a></h2>
<h2 id="delete">Delete</h2>
<h3>Description</h3>
<p>Deletes a single file, a specified directory and all its files and
subdirectories, or a set of files specified by one or more
@@ -53,7 +53,7 @@ in <strong>Directory-based Tasks</strong>, and see the
control, use a nested <code>&lt;fileset&gt;</code>.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -84,7 +84,7 @@ in <strong>Directory-based Tasks</strong>, and see the
<tr>
<td valign="top">verbose</td>
<td valign="top">Whether to show the name of each deleted file.</td>
<td align="center" valign="top">No, default &quot;false&quot;</i></td>
<td align="center" valign="top">No, default &quot;false&quot;</td>
</tr>
<tr>
<td valign="top">quiet</td>
@@ -219,10 +219,8 @@ and any subdirectories.</p>
&lt;/delete&gt;
</pre>
<p>deletes the subversion metadata directories under <code>src</code>. Because <code>.svn</code>
is on of the <a href="../dirtasks.html#defaultexcludes">default excludes</a> you have to use the
is on of the <a href="../dirtasks.html#defaultexcludes">default excludes</a> you have to use the
<code>defaultexcludes</code> flag, otherwise Ant wont delete these directories and the files in it.</p>



</body>
</html>

+ 2
- 4
manual/Tasks/deltree.html View File

@@ -24,13 +24,13 @@

<body>

<h2><a name="deltree">Deltree</a></h2>
<h2 id="deltree">Deltree</h2>
<h3><i>Deprecated</i></h3>
<p><i>This task has been deprecated. Use the Delete task instead.</i></p>
<h3>Description</h3>
<p>Deletes a directory with all its files and subdirectories.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -50,7 +50,5 @@ subdirectories.</p>
<p>deletes the directory <code>${dist}</code>, including its files and
subdirectories.</p>


</body>
</html>


+ 68
- 60
manual/Tasks/depend.html View File

@@ -36,79 +36,90 @@ respect to their source and then removing the class files of any other
classes which depend on the out-of-date classes.
</p>

<p> To determine the class dependencies, the depend task analyzes the class
files of all class files passed to it. Depend does not parse your source code in
any way but relies upon the class references encoded into the class files by the
<p>
To determine the class dependencies, the depend task analyzes the class
files of all class files passed to it. Depend does not parse your source code in
any way but relies upon the class references encoded into the class files by the
compiler. This is generally faster than parsing the Java source.</p>

<p>
To learn more about how this information is obtained from the class files,
To learn more about how this information is obtained from the class files,
please refer to <a href="http://docs.oracle.com/javase/specs/">the Java
Virtual Machine Specification</a>
</p>

<p> Since a class' dependencies only change when the class itself changes, the
depend task is able to cache dependency information. Only those class files
which have changed will have their dependency information re-analysed. Note that
if you change a class' dependencies by changing the source, it will be
recompiled anyway. You can examine the dependency files created to understand
the dependencies of your classes. Please do not rely, however, on the format of
the information, as it may change in a later release. </p>

<p> Once depend discovers all of the class dependencies, it &quot;inverts&quot;
this relation to determine, for each class, which other classes are dependent
upon it. This &quot;affects&quot; list is used to discover which classes are
invalidated by the out of date class. The class files of the invalidated
classes are removed, triggering the compilation of the affected classes. </p>

<p> The depend task supports an attribute, &quot;closure&quot; which controls
whether depend will only consider direct class-class relationships or whether it
will also consider transitive, indirect relationships. For example, say there
are three classes, A, which depends on B, which in-turn depend on C. Now say
that class C is out of date. Without closure, only class B would be removed by
depend. With closure set, class A would also be removed. Normally direct
relationships are sufficient - it is unusual for a class to depend on another
without having a direct relationship. With closure set, you will notice that
depend typically removes far more class files. </p>

<p>The classpath attribute for <code>&lt;depend&gt;</code> is optional. If it is present,
<p>
Since a class' dependencies only change when the class itself changes, the
depend task is able to cache dependency information. Only those class files
which have changed will have their dependency information re-analysed. Note that
if you change a class' dependencies by changing the source, it will be
recompiled anyway. You can examine the dependency files created to understand
the dependencies of your classes. Please do not rely, however, on the format of
the information, as it may change in a later release.
</p>

<p>
Once depend discovers all of the class dependencies, it &quot;inverts&quot;
this relation to determine, for each class, which other classes are dependent
upon it. This &quot;affects&quot; list is used to discover which classes are
invalidated by the out of date class. The class files of the invalidated
classes are removed, triggering the compilation of the affected classes.
</p>

<p>
The depend task supports an attribute, &quot;closure&quot; which controls
whether depend will only consider direct class-class relationships or whether it
will also consider transitive, indirect relationships. For example, say there
are three classes, A, which depends on B, which in-turn depend on C. Now say
that class C is out of date. Without closure, only class B would be removed by
depend. With closure set, class A would also be removed. Normally direct
relationships are sufficient - it is unusual for a class to depend on another
without having a direct relationship. With closure set, you will notice that
depend typically removes far more class files.
</p>

<p>The classpath attribute for <code>&lt;depend&gt;</code> is optional. If it is present,
depend will check class dependencies against classes and jars on this classpath.
Any classes which depend on an element from this classpath and which are older
than that element will be deleted. A typical example where you would use this
facility would be where you are building a utility jar and want to make sure
Any classes which depend on an element from this classpath and which are older
than that element will be deleted. A typical example where you would use this
facility would be where you are building a utility jar and want to make sure
classes which are out of date with respect to this jar are rebuilt. You should
<b>not</b> include jars in this classpath which you do not expect to change,
such as the JDK runtime jar or third party jars, since doing so will just slow
down the dependency check. This means that if you do use a classpath for the
depend task it may be different from the classpath necessary to actually
<b>not</b> include jars in this classpath which you do not expect to change,
such as the JDK runtime jar or third party jars, since doing so will just slow
down the dependency check. This means that if you do use a classpath for the
depend task it may be different from the classpath necessary to actually
compile your code.</p>

<h3>Performance</h3>
<h3>Performance</h3>

<p> The performance of the depend task is dependent on a
number of factors such as class relationship complexity and how many class files
are out of date. The decision about whether it is cheaper to just recompile all
classes or to use the depend task will depend on the size of your project and
how interrelated your classes are. </p>
<p>
The performance of the depend task is dependent on a
number of factors such as class relationship complexity and how many class files
are out of date. The decision about whether it is cheaper to just recompile all
classes or to use the depend task will depend on the size of your project and
how interrelated your classes are.
</p>


<h3>Limitations</h3>

<p> There are some source dependencies which depend will not detect. </p>
<p>
There are some source dependencies which depend will not detect.
</p>

<ul>
<li>If the Java compiler optimizes away a class relationship,
there can be a source dependency without a class dependency. </li>
<li>If the Java compiler optimizes away a class relationship,
there can be a source dependency without a class dependency.</li>
<li>Non public classes cause two problems. Firstly depend cannot relate
the class file to a source file. In the future this may be addressed
using the source file attribute in the classfile. Secondly, neither
using the source file attribute in the classfile. Secondly, neither
depend nor the compiler tasks can detect when a non public class is
missing. Inner classes are handled by the depend task.</li>
</ul>

The most obvious example of these limitations is that the task can't tell
which classes to recompile when a constant primitive data type exported
which classes to recompile when a constant primitive data type exported
by other classes is changed. For example, a change in the definition of
something like
<pre>
@@ -118,7 +129,7 @@ public final class Constants {
</pre> will not be picked up by other classes.

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -141,7 +152,7 @@ will be analysed. If this is not present, the srcdir is used.</td>
<td valign="top">cache</td>
<td valign="top">This is a directory in which depend can store and
retrieve dependency information. If this is not present, depend will not
use a cache </td>
use a cache</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -154,8 +165,7 @@ classes. Defaults to false</td>
</tr>
<tr>
<td valign="top">dump</td>
<td valign="top">If true the dependency information will be written to the debug level log
</td>
<td valign="top">If true the dependency information will be written to the debug level log</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -167,13 +177,13 @@ classes. Defaults to false</td>
<tr>
<td valign="top">warnOnRmiStubs</td>
<td valign="top">Flag to disable warnings about files that look like rmic generated stub/skeleton
classes, and which have no .java source. Useful when doing rmi development. </td>
classes, and which have no .java source. Useful when doing rmi development.</td>
<td valign="top" align="center">No, default=true</td>
</tr>
</table>

<h3>Parameters specified as nested elements</h3>
<p>The <code>depend</code> task's <code>classpath</code> attribute is a
<p>The <code>depend</code> task's <code>classpath</code> attribute is a
<a href="../using.html#path">PATH-like structure</a> and can also be set
via a nested <code>&lt;classpath&gt;</code> element.</p>

@@ -192,11 +202,12 @@ as well as the nested <code>&lt;include&gt;</code>,
closure=&quot;yes&quot;/&gt;</pre>

<p>removes any classes in the <code>${build.classes}</code> directory
that depend on out-of-date classes. Classes are considered out-of-date with
that depend on out-of-date classes. Classes are considered out-of-date with
respect to the source in the <code>${java.dir}</code> directory, using the same
mechanism as the <code>&lt;javac&gt;</code> task. In this example, the
<code>&lt;depend&gt;</code> task caches its dependency
information in the <code>depcache</code> directory. </p>
<code>&lt;depend&gt;</code> task caches its dependency
information in the <code>depcache</code> directory.
</p>

<pre>
&lt;depend srcdir=&quot;${java.dir}&quot; destdir=&quot;${build.classes}&quot;
@@ -209,8 +220,5 @@ information in the <code>depcache</code> directory. </p>
<code>.java</code> files, except those that match the list given
in <code>${java.dir}/build_excludes</code>.</p>



</body>
</html>


+ 5
- 7
manual/Tasks/dependset.html View File

@@ -59,7 +59,7 @@ well as other stylesheets imported by the main stylesheet.

<h3>Parameters</h3>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -97,7 +97,7 @@ filelists. Multiple <code>&lt;srcfileset&gt;</code> filesets may be specified.
<p>
The nested <code>&lt;srcfilelist&gt;</code> element specifies a <a
href="../Types/filelist.html">FileList</a>. All files included in
this filelist will be compared against all files included in all of the
this filelist will be compared against all files included in all of the
<code>&lt;targetfileset&gt;</code> filesets and <code>&lt;targetfilelist&gt;</code>
filelists. Multiple <code>&lt;srcfilelist&gt;</code> filelists may be specified.
</p>
@@ -146,11 +146,11 @@ Multiple <code>&lt;targetfilelist&gt;</code> filelists may be specified.
&lt;targetfileset
dir = &quot;${output.dir}&quot;
includes = &quot;**/*.html&quot;/&gt;
&lt;/dependset&gt; </pre>
&lt;/dependset&gt;</pre>
</blockquote>

<p>
In this example derived HTML files in the ${output.dir} directory
<p>
In this example derived HTML files in the ${output.dir} directory
will be removed if any are out-of-date with respect to:</p>
<ol>
<li>the DTD of their source XML files</li>
@@ -165,7 +165,5 @@ target files will also be removed. To ignore missing sources instead,
use filesets instead of filelists for the sources.
</p>



</body>
</html>

+ 4
- 6
manual/Tasks/diagnostics.html View File

@@ -24,15 +24,14 @@

<body>

<h2><a name="diagnostics">Diagnostics</a></h2>
<h3>Diagnostics</h3>
<h2 id="diagnostics">Diagnostics</h2>
<h3>Description</h3>
<p>
Runs Apache Ant's <code>-diagnostics</code> code inside Ant itself. This is good for
debugging Ant's configuration under an IDE.
Runs Apache Ant's <code>-diagnostics</code> code inside Ant itself. This is good for
debugging Ant's configuration under an IDE.
<b>Since Ant 1.7.0</b>
</p>


<h3>Examples</h3>

<pre>
@@ -44,6 +43,5 @@ debugging Ant's configuration under an IDE.
Prints out the current diagnostics dump.
</p>


</body>
</html>

+ 4
- 7
manual/Tasks/dirname.html View File

@@ -24,12 +24,12 @@

<body>

<h2><a name="echo">Dirname</a></h2>
<h2 id="echo">Dirname</h2>
<h3>Description</h3>
<p>
Task to determine the directory path of a specified file.
</p>
<p>
<p>
When this task executes, it will set the specified property to the
value of the specified file (or directory) up to, but not including,
the last path element. If the specified file is a path that ends in a
@@ -42,7 +42,7 @@ a filename, the directory will be the current directory.
determines the full directory path of the specified file.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -65,10 +65,7 @@ a filename, the directory will be the current directory.
will set <code>antfile.dir</code> to the directory path for
<code>${ant.file}</code>.
<pre> &lt;dirname property=&quot;foo.dirname&quot; file=&quot;foo.txt&quot;/&gt;</pre>
will set <code>foo.dirname</code> to the project's basedir.</p>


will set <code>foo.dirname</code> to the project's basedir.

</body>
</html>


+ 6
- 9
manual/Tasks/ear.html View File

@@ -24,11 +24,11 @@

<body>

<h2><a name="ear">Ear</a></h2>
<h2 id="ear">Ear</h2>
<h3>Description</h3>
<p>An extension of the <a href="jar.html">Jar</a> task with special
treatment for files that should end up in an Enterprise Application archive.</p>
<p>(The Ear task is a shortcut for specifying the particular layout of a EAR file.
<p>(The Ear task is a shortcut for specifying the particular layout of a EAR file.
The same thing can be accomplished by using the <i>prefix</i> and <i>fullpath</i>
attributes of zipfilesets in a Zip or Jar task.)</p>
<p>The extended zipfileset element from the zip task (with attributes <i>prefix</i>, <i>fullpath</i>, and <i>src</i>) is available in the Ear task.</p>
@@ -40,7 +40,7 @@ to avoid this behavior you must set the <code>duplicate</code> attribute
to a value other than its default, <code>&quot;add&quot;</code>.</b></p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -146,9 +146,9 @@ to a value other than its default, <code>&quot;add&quot;</code>.</b></p>
</tr>
<tr>
<td valign="top">index</td>
<td valign="top">whether to create an <A
HREF="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index">index
list</A> to speed up classloading. This is a JDK 1.3+ specific
<td valign="top">whether to create an <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index">index
list</a> to speed up classloading. This is a JDK 1.3+ specific
feature. Unless you specify additional jars with nested <a
href="jar.html#indexjars"><code>indexjars</code></a> elements, only the
contents of this jar will be included in the index. Defaults to
@@ -294,8 +294,5 @@ These are inherited from <a href="jar.html">&lt;jar&gt;</a>
&lt;/ear&gt;
</pre>


</body>
</html>



+ 4
- 9
manual/Tasks/echo.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="echo">Echo</a></h2>
<h2 id="echo">Echo</h2>
<h3>Description</h3>
<p>Echoes a message to the current loggers and listeners which
means <tt>System.out</tt> unless overridden. A <tt>level</tt>
@@ -35,7 +35,7 @@ The task can also echo to a file, in which case the option to append rather
than overwrite the file is available, and the <tt>level</tt> option is
ignored</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -45,7 +45,7 @@ ignored</p>
<td valign="top">message</td>
<td valign="top">the message to echo.</td>
<td valign="top" align="center">No. Text may also be included in a
character section within this element. If neither is included a
character section within this element. If neither is included a
blank line will be emitted in the output.</td>
</tr>
<tr>
@@ -136,7 +136,7 @@ ignored:
<tr>
<th>Ant-Statement</th>
<th>-quiet, -q</th>
<th><i>no statement</th>
<th><i>no statement</i></th>
<th>-verbose, -v</th>
<th>-debug, -d</th>
</tr>
@@ -184,10 +184,5 @@ ignored:
</tr>
</table>






</body>
</html>

+ 3
- 7
manual/Tasks/echoproperties.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="echoproperties">echoproperties</a></h2>
<h2 id="echoproperties">echoproperties</h2>
<h3>Description</h3>

<p>Displays all the current properties (or a subset of them specified
@@ -35,7 +35,7 @@ somewhat contrived means of returning data from an
files.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -54,7 +54,6 @@ files.</p>
<td valign="top">
a prefix which is used to filter the properties
only those properties starting with this prefix will be echoed.
<P>
</td>
<td valign="top" align="center">No</td>
</tr>
@@ -66,7 +65,7 @@ files.</p>
only those properties whose names match it will be echoed.
</td>
<td valign="top" align="center">No</td>
</tr>
</tr>
<tr>
<td valign="top">failonerror</td>
<td valign="top">By default, the "failonerror" attribute is enabled.
@@ -139,8 +138,5 @@ The equivalent snippet with <tt>&lt;/propertyset&gt;</tt> is:</p>
&lt;/echoproperties&gt;
</pre></blockquote>



</body>
</html>


+ 1
- 2
manual/Tasks/echoxml.html View File

@@ -28,7 +28,7 @@
<h3>Description</h3>
<p>Echo nested XML to the console or a file. <b>Since Apache Ant 1.7</b></p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -71,4 +71,3 @@ Nested XML content is required.

</body>
</html>


+ 93
- 98
manual/Tasks/ejb.html View File

@@ -39,25 +39,25 @@
<li>Rob van Oostrum(<a href="mailto:rob@springwellfarms.ca">rob@springwellfarms.ca</a>)</li>
</ul>

<hr>
<hr/>
<h2>Table of Contents</h2>
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#ejbtasks">EJB Tasks</a></li>
</ul>

<hr>
<h2><a name="introduction">Introduction</a></h2>
<hr/>
<h2 id="introduction">Introduction</h2>
<p>Ant provides a number of optional tasks for developing 1.x and 2.x
<a href="http://www.oracle.com/technetwork/java/index-jsp-140203.html" target="_top">Enterprise Java Beans (EJBs)</a>.
In general these tasks are specific to the particular vendor's EJB Server.</p>

<p> The tasks support:<br>
<p>The tasks support:</p>

<ul>
<li><a href="http://www.borland.com">Borland </a>
<li><a href="http://www.borland.com">Borland</a>
Application Server 4.5</li>
<li><a href="http://www.iplanet.com">iPlanet </a>
<li><a href="http://www.iplanet.com">iPlanet</a>
Application Server 6.0</li>
<li><a href="http://www.jboss.org/" target="_top">
JBoss 2.1</a> and above EJB servers</li>
@@ -69,6 +69,7 @@ In general these tasks are specific to the particular vendor's EJB Server.</p>
2.4.x and 2.5 Open Source EJB server</li>
<li><a href="http://www.ibm.com/websphere">IBM WebSphere</a> 4.0</li>
</ul>
<p>
Vendors such as BEA and IBM now provide custom Ant tasks to work with their
particular products. More importantly, EJB3.0 renders this whole process obsolete.
Accordingly, development of these tasks is effectively frozen. Bug reports
@@ -77,9 +78,9 @@ In general these tasks are specific to the particular vendor's EJB Server.</p>
and definitely not new EJB2.x servers.
</p>

<hr>
<h2><a name="ejbtasks">EJB Tasks</a></h2>
<table border="1" cellpadding="5">
<hr/>
<h2 id="ejbtasks">EJB Tasks</h2>
<table>
<tr><td>Task</td><td colspan="2">Application Servers</td></tr>
<tr><td><a href="BorlandGenerateClient.html">blgenclient</a></td><td colspan="2">Borland Application Server 4.5 and 5.x</td></tr>
<tr><td><a href="#iplanet-ejbc">iplanet-ejbc</a></td><td colspan="2">iPlanet Application Server 6.0</td></tr>
@@ -94,8 +95,8 @@ In general these tasks are specific to the particular vendor's EJB Server.</p>

</table>

<hr>
<h2><a name="ddcreator">ddcreator</a></h2>
<hr/>
<h2 id="ddcreator">ddcreator</h2>
<h3><b>Description:</b></h3>
<p>ddcreator will compile a set of Weblogic text-based deployment descriptors into a serialized
EJB deployment descriptor. The selection of which of the text-based descriptors are to be compiled
@@ -103,7 +104,7 @@ is based on the standard Ant include and exclude selection mechanisms.
</p>

<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -135,8 +136,8 @@ is based on the standard Ant include and exclude selection mechanisms.
&lt;/ddcreator&gt;
</pre>

<hr>
<h2><a name="ejbc">ejbc</a></h2>
<hr/>
<h2 id="ejbc">ejbc</h2>
<h3><b>Description:</b></h3>
<p>The ejbc task will run Weblogic's ejbc tool. This tool will take a serialized deployment descriptor,
examine the various EJB interfaces and bean classes and then generate the required support classes
@@ -144,9 +145,9 @@ necessary to deploy the bean in a Weblogic EJB container. This will include the
as well as the classes which implement the bean's home and remote interfaces.</p>
<p>
The ant task which runs this tool is able to compile several beans in a single operation. The beans to be
compiled are selected by including their serialized deployment descriptors. The standard ant
compiled are selected by including their serialized deployment descriptors. The standard Ant
<code>include</code> and <code>exclude</code> constructs can be used to select the deployment descriptors
to be included. </p>
to be included.</p>
<p>
Each descriptor is examined to determine whether the generated classes are out of date and need to be
regenerated. The deployment descriptor is de-serialized to discover the home, remote and
@@ -155,7 +156,7 @@ modification times. These times and the modification time of the serialized desc
compared with the modification time of the generated classes. If the generated classes are not present
or are out of date, the ejbc tool is run to generate new versions.</p>
<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -208,9 +209,8 @@ or are out of date, the ejbc tool is run to generate new versions.</p>
&lt;/ejbc&gt;
</pre>

<hr>
<h2>
<a NAME="iplanet-ejbc"></a>iplanet-ejbc</h2>
<hr/>
<h2 id="iplanet-ejbc">iplanet-ejbc</h2>

<h3>
<b>Description:</b></h3>
@@ -231,7 +231,7 @@ and skeletons.</p>
<h3>
Parameters:</h3>

<table border="1" cellspacing="0" cellpadding="2">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>

@@ -281,7 +281,7 @@ Nested "classpath" elements may also be used.</td>

<td valign="top">Indicates whether or not the Java source files which are
generated by ejbc will be saved or automatically deleted. If "yes", the
source files will be retained. If omitted, it defaults to "no". </td>
source files will be retained. If omitted, it defaults to "no".</td>

<td align="center" valign="top">No</td>
</tr>
@@ -291,7 +291,7 @@ source files will be retained. If omitted, it defaults to "no". </td>

<td>Indicates whether or not the ejbc utility should log additional debugging
statements to the standard output. If "yes", the additional debugging statements
will be generated. If omitted, it defaults to "no". </td>
will be generated. If omitted, it defaults to "no".</td>

<td align="center" valign="top">
<center>No</center>
@@ -304,7 +304,7 @@ will be generated. If omitted, it defaults to "no". </td>
<td>May be used to specify the "home" directory for this iAS installation.
This is used to find the ejbc utility if it isn't included in the user's
system path. If specified, it should refer to the "[install-location]/iplanet/ias6/ias"
directory. If omitted, the ejbc utility must be on the user's system path. </td>
directory. If omitted, the ejbc utility must be on the user's system path.</td>

<td align="center" valign="top">No</td>
</tr>
@@ -331,21 +331,19 @@ Examples</h3>
&lt;pathelement path="${build.classpath}"/&gt;
&lt;/classpath&gt;
&lt;/iplanet-ejbc&gt;


</pre>

<hr>
<h2><a name="wlrun">wlrun</a></h2>
<hr/>
<h2 id="wlrun">wlrun</h2>
<h3><b>Description:</b></h3>

<p>The <code>wlrun</code> task is used to start a weblogic server. The task runs
a weblogic instance in a separate Java Virtual Machine. A number of parameters
are used to control the operation of the weblogic instance. Note that the task,
and hence ant, will not complete until the weblogic instance is stopped.</p>
and hence Ant, will not complete until the weblogic instance is stopped.</p>

<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -476,21 +474,21 @@ Weblogic 6.0</p>
beahome=&quot;${bea.home}&quot;/&gt;
</pre>

<hr>
<h2><a name="wlstop">wlstop</a></h2>
<hr/>
<h2 id="wlstop">wlstop</h2>
<h3><b>Description:</b></h3>

<p>The <code>wlstop</code> task is used to stop a weblogic instance which is
currently running. To shut down an instance you must supply both a username and
a password. These will be stored in the clear in the build script used to stop
the instance. For security reasons, this task is therefore only appropriate in a
development environment. </p>
development environment.</p>

<p>This task works for most version of Weblogic, including 6.0. You need to
specify the BEA Home to have this task work correctly under 6.0</p>

<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -547,16 +545,15 @@ specify the BEA Home to have this task work correctly under 6.0</p>
beahome=&quot;${bea.home}&quot;/&gt;
</pre>

<hr>

<h2><a name="ejbjar">ejbjar</a></h2>
<hr/>
<h2 id="ejbjar">ejbjar</h2>
<h3><b>Description:</b></h3>

<p>This task is designed to support building of EJB jar files (EJB 1.1 &amp; 2.0).
Support is currently provided for 'vanilla' EJB jar files - i.e. those containing only
the user generated class files and the standard deployment descriptor. Nested
elements provide support for vendor specific deployment tools. These currently
include: </p>
include:</p>
<ul>
<li>Borland Application Server 4.5</li>
<li>iPlanet Application Server 6.0</li>
@@ -584,7 +581,7 @@ interfaces. These will be added to the generated jar.</p>
simply generate a generic EJB jar. Such jars are typically used as the input to
vendor-specific deployment tools. For each nested deployment element, a vendor
specific deployment tool is run to generate a jar file ready for deployment in
that vendor's EJB container. </p>
that vendor's EJB container.</p>

<p>The jar files are only built if they are out of date. Each deployment tool
element will examine its target jar file and determine if it is out of date with
@@ -606,10 +603,10 @@ Ejbjar handles the processing of multiple beans, and it uses a set of naming
conventions to determine the name of the generated EJB jars. The naming convention
that is used is controlled by the &quot;naming&quot; attribute. It supports the
following values
<ul>
<dl>

<li>descriptor</li>
<p>This is the default naming scheme. The name of the generated bean is derived from the
<dt>descriptor</dt>
<dd><p>This is the default naming scheme. The name of the generated bean is derived from the
name of the deployment descriptor. For an Account bean, for example, the deployment
descriptor would be named <code>Account-ejb-jar.xml</code>. Vendor specific descriptors are
located using the same naming convention. The weblogic bean, for example, would be named
@@ -619,29 +616,29 @@ is deployed in separate beans.
</p>

<p>This scheme is useful when you are using one bean per EJB jar and where you may be
deploying the same bean classes in different beans, with different deployment characteristics.
deploying the same bean classes in different beans, with different deployment characteristics.</p></dd>

<li>ejb-name</li>
<p> This naming scheme uses the <code>&lt;ejb-name&gt;</code> element from the deployment descriptor to
<dt>ejb-name</dt>
<dd><p>This naming scheme uses the <code>&lt;ejb-name&gt;</code> element from the deployment descriptor to
determine the bean name. In this situation, the descriptors normally use the generic
descriptor names, such as <code>ejb-jar.xml</code> along with any associated vendor specific descriptor
names. For example, If the value of the <code>&lt;ejb-name&gt;</code> were to be given in the deployment descriptor
as follows:
<pre>
&lt;ejb-jar&gt;
as follows:</p>
<pre>&lt;ejb-jar&gt;
&lt;enterprise-beans&gt;
&lt;entity&gt;
&lt;ejb-name&gt;Sample&lt;/ejb-name&gt;
&lt;home&gt;org.apache.ant.ejbsample.SampleHome&lt;/home&gt;
</pre>
<p>
then the name of the generated bean would be <code>Sample.jar</code>
</p>
<p> This scheme is useful where you want to use the standard deployment descriptor names, which may be more
compatible with other EJB tools. This scheme must have one bean per jar.
</p>
<li>directory</li>
<p>
This scheme is useful where you want to use the standard deployment descriptor names, which may be more
compatible with other EJB tools. This scheme must have one bean per jar.
</p></dd>
<dt>directory</dt>
<dd><p>
In this mode, the name of the generated bean jar is derived from the directory
containing the deployment descriptors. Again the deployment descriptors typically use
the standard filenames. For example, if the path to the deployment descriptor is
@@ -652,10 +649,10 @@ bean will be named <code>sample.jar</code>
This scheme is also useful when you want to use standard style descriptor names. It is often
most useful when the descriptors are located in the same directory as the bean source code,
although that is not mandatory. This scheme can handle multiple beans per jar.
</p>
</p></dd>

<li>basejarname</li>
<p>
<dt>basejarname</dt>
<dd><p>
The final scheme supported by the <code>&lt;ejbjar&gt;</code> task is used when you want to specify the generated
bean jar name directly. In this case the name of the generated jar is specified by the
&quot;basejarname&quot; attribute. Since all generated beans will have the same name, this task should
@@ -666,11 +663,11 @@ be only used when each descriptor is in its own directory.
This scheme is most appropriate when you are using multiple beans per jar and only process a single
deployment descriptor. You typically want to specify the name of the jar and not derive it from the
beans in the jar.
</p>
</p></dd>

</ul>
</dl>

<a name="ejbjar_deps"><h3>Dependencies</h3></a>
<h3 id="ejbjar_deps">Dependencies</h3>
<p>In addition to the bean classes, ejbjar is able to ad additional classes to the generated
ejbjar. These classes are typically the support classes which are used by the bean's classes or as
parameters to the bean's methods.</p>
@@ -681,7 +678,7 @@ classes had to be loaded into Ant's JVM. This was not always possible due to cla
</p>

<p>The ejbjar task in Ant releases 1.5 and later uses the
<a href="http://commons.apache.org/bcel/"> BCEL </a> library
<a href="http://commons.apache.org/bcel/">BCEL</a> library
to analyze the bean's class
files directly, rather than loading them into the JVM. This also allows ejbjar to add all
of the required support classes for a bean and not just super classes.
@@ -699,12 +696,12 @@ behaviour where super classes and super interfaces are added to the jar</li>
are added to the jar</li>
</ul>
<p>The <code>super</code> and <code>full</code> values require the
<a href="http://commons.apache.org/bcel/"> BCEL </a> library
<a href="http://commons.apache.org/bcel/">BCEL</a> library
to be available. If it is not, ejbjar will drop back to the behaviour corresponding to
the value <code>none</code>.</p>

<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -819,7 +816,7 @@ the value <code>none</code>.</p>
<h3>Nested Elements</h3>

<p>In addition to the vendor specific nested elements, the ejbjar task provides
three nested elements. </p>
three nested elements.</p>

<h4>Classpath</h4>

@@ -827,7 +824,7 @@ three nested elements. </p>
to be set. It is useful when setting the classpath from a reference path. In all
other respects the behaviour is the same as the classpath attribute.</p>

<a name="ejbjar-dtd"><h4>dtd</h4></a>
<h4 id="ejbjar-dtd">dtd</h4>

<p>The <code>&lt;dtd&gt;</code> element is used to specify the local location of DTDs to be
used when parsing the EJB deployment descriptor. Using a local DTD is much
@@ -840,7 +837,7 @@ available in the classpath when Ant is started. If your want to run Ant without
requiring the vendor classes in the classpath, you would need to use a
<code>&lt;dtd&gt;</code> element.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -877,24 +874,23 @@ specific to that vendor's EJB container. The parameters for each supported
deployment element are detailed here.


<h3><a name="ejbjar_jboss">Jboss element</a></h3>
<h3 id="ejbjar_jboss">Jboss element</h3>

<p>The jboss element searches for the JBoss specific deployment descriptors and adds them
to the final ejb jar file. JBoss has two deployment descriptors:
to the final ejb jar file. JBoss has two deployment descriptors:</p>
<ul><li>jboss.xml</li>
<li>for container manager persistence:<br>
<table border="1">
<table>
<tr><td><b>CMP version</b></td><td><b>File name</b></td></tr>
<tr><td>CMP 1.0</td><td>jaws.xml</td></tr>
<tr><td>CMP 2.0</td><td>jbosscmp-jdbc.xml</td></tr>
</table>
</li>
</ul>
<br>
. The JBoss server uses hot deployment and does
<p>The JBoss server uses hot deployment and does
not require compilation of additional stubs and skeletons.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -905,7 +901,7 @@ not require compilation of additional stubs and skeletons.</p>
<td valign="top">The base directory into which the generated weblogic ready
jar files are deposited. Jar files are deposited in
directories corresponding to their location within the
descriptordir namespace. </td>
descriptordir namespace.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
@@ -934,7 +930,7 @@ not require compilation of additional stubs and skeletons.</p>
</table>


<h3><a name="ejbjar_weblogic">Weblogic element</a></h3>
<h3 id="ejbjar_weblogic">Weblogic element</h3>

<p>The weblogic element is used to control the weblogic.ejbc compiler for
generating weblogic EJB jars. Prior to Ant 1.3, the method of locating CMP
@@ -957,7 +953,7 @@ determining CMP descriptors, you will need to update your weblogic deployment
descriptor's <code>&lt;type-storage&gt;</code> element. In the above example, you would
define this as META-INF/Customer-weblogic-cmp-rdbms-jar.xml.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -968,7 +964,7 @@ define this as META-INF/Customer-weblogic-cmp-rdbms-jar.xml.</p>
<td valign="top">The base directory into which the generated weblogic ready
jar files are deposited. Jar files are deposited in
directories corresponding to their location within the
descriptordir namespace. </td>
descriptordir namespace.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
@@ -1153,7 +1149,7 @@ weblogic element, as long as the newCMP attribute is set to &quot;true&quot;
is derived from the standard weblogic element so it supports the same set of attributes plus these
additional attributes</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -1279,11 +1275,11 @@ This will create only one TOPLink-enabled ejb jar file - 'Address.jar'.</p>
</pre>


<h3><a name="ejbjar_websphere">WebSphere element</a></h3>
<h3 id="ejbjar_websphere">WebSphere element</h3>

<p>The websphere element searches for the websphere specific deployment descriptors and
adds them to the final ejb jar file. Websphere has two specific descriptors for session
beans:
beans:</p>
<ul>
<li>ibm-ejb-jar-bnd.xmi</li>
<li>ibm-ejb-jar-ext.xmi</li>
@@ -1293,11 +1289,12 @@ and another two for container managed entity beans:
<li>Map.mapxmi</li>
<li>Schema.dbxmi</li>
</ul>
<p>
In terms of WebSphere, the generation of container code and stubs is called <code>deployment</code>.
This step can be performed by the websphere element as part of the jar generation process. If the
switch <code>ejbdeploy</code> is on, the ejbdeploy tool from the websphere toolset is called for
every ejb-jar. Unfortunately, this step only works, if you use the ibm jdk. Otherwise, the rmic
(called by ejbdeploy) throws a ClassFormatError. Be sure to switch ejbdeploy off, if run ant with
(called by ejbdeploy) throws a ClassFormatError. Be sure to switch ejbdeploy off, if Ant runs with
Oracle JDK or OpenJDK.
</p>

@@ -1307,7 +1304,7 @@ classes, that are required to reflect the bean classes. For ejbdeploy to work, y
the classpath of the ejbdeploy tool and set the <i>websphere.home</i> property (look at the examples below).
</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -1318,13 +1315,13 @@ the classpath of the ejbdeploy tool and set the <i>websphere.home</i> property (
<td valign="top">The base directory into which the generated weblogic ready
jar files are deposited. Jar files are deposited in
directories corresponding to their location within the
descriptordir namespace. </td>
descriptordir namespace.</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">ejbdeploy</td>
<td valign="top">Decides whether ejbdeploy is called. When you set this to true,
be sure, to run ant with the ibm jdk.</td>
be sure, to run Ant with the IBM JDK.</td>
<td valign="top" align="center">No, defaults to true</td>
</tr>
<tr>
@@ -1358,7 +1355,7 @@ the classpath of the ejbdeploy tool and set the <i>websphere.home</i> property (
</tr>
<tr>
<td valign="top">dbVendor</td>
<td valign="top">This option is passed to ejbdeploy.
<td valign="top">This option is passed to ejbdeploy.
<p>
Valid options can be obtained by running the following command:
<code>
@@ -1415,7 +1412,7 @@ in the descriptor dir:</p>
&lt;/ejbjar&gt;
</pre>

<h3><a name="ejbjar_iplanet">iPlanet Application Server (iAS) element</a></h3>
<h3 id="ejbjar_iplanet">iPlanet Application Server (iAS) element</h3>

The &lt;iplanet&lt; nested element is used to build iAS-specific stubs and

@@ -1436,10 +1433,9 @@ and META-INF/ias-ejb-jar.xml.</p>
in the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir)
as well as the iplanet element (for example, suffix). Refer to the
appropriate documentation for more details.</p>
<h3>
Parameters:</h3>
<h3>Parameters:</h3>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>

@@ -1475,7 +1471,7 @@ elements may also be used.</td>

<td valign="top">Indicates whether or not the Java source files which are
generated by ejbc will be saved or automatically deleted. If "yes", the
source files will be retained. If omitted, it defaults to "no". </td>
source files will be retained. If omitted, it defaults to "no".</td>

<td align="center" valign="top">No</td>
</tr>
@@ -1485,7 +1481,7 @@ source files will be retained. If omitted, it defaults to "no". </td>

<td>Indicates whether or not the ejbc utility should log additional debugging
statements to the standard output. If "yes", the additional debugging statements
will be generated. If omitted, it defaults to "no". </td>
will be generated. If omitted, it defaults to "no".</td>

<td align="center" valign="top">No</td>
</tr>
@@ -1497,7 +1493,7 @@ will be generated. If omitted, it defaults to "no". </td>
This is used to find the ejbc utility if it isn't included in the user's
system path. If specified, it should refer to the [install-location]/iplanet/ias6/ias
directory. If omitted, the ejbc utility must be on the user's system
path. </td>
path.</td>

<td align="center" valign="top">No</td>
</tr>
@@ -1506,7 +1502,7 @@ path. </td>
<td valign="top">suffix</td>

<td>String value appended to the JAR filename when creating each JAR.
If omitted, it defaults to ".jar". </td>
If omitted, it defaults to ".jar".</td>

<td align="center" valign="top">No</td>
</tr>
@@ -1582,7 +1578,7 @@ local DTDs are found in the [iAS-install-directory]/dtd directory.
location="${ias.home}/APPS/IASEjb_jar_1_0.dtd"/&gt;
&lt;/ejbjar&gt;</pre>

<h3><a name="ejbjar_jonas">JOnAS (Java Open Application Server) element</a></h3>
<h3 id="ejbjar_jonas">JOnAS (Java Open Application Server) element</h3>

<p>The <code>&lt;jonas&gt;</code> nested element is used to build JOnAS-specific stubs and
skeletons thanks to the <code>GenIC</code> specific tool, and construct a JAR
@@ -1615,7 +1611,7 @@ documentation for more details.</p>

<h3> Parameters:</h3>

<table border="1" cellspacing="0" cellpadding="2">
<table>
<tbody>
<tr>
<td valign="Top"><b>Attribute</b></td>
@@ -1708,7 +1704,7 @@ documentation for more details.</p>
<tr>
<td valign="Top">jarsuffix</td>
<td>String value appended to the JAR filename when creating each JAR. If
omitted, it defaults to ".jar". </td>
omitted, it defaults to ".jar".</td>
<td align="Center" valign="Top">No</td>
</tr>
<tr>
@@ -1774,14 +1770,14 @@ descriptors to use the naming standard. This will create only one ejb jar file -
</pre>


<h3><a name="ejbjar_orion">Orion element</a></h3>
<h3 id="ejbjar_orion">Orion element</h3>

<p>The orion element searches for the Orion Application Server specific deployment descriptors and adds them
to the final ejb jar file. Orion has one deployment descriptor:
<ul><li>orion-ejb-jar.xml</li>
</ul>
<br>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -1792,7 +1788,7 @@ to the final ejb jar file. Orion has one deployment descriptor:
<td valign="top">The base directory into which the generated
jar files are deposited. Jar files are deposited in
directories corresponding to their location within the
descriptordir namespace. </td>
descriptordir namespace.</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
@@ -1812,5 +1808,4 @@ to the final ejb jar file. Orion has one deployment descriptor:
</pre>

</body>

</html>

+ 22
- 28
manual/Tasks/exec.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="exec">Exec</a></h2>
<h2 id="exec">Exec</h2>
<h3>Description</h3>
<p>Executes a system command. When the <i>os</i> attribute is specified, then
the command is only executed when Apache Ant is run on one of the specified operating
@@ -40,13 +40,12 @@ EOF (-1). This is a change from Ant 1.5, where such an attempt would block.</p>
use <code>vmlauncher="false"</code> on some operating systems - but
even this may fail (Solaris 8/9 has been reported as problematic).
The <code>resolveexecutable</code> attribute should be more
reliable, as would be something like
reliable, as would be something like</p>
<pre>
&lt;property name="executable-full-path"
location="../relative/path/to/executable"/&gt;
&lt;exec executable="${executable-full-path}" ...
</pre>
</p>

<h4>Windows Users</h4>
<p>The <code>&lt;exec&gt;</code> task delegates to <code>Runtime.exec</code> which in turn
@@ -87,7 +86,7 @@ for the executable parameter. This is because the Java VM in which Ant is
running is a standard Windows executable and is not aware of the Cygwin
environment (i.e., doesn't load <code>cygwin1.dll</code>). The only
work-around for this is to compile a JVM under Cygwin (at your own risk).
See for instance
See for instance
<a href="http://hg.openjdk.java.net/jdk7/build/raw-file/tip/README-builds.html#cygwin">
OpenJDK build instructions for cygwin</a>.
</p>
@@ -95,7 +94,7 @@ OpenJDK build instructions for cygwin</a>.
<h4>OpenVMS Users</h4>
<p>The command specified using <code>executable</code> and
<code>&lt;arg&gt;</code> elements is executed exactly as specified
inside a temporary DCL script. This has some implications:
inside a temporary DCL script. This has some implications:</p>
<ul>
<li>paths have to be written in VMS style</li>
<li>if your <code>executable</code> points to a DCL script remember to
@@ -103,7 +102,7 @@ prefix it with an <code>@</code>-sign
(e.g. <code>executable="@[FOO]BAR.COM"</code>), just as you would in a
DCL script</li>
</ul>
For <code>&lt;exec&gt;</code> to work in an environment with a Java VM
<p>For <code>&lt;exec&gt;</code> to work in an environment with a Java VM
older than version 1.4.1-2 it is also <i>required</i> that the logical
<code>JAVA$FORK_SUPPORT_CHDIR</code> is set to <code>TRUE</code> in
the job table (see the <i>JDK Release Notes</i>).</p>
@@ -122,7 +121,7 @@ interpretation of exit codes.</p>
href="http://listserv.uark.edu/scripts/wa.exe?A1=ind0404&L=vmesa-l#33">reported
on the VMESA-LISTSERV</a> that shell scripts invoked via the Ant Exec
task must have their interpreter specified, i.e., the scripts must
start with something like:
start with something like:</p>

<blockquote>
<pre>
@@ -130,7 +129,7 @@ start with something like:
</pre>
</blockquote>

or the task will fail as follows:
<p>or the task will fail as follows:</p>

<blockquote>
<pre>
@@ -138,10 +137,8 @@ or the task will fail as follows:
[exec] Result: 255
</pre>
</blockquote>
</p>

<h4><a name="background">Running Ant as a background process on
Unix(-like) systems</a></h4>
<h4 id="background">Running Ant as a background process on Unix(-like) systems</h4>

<p>If you run Ant as a background process (like <code>ant &</code>)
and use the <code>&lt;exec&gt;</code> task with <code>spawn</code>
@@ -150,7 +147,7 @@ or the task will fail as follows:
from the standard input.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -197,7 +194,7 @@ or the task will fail as follows:
<td valign="top">spawn</td>
<td valign="top">whether or not you want the command to be spawned<br>
Default is false.<br>
If you spawn a command, its output will not be logged by ant.<br>
If you spawn a command, its output will not be logged by Ant.<br>
The input, output, error, and result property settings are not active when spawning a process.<br>
<em>since Ant 1.6</em>
</td>
@@ -278,9 +275,10 @@ or the task will fail as follows:
<tr>
<td valign="top">failifexecutionfails</td>
<td valign="top">Stop the build if we can't start the program.
Defaults to true. </td>
Defaults to true.</td>
<td align="center" valign="top">No</td>
</tr> <tr>
</tr>
<tr>
<td valign="top">newenvironment</td>
<td valign="top">Do not propagate old environment when new environment
variables are specified.</td>
@@ -331,10 +329,10 @@ or the task will fail as follows:
<p>Command line arguments should be specified as nested
<code>&lt;arg&gt;</code> elements. See <a
href="../using.html#arg">Command line arguments</a>.</p>
<h4><a name="env">env</a></h4>
<h4 id="env">env</h4>
<p>It is possible to specify environment variables to pass to the
system command via nested <code>&lt;env&gt;</code> elements.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -345,8 +343,8 @@ system command via nested <code>&lt;env&gt;</code> elements.</p>
<td valign="top">
The name of the environment variable.
<br/>
<em>Note: (Since Ant 1.7)</em>
For windows, the name is case-insensitive.
<em>Note: since Ant 1.7</em>,
for Windows, the name is case-insensitive.
</td>
<td align="center" valign="top">Yes</td>
</tr>
@@ -367,14 +365,14 @@ system command via nested <code>&lt;env&gt;</code> elements.</p>
replaced by the absolute filename of the file by Ant.</td>
</tr>
</table>
<a name="redirector"><h4>redirector</h4></a>
<i><b>Since Ant 1.6.2</b></i>
<h4 id="redirector">redirector</h4>
<i>Since Ant 1.6.2</i>
<p>A nested <a href="../Types/redirector.html">I/O Redirector</a>
can be specified. In general, the attributes of the redirector behave
as the corresponding attributes available at the task level. The most
notable peculiarity stems from the retention of the &lt;exec&gt;
attributes for backwards compatibility. Any file mapping is done
using a <CODE>null</CODE> sourcefile; therefore not all
using a <code>null</code> sourcefile; therefore not all
<a href="../Types/mapper.html">Mapper</a> types will return
results. When no results are returned, redirection specifications
will fall back to the task level attributes. In practice this means that
@@ -448,18 +446,14 @@ Output is sent to the file &quot;redirector.out&quot; and stored
in a property of the same name. Similarly, error output is sent to
a file and a property, both named &quot;redirector.err&quot;.


<p><b>Note:</b> do not try to specify arguments using
a simple arg-element and separate them by spaces. This results in
only a single argument containing the entire string.</p>
<p>
<b>Timeouts: </b> If a timeout is specified, when it is reached the
<b>Timeouts:</b> If a timeout is specified, when it is reached the
sub process is killed and a message printed to the log. The return
value of the execution will be "-1", which will halt the build if
<tt>failonerror=true</tt>, but be ignored otherwise.



</p>
</body>
</html>


+ 3
- 4
manual/Tasks/fail.html View File

@@ -24,14 +24,14 @@

<body>

<h2><a name="fail">Fail</a></h2>
<h2 id="fail">Fail</h2>
<h3>Description</h3>
<p>Exits the current build (just throwing a BuildException), optionally printing additional information.</p>
<p>The message of the Exception can be set via the message attribute
or character data nested into the element.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -69,7 +69,7 @@ or character data nested into the element.</p>
conditional failure can be achieved using a single nested
<code>&lt;condition&gt;</code> element, which should contain exactly one
core or custom condition. For information about conditions, see
<a href="conditions.html">here</a>.<br><b>Since Ant 1.6.2</b>
<a href="conditions.html">here</a>.<br><i>Since Ant 1.6.2</i>
</p>

<h3>Examples</h3>
@@ -140,4 +140,3 @@ will fail.</p>

</body>
</html>


+ 5
- 8
manual/Tasks/filter.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="filter">Filter</a></h2>
<h2 id="filter">Filter</h2>
<h3>Description</h3>
<p>Sets a token filter for this project or read multiple token filter from
an input file and sets these as filters.
@@ -36,7 +36,7 @@ Note 2: Either token and value attributes must be provided, or only the
filtersfile attribute.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -49,13 +49,13 @@ filtersfile attribute.</p>
</tr>
<tr>
<td valign="top">value</td>
<td valign="top">the string that should be put to replace the token when the
<td valign="top">the string that should be put to replace the token when the
file is copied</td>
<td align="center" valign="top">Yes*</td>
</tr>
<tr>
<td valign="top">filtersfile</td>
<td valign="top">The file from which the filters must be read. This file must be a formatted as a property file. </td>
<td valign="top">The file from which the filters must be read. This file must be a formatted as a property file.</td>
<td align="center" valign="top">Yes*</td>
</tr>
</table>
@@ -64,7 +64,7 @@ filtersfile attribute.</p>
<pre> &lt;filter token=&quot;year&quot; value=&quot;2000&quot;/&gt;
&lt;copy todir=&quot;${dest.dir}&quot; filtering=&quot;true&quot;&gt;
&lt;fileset dir=&quot;${src.dir}&quot;/&gt;
&lt;/copy&gt;</pre>
&lt;/copy&gt;</pre>
<p>will copy recursively all the files from the <i>src.dir</i> directory into
the <i>dest.dir</i> directory replacing all the occurrences of the string <i>@year@</i>
with <i>2000.</i></p>
@@ -72,8 +72,5 @@ with <i>2000.</i></p>
will read all property entries from the <i>deploy_env.properties</i> file
and set these as filters.



</body>
</html>


+ 18
- 19
manual/Tasks/fixcrlf.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="fixcrlf">FixCRLF</a></h2>
<h2 id="fixcrlf">FixCRLF</h2>
<h3>Description</h3>
<p>
Adjusts a text file to local conventions.
@@ -62,12 +62,12 @@
</p>

<p>
Since <b>Apache Ant 1.7</b>, this task can be used in a
Since <i>Apache Ant 1.7</i>, this task can be used in a
<a href="../Types/filterchain.html">filterchain</a>.
</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="center" rowspan="2"><b>Attribute</b></td>
<td valign="center" rowspan="2"><b>Description</b></td>
@@ -81,47 +81,47 @@
<td valign="top">srcDir</td>
<td valign="top">Where to find the files to be fixed up.</td>
<td valign="top" align="center" rowspan="2">One of these</td>
<td bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">Name of a single file to fix. <b>Since Ant 1.7</b></td>
<td bgcolor="#CCCCCC">&nbsp;</td>
<td valign="top">Name of a single file to fix. <i>Since Ant 1.7</i></td>
<td>&nbsp;</td>
</tr>
<tr>
<td valign="top">destDir</td>
<td valign="top">Where to place the corrected files. Defaults to
srcDir (replacing the original file).</td>
<td valign="top" align="center">No</td>
<td bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</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 bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</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 bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</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 bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</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 bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td valign="top">defaultexcludes</td>
@@ -129,27 +129,27 @@
(&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.
</td>
<td valign="top" align="center">No</td>
<td bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td valign="top">encoding</td>
<td valign="top">The encoding of the files.</td>
<td align="center">No; defaults to default JVM encoding.</td>
<td bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td valign="top">outputencoding</td>
<td valign="top">The encoding to use when writing the files.
<b>Since Ant 1.7</b></td>
<i>Since Ant 1.7</i></td>
<td align="center">No; defaults to the value of the encoding attribute.</td>
<td bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td valign="top">preservelastmodified</td>
<td valign="top">Whether to preserve the last modified
date of source files. <b>Since Ant 1.6.3</b></td>
date of source files. <i>Since Ant 1.6.3</i></td>
<td align="center">No; default is <i>false</i></td>
<td bgcolor="#CCCCCC">&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td valign="top">eol</td>
@@ -280,7 +280,7 @@
<tr>
<td valign="top">fixlast</td>
<td valign="top">Whether to add a missing EOL to the last line
of a processed file.<br/>Ignored if EOL is asis.<br/><b>Since Ant 1.6.1</b></td>
of a processed file.<br/>Ignored if EOL is asis.<br/><i>Since Ant 1.6.1</i></td>
<td align="center" colspan="2">No; default is <i>true</i></td>
</tr>
</table>
@@ -322,6 +322,5 @@
DOS systems, and are removed if run on Unix systems.
You never know what editor a user will use to browse READMEs.</p>


</body>
</html>

+ 89
- 125
manual/Tasks/ftp.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="ftp">FTP</a></h2>
<h2 id="ftp">FTP</h2>
<h3>Description</h3>
<p>The ftp task implements a basic FTP client that can send, receive,
list, delete files, and create directories. See below for descriptions and examples of how
@@ -48,13 +48,13 @@ write patterns.</p>
<p>
This task does not currently use the proxy information set by the
<a href="setproxy.html"><code>&lt;setproxy&gt;</code></a> task, and cannot go through
a firewall via socks.
a firewall via socks.
<p>
<b>Warning: </b> there have been problems reported concerning the ftp get with the <code>newer</code> attribute.
Problems might be due to format of ls -l differing from what is expected by commons-net,
<b>Warning:</b> there have been problems reported concerning the ftp get with the <code>newer</code> attribute.
Problems might be due to format of <code>ls -l</code> differing from what is expected by commons-net,
for instance due to specificities of language used by the ftp server in the directory listing.
If you encounter such a problem, please send an email including a sample directory listing
coming from your ftp server (ls -l on the ftp prompt).
coming from your ftp server (<code>ls -l</code>code> on the ftp prompt).
</p>
<p>
If you can connect but not upload or download, try setting the <code>passive</code>
@@ -62,7 +62,7 @@ attribute to true to use the existing (open) channel, instead of having the serv
try to set up a new connection.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top" width="15%"><b>Attribute</b></td>
<td valign="top" width="65%"><b>Description</b></td>
@@ -92,8 +92,7 @@ try to set up a new connection.</p>
<tr>
<td valign="top">account</td>
<td valign="top">the account to use on the ftp server.
<em>since Ant 1.7</em>.
</td>
<em>since Ant 1.7</em>.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -129,13 +128,13 @@ try to set up a new connection.</p>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">displays information on each file transferred if set
<td valign="top">displays information on each file transferred if set
to "yes". Defaults to "no".</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">depends</td>
<td valign="top">transfers only new or changed files if set to
<td valign="top">transfers only new or changed files if set to
"yes". Defaults to "no".</td>
<td valign="top" align="center">No</td>
</tr>
@@ -148,37 +147,34 @@ try to set up a new connection.</p>
<tr>
<td valign="top">timediffauto</td>
<td valign="top">set to <code>"true"</code>
to make ant calculate the time difference between client and server.<br>
to make Ant calculate the time difference between client and server.<br>
<em>requires write access in the remote directory</em><br>
Since ant 1.6</td>
<em>Since Ant 1.6</em></td>
<td valign="top" align="center">No</td>
</tr>
<a name="timestampGranularity"/>
<tr>
<tr id="timestampGranularity">
<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
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>
<em>Since Ant 1.7</em></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.
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"><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
<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>
<em>Since Ant 1.6</em></td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -218,7 +214,7 @@ try to set up a new connection.</p>
and get operations to be skipped with a warning and the
remainder of the files still transferred. Default: false</td>
<td valign="top" align="center">No</td>
</tr>
</tr>
<tr>
<td valign="top">preservelastmodified</td>
<td valign="top">Give the copied files the same last modified
@@ -252,7 +248,7 @@ try to set up a new connection.</p>
connect to the same host as the control connection. This is a
security measure that is enabled by default, but it may be useful
to disable it in certain firewall scenarios.
<em>since Ant 1.8.0</em></td>
<em>since Ant 1.8.0</em></td>
<td valign="top" align="center">No, default is true</td>
</tr>

@@ -262,12 +258,12 @@ try to set up a new connection.</p>
"http://commons.apache.org/net/download_net.cgi">
jakarta-commons-net-1.4.0 or greater</a>.</b></p>
<p>
Use these options when the standard options don't work, because
Use these options when the standard options don't work, because</p>
<ul><li>the server is in a different timezone and you need timestamp
dependency checking</li>
<li>the default timestamp formatting doesn't match the server display and
list parsing therefore fails</li></ul>
</p><p>
<p>
If none of these is specified, the default mechanism of letting the system
auto-detect the server OS type based on the FTP SYST command and assuming
standard formatting for that OS type will be used.
@@ -278,7 +274,7 @@ try to set up a new connection.</p>
</p><p>
Please understand that these options are incompatible with the autodetection
scheme. If any of these options is specified, (other than with a value of
<code>""</code> ) a system type must be chosen and if systemTypeKey is not
<code>""</code>) a system type must be chosen and if systemTypeKey is not
specified, UNIX will be assumed. The philosophy behind this is that these
options are for setting non-standard formats, and a build-script author who
knows what system he is dealing with will know what options to need to be
@@ -293,8 +289,7 @@ try to set up a new connection.</p>
"MVS".</code> If not specified, (or specified as <code>""</code>) and if
no other xxxConfig attributes are specified, the autodetection mechanism
based on the FTP SYST command will be used.<br>
Since ant 1.7
</td>
<em>Since Ant 1.7</em></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>
is specified here.
@@ -305,19 +300,18 @@ try to set up a new connection.</p>
<td valign="top">Specify as a Java
<a href="http://docs.oracle.com/javase/7/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,
<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>
<em>Since Ant 1.7</em></td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">defaultDateFormatConfig</td>
<td valign="top">Specify in Java
<td valign="top">Specify in Java
<a href="http://docs.oracle.com/javase/7/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
@@ -326,23 +320,21 @@ try to set up a new connection.</p>
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 <b>systemTypeKey</b> attribute will be used.<br>
Since ant 1.7
</td>
<em>Since Ant 1.7</em></td>
<td valign="top" align="center">
No.
</td>
</tr>
<tr>
<td valign="top">recentDateFormatConfig</td>
<td valign="top">Specify in Java
<td valign="top">Specify in Java
<a href="http://docs.oracle.com/javase/7/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.<br>
Since ant 1.7
</td>
<em>Since Ant 1.7</em></td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -374,9 +366,7 @@ try to set up a new connection.</p>
</ul>
If you require a language other than the above, see also the
<b>shortMonthNamesConfig</b> attribute.<br>
Since ant 1.7
</td>

<em>Since Ant 1.7</em></td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -388,93 +378,70 @@ try to set up a new connection.</p>
<code>"jan|feb|mar|apr|ma&#xED;|j&#xFA;n|j&#xFA;l|&#xE1;g&#xFA;|sep|okt|n&#xF3;v|des"</code>.
This attribute exists primarily to support languages not supported by
the <b>serverLanguageCode</b> attribute.<br>
Since ant 1.7
</td>
<em>Since Ant 1.7</em></td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h3>Note about remotedir attribute</h3>
<table border="1" cellpadding="2" cellspacing="0"
>
<table>
<tbody>
<tr>
<td style="vertical-align: top;" width="20%">Action<br>
</td>
<td style="vertical-align: top;" width="40%">meaning of <code>remotedir</code><br>
</td>
<td style="vertical-align: top;">use of nested <code>fileset</code>
(s)<br>
</td>
<td style="vertical-align: top;" width="20%">Action</td>
<td style="vertical-align: top;" width="40%">meaning of <code>remotedir</code></td>
<td style="vertical-align: top;">use of nested <code>fileset</code>(s)</td>
</tr>
<tr>
<td style="vertical-align: top;" width="20%">send/put<br>
</td>
<td style="vertical-align: top;" width="20%">send/put</td>
<td style="vertical-align: top;" width="40%">base directory to
which the files are sent<br>
</td>
which the files are sent</td>
<td style="vertical-align: top;">they are used normally and
evaluated on the local machine<br>
</td>
evaluated on the local machine</td>
</tr>
<tr>
<td style="vertical-align: top;" width="20%">recv/get<br>
</td>
<td style="vertical-align: top;" width="20%">recv/get</td>
<td style="vertical-align: top;" width="40%">base directory from
which the files are retrieved<br>
</td>
which the files are retrieved</td>
<td style="vertical-align: top;">the remote files located under
the <code>remotedir </code>matching the include/exclude patterns of
the <code>fileset&nbsp;</code></td>
the <code>remotedir</code> matching the include/exclude patterns of
the <code>fileset</code></td>
</tr>
<tr>
<td style="vertical-align: top;" width="20%">del/delete<br>
</td>
<td style="vertical-align: top;" width="20%">del/delete</td>
<td style="vertical-align: top;" width="40%">base directory from
which files get deleted<br>
</td>
which files get deleted</td>
<td style="vertical-align: top;">the remote files located under
the <code>remotedir </code>matching the include/exclude patterns of
the <code>fileset <br>
</code></td>
the <code>remotedir</code> matching the include/exclude patterns of
the <code>fileset</code></td>
</tr>
<tr>
<td style="vertical-align: top;" width="20%">list<br>
</td>
<td style="vertical-align: top;" width="20%">list</td>
<td style="vertical-align: top;" width="40%">base directory from
which files are listed<br>
</td>
<td style="vertical-align: top;">the remote files located under
the <code>remotedir </code>matching the include/exclude patterns of
the <code>fileset <br>
</code></td>
the <code>remotedir</code> matching the include/exclude patterns of
the <code>fileset</code></td>
</tr>
<tr>
<td style="vertical-align: top;" width="20%">mkdir</td>
<td style="vertical-align: top;" width="40%">directory to create<br>
</td>
<td style="vertical-align: top;">not used<br>
</td>
<td style="vertical-align: top;" width="40%">directory to create</td>
<td style="vertical-align: top;">not used</td>
</tr>
<tr>
<td style="vertical-align: top;" width="20%">chmod</td>
<td style="vertical-align: top;" width="40%">base directory from
which the mode of files get changed<br>
</td>
which the mode of files get changed</td>
<td style="vertical-align: top;">the remote files located under
the <code>remotedir </code>matching the include/exclude patterns of
the <code>fileset <br>
</code></td>
the <code>remotedir</code> matching the include/exclude patterns of
the <code>fileset</code></td>
</tr>
<tr>
<td style="vertical-align: top;" width="20%">rmdir<br>
</td>
<td style="vertical-align: top;" width="20%">rmdir</td>
<td style="vertical-align: top;" width="40%">base directory from
which directories get removed<br>
</td>
which directories get removed</td>
<td style="vertical-align: top;">the remote directories located
under the <code>remotedir </code>matching the include/exclude
patterns of the <code>fileset <br>
</code></td>
under the <code>remotedir</code> matching the include/exclude
patterns of the <code>fileset</code></td>
</tr>
</tbody>
</table><h3>Parameters specified as nested elements</h3>
@@ -485,8 +452,8 @@ the files to be retrieved, or deleted, or listed, or whose mode you want to chan
<p>
The attribute <code>followsymlinks</code> of <code>fileset</code> is supported on
local (put) as well as remote (get, chmod, delete) filesets.
<em>Before ant 1.6 there was no support of symbolic links in remote filesets.
In order to exclude symbolic links (preserve the behavior of ant 1.5.x and older),
<em>Before Ant 1.6 there was no support of symbolic links in remote filesets.
In order to exclude symbolic links (preserve the behavior of Ant 1.5.x and older),
you need to explicitly set <code>followsymlinks</code> to <code>false</code>.</em>
On remote filesets hidden files are not checked for being symbolic links. Hidden
files are currently assumed to not be symbolic links.
@@ -501,8 +468,8 @@ files are currently assumed to not be symbolic links.
&lt;fileset dir="htdocs/manual"/&gt;
&lt;/ftp&gt;
</pre>
<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
uploads all files in the <code>htdocs/manual</code> directory
<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>
<pre> &lt;ftp server="ftp.apache.org"
remotedir="incoming"
@@ -512,7 +479,7 @@ to the default directory for that user.</p>
&lt;fileset dir="htdocs/manual"/&gt;
&lt;/ftp&gt;</pre>
<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
uploads all new or changed files in the <code>htdocs/manual</code> directory
uploads all new or changed files in the <code>htdocs/manual</code> directory
to the <code>incoming</code> directory relative to the default directory
for <code>anonymous</code>.</p>
<pre> &lt;ftp server="ftp.apache.org"
@@ -560,13 +527,13 @@ in text mode.</p>
&lt;fileset dir="htdocs/manual"&gt;
&lt;include name="**/*.html"/&gt;
&lt;/fileset&gt;
&lt;/ftp&gt;</pre><p>Logs in to the Windows-based <code>ftp.nt.org</code> as
<code>coder</code> with password <code>java1</code> and uploads all
HTML files in the <code>htdocs/manual</code> directory to the
&lt;/ftp&gt;</pre><p>Logs in to the Windows-based <code>ftp.nt.org</code> as
<code>coder</code> with password <code>java1</code> and uploads all
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
<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
@@ -581,8 +548,8 @@ into. The file structure from the FTP site is preserved on the local machine.</
&lt;/fileset&gt;
&lt;/ftp&gt;
</pre>
<p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
recursively downloads all .html files from default directory for that user
<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>
<pre>
&lt;ftp action="get"
@@ -621,8 +588,8 @@ 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
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.

@@ -669,14 +636,14 @@ remotedir attribute.</p>
directory. As with all other actions, the directory separator character must be correct
according to the desires of the FTP server.</p>
<h3>Removing Directories</h3>
This action uses nested fileset elements to
select the directories to remove from the remote FTP server. The
filesets are relative to the remote directory, not a local directory.
This action uses nested fileset elements to
select the directories to remove from the remote FTP server. The
filesets are relative to the remote directory, not a local directory.
The dir attribute of the fileset is ignored completely.
The directories to be removed must be empty, or contain only
other directories that have been also selected to be removed by the filesets
patterns, otherwise a BuildException will be thrown.
Also, if you don't have permission to remove a directory, a BuildException is
Also, if you don't have permission to remove a directory, a BuildException is
thrown.

<pre>
@@ -700,25 +667,22 @@ it tries to remove a directory it is sure all the directories under it are
already removed.
Obviously all the files in the tree must have been already deleted.
</p>
<p>As an example suppose you want to delete everything contained into
<p>As an example suppose you want to delete everything contained into
<code>/somedir</code>, so invoke first the <code>&lt;ftp&gt;</code> task with
<code>action="delete"</code>, then with
<code>action="rmdir"</code> specifying in both cases
<code>remotedir="/somedir"</code> and

<code>remotedir="/somedir"</code> and</p>
<pre>
&lt;fileset&gt;
&lt;include name="**"/&gt;
&lt;/fileset&gt;
</pre>
<p>
The directory specified in the <code>remotedir</code> parameter is never
selected for remove, so if you need to remove it, specify its parent in
<code>remotedir</code> parameter and include it in the
<code>remotedir</code> parameter and include it in the
<code>&lt;fileset&gt;</code> pattern, like <code>"somedir/**"</code>.
</p>


</body>
</html>


+ 5
- 7
manual/Tasks/genkey.html View File

@@ -24,12 +24,12 @@

<body>

<h2><a name="genkey">GenKey</a></h2>
<h2 id="genkey">GenKey</h2>
<h3>Description</h3>
<p>Generates a key in a keystore. </p>
<p>Generates a key in a keystore.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -99,11 +99,11 @@ have a name and a value. When using the subelement it is automatically
encoded properly and commas (&quot;<code>,</code>&quot;) are replaced
with &quot;<code>\,</code>&quot;.</p>

<p>The following two examples are identical: </p>
<p>The following two examples are identical:</p>

<h3>Examples</h3>
<blockquote><pre>
&lt;genkey alias=&quot;apache-group&quot; storepass=&quot;secret&quot;
&lt;genkey alias=&quot;apache-group&quot; storepass=&quot;secret&quot;
dname=&quot;CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US&quot;/&gt;
</pre></blockquote>

@@ -119,7 +119,5 @@ with &quot;<code>\,</code>&quot;.</p>
&lt;/genkey&gt;</pre>
</blockquote>


</body>
</html>


+ 20
- 22
manual/Tasks/get.html View File

@@ -24,22 +24,22 @@

<body>

<h2><a name="get">Get</a></h2>
<h2 id="get">Get</h2>
<h3>Description</h3>
<p>Gets files from URLs. When the verbose option is &quot;on&quot;, this task
displays a '.' for every 100 Kb retrieved. Any URL schema supported by
the runtime is valid here, including http:, ftp: and jar:;
the runtime is valid here, including http:, ftp: and jar:;
</p>
The <i>usetimestamp</i> option enables you to control downloads so that the remote file is
only fetched if newer than the local copy. If there is no local copy, the download always takes
place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp.
NB: This timestamp facility only works on downloads using the HTTP protocol.
only fetched if newer than the local copy. If there is no local copy, the download always takes
place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp.
NB: This timestamp facility only works on downloads using the HTTP protocol.
<p>
A username and password can be specified, in which case basic 'slightly encoded
plain text' authentication is used. This is only secure over an HTTPS link.
</p>

<p><b>Proxies</b>. Since Apache Ant 1.7.0, Ant running on Java1.5 or later can
<p><b>Proxies</b>. Since Apache Ant 1.7.0, Ant running on Java 5 or later can
<a href="../proxy.html">use the proxy settings of the operating
system</a> if enabled with the
<code>-autoproxy</code> option. There is also the
@@ -47,9 +47,9 @@ plain text' authentication is used. This is only secure over an HTTPS link.
for earlier Java versions. With proxies turned
on, <code>&lt;get&gt;</code> requests against localhost may not work
as expected, if the request is relayed to the proxy.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -91,12 +91,12 @@ plain text' authentication is used. This is only secure over an HTTPS link.
<td valign="top">username</td>
<td valign="top">username for 'BASIC' http authentication</td>
<td align="center" valign="top">if password is set</td>
</tr>
</tr>
<tr>
<td valign="top">password</td>
<td valign="top">password: required </td>
<td valign="top">password: required</td>
<td align="center" valign="top">if username is set</td>
</tr>
</tr>
<tr>
<td valign="top">maxtime</td>
<td valign="top">Maximum time in seconds a single download may take,
@@ -104,7 +104,7 @@ plain text' authentication is used. This is only secure over an HTTPS link.
error. <em>Since Ant 1.8.0</em></td>
<td align="center" valign="top">No: default 0 which means no
maximum time</td>
</tr>
</tr>
<tr>
<td valign="top">retries</td>
<td valign="top">The number of attempts to make for opening the URI.<br/>
@@ -172,10 +172,9 @@ plain text' authentication is used. This is only secure over an HTTPS link.

<h4>header</h4>
<p>Any arbitrary number of HTTP headers can be added to a request.<br/>
The attributes of a nested <pre>&lt;header/&gt; </pre> node are as follow:
<p></p>
The attributes of a nested <code>&lt;header/&gt;</code> node are as follows:</p>

<table width="60%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -197,18 +196,18 @@ plain text' authentication is used. This is only secure over an HTTPS link.
<pre> &lt;get src=&quot;http://ant.apache.org/&quot; dest=&quot;help/index.html&quot;/&gt;</pre>
<p>Gets the index page of http://ant.apache.org/, and stores it in the file <code>help/index.html</code>.</p>

<pre> &lt;get src=&quot;http://www.apache.org/dist/ant/KEYS&quot;
dest=&quot;KEYS&quot;
<pre> &lt;get src=&quot;http://www.apache.org/dist/ant/KEYS&quot;
dest=&quot;KEYS&quot;
verbose=&quot;true&quot;
usetimestamp=&quot;true&quot;/&gt;</pre>
<p>
Gets the PGP keys of Ant's (current and past) release managers, if the local copy
is missing or out of date. Uses the verbose option
is missing or out of date. Uses the verbose option
for progress information.
</p>

<pre> &lt;get src=&quot;https://insecure-bank.org/statement/user=1214&quot;
dest=&quot;statement.html&quot;
<pre> &lt;get src=&quot;https://insecure-bank.org/statement/user=1214&quot;
dest=&quot;statement.html&quot;
username="1214";
password="secret"/&gt;</pre>
<p>
@@ -253,7 +252,7 @@ the <a href="input.html">input task</a> to query for a password.</p>

<pre>
&lt;get dest=&quot;downloads&quot;&gt;
&lt;url url=&quot;http://ant.apache.org/index.html&quot;/&gt;
&lt;url url=&quot;http://ant.apache.org/index.html&quot;/&gt;
&lt;url url=&quot;http://ant.apache.org/faq.html&quot;/&gt;
&lt;/get&gt;
</pre>
@@ -272,4 +271,3 @@ the <a href="input.html">input task</a> to query for a password.</p>
necessary.</p>
</body>
</html>


+ 1
- 2
manual/Tasks/gunzip.html View File

@@ -23,7 +23,6 @@
</head>

<body>
This document's new home is <A HREF="unpack.html">here</A>
This document's new home is <a href="unpack.html">here</a>
</body>
</html>


+ 1
- 2
manual/Tasks/gzip.html View File

@@ -23,7 +23,6 @@
</head>

<body>
This document's new home is <A HREF="pack.html">here</A>
This document's new home is <a href="pack.html">here</a>
</body>
</html>


+ 10
- 10
manual/Tasks/hostinfo.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="hostinfo">HostInfo</a></h2>
<h2 id="hostinfo">HostInfo</h2>

<h3>Description</h3>
<p>Sets the <code>NAME</code>, <code>DOMAIN</code>, <code>ADDR4</code>, and <code>ADDR6</code>
@@ -38,10 +38,10 @@ The <code>DOMAIN</code> contains the domain part of the canonical name of the ho
If the host is not found, the domain will contain the domain as provided to the task,
or <code>localdomain</code> if no host / domain was provided.<br/>
The <code>ADDR4</code> contains the IPv4 address of the host with the widest meaning.<br/>
If no IPv4 address is found and a host has been provided the address <code>0.0.0.0</code>
If no IPv4 address is found and a host has been provided the address <code>0.0.0.0</code>
is returned, when no host was provided the address <code>127.0.0.1</code> is returned.<br/>
The <code>ADDR6</code> contains the IPv6 address of the host with the widest meaning.<br/>
If no IPv6 address is found and a host has been provided the address <code>::</code>
The <code>ADDR6</code> contains the IPv6 address of the host with the widest meaning.<br/>
If no IPv6 address is found and a host has been provided the address <code>::</code>
is returned, when no host was provided the address <code>::1</code> is returned.<br/>
</p>

@@ -51,7 +51,7 @@ to indicate, for example, the host where the build was performed on.
The best place for this task is probably in an initialization target.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -79,18 +79,18 @@ The best place for this task is probably in an initialization target.</p>
</pre>

<p>
Sets the <code>NAME</code>, <code>DOMAIN</code>, <code>ADDR4</code>, and
Sets the <code>NAME</code>, <code>DOMAIN</code>, <code>ADDR4</code>, and
<code>ADDR6</code> for the local host, using the most &quot;global&quot; address
available.</p>
<pre>
&lt;hostinfo prefix=&quot;remotehost&quot; host=&quot;www.apache.org&quot;/&gt;
</pre>
<p>
Sets the properties <code>remotehost.NAME</code> to <code>eos</code>,
<code>remotehost.DOMAIN</code> to <code>apache.org</code>,
<code>remotehost.ADDR4</code> to <code>140.211.11.130</code> and
Sets the properties <code>remotehost.NAME</code> to <code>eos</code>,
<code>remotehost.DOMAIN</code> to <code>apache.org</code>,
<code>remotehost.ADDR4</code> to <code>140.211.11.130</code> and
<code>remotehost.ADDR6</code> to <code>::</code>
for the host with the name www.apache.org (provided the canonical name and ip
for the host with the name www.apache.org (provided the canonical name and ip
addresses do not change).
</p>



+ 53
- 56
manual/Tasks/image.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="image">Image</a></h2>
<h2 id="image">Image</h2>
<h3>Description</h3>
<p>Applies a chain of image operations on a set of files.</p>
<p>Requires <a href="../install.html#librarydependencies">Java Advanced Image API</a> from Sun.</p>
@@ -33,47 +33,47 @@
<img src="image-classdiagram.gif" border="0" alt="Class-Diagram">

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top"> failonerror </td>
<td valign="top"> Boolean value. If false, note errors to the output but keep going. </td>
<td align="center"> no (defaults to <i>true</i>) </td>
<td valign="top">failonerror</td>
<td valign="top">Boolean value. If false, note errors to the output but keep going.</td>
<td align="center">no (defaults to <i>true</i>)</td>
</tr>
<tr>
<td valign="top"> srcdir </td>
<td valign="top"> Directory containing the images. </td>
<td align="center"> yes, unless nested fileset is used </td>
<td valign="top">srcdir</td>
<td valign="top">Directory containing the images.</td>
<td align="center">yes, unless nested fileset is used</td>
</tr>
<tr>
<td valign="top"> encoding </td>
<td valign="top"> Image encoding type. <br>
<td valign="top">encoding</td>
<td valign="top">Image encoding type.<br>
Valid (caseinsensitive) are: jpg, jpeg, tif, tiff
</td>
<td align="center"> no (defaults to <i>JPEG</i>) </td>
<td align="center">no (defaults to <i>JPEG</i>)</td>
</tr>
<tr>
<td valign="top"> overwrite </td>
<td valign="top"> Boolean value. Sets whether or not to overwrite
<td valign="top">overwrite</td>
<td valign="top">Boolean value. Sets whether or not to overwrite
a file if there is naming conflict.
</td>
<td align="center"> no (defaults to <i>false</i>) </td>
<td align="center">no (defaults to <i>false</i>)</td>
</tr>
<tr>
<td valign="top"> gc </td>
<td valign="top"> Boolean value. Enables garbage collection after
<td valign="top">gc</td>
<td valign="top">Boolean value. Enables garbage collection after
each image processed.
</td>
<td align="center"> no (defaults to <i>false</i>) </td>
<td align="center">no (defaults to <i>false</i>)</td>
</tr>
<tr>
<td valign="top"> destdir </td>
<td valign="top"> Directory where the result images are stored. </td>
<td align="center"> no (defaults to value of <i>srcdir</i>) </td>
<td valign="top">destdir</td>
<td valign="top">Directory where the result images are stored.</td>
<td align="center">no (defaults to value of <i>srcdir</i>)</td>
</tr>
<!-- attributes inherited from MatchingTask -->
<tr>
@@ -89,7 +89,7 @@
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top"> excludes</td>
<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>
@@ -107,14 +107,14 @@
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top"> caseSensitive </td>
<td valign="top"> Boolean value. Sets case sensitivity of the file system. </td>
<td align="center"> no (defaults to <i>false</i>) </td>
<td valign="top">caseSensitive</td>
<td valign="top">Boolean value. Sets case sensitivity of the file system.</td>
<td align="center">no (defaults to <i>false</i>)</td>
</tr>
<tr>
<td valign="top"> followSymlinks </td>
<td valign="top"> Boolean value. Sets whether or not symbolic links should be followed. </td>
<td align="center"> no (defaults to <i>true</i>) </td>
<td valign="top">followSymlinks</td>
<td valign="top">Boolean value. Sets whether or not symbolic links should be followed.</td>
<td align="center">no (defaults to <i>true</i>)</td>
</tr>
</table>

@@ -133,48 +133,52 @@ ImageOperation can handle nested Rotate, Draw, Rectangle, Text and Scale objects
<h4>Rotate</h4>
<p>Adds a Rotate ImageOperation to chain.</p>
<h5>Parameters</h5>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top"> angle </td>
<td valign="top"> Float value. Sets the angle of rotation in degrees. </td>
<td align="center"> no (defaults to <i>0.0F</i>) </td>
<td valign="top">angle</td>
<td valign="top">Float value. Sets the angle of rotation in degrees.</td>
<td align="center">no (defaults to <i>0.0F</i>)</td>
</tr>
</table>

<h4>Scale</h4>
<p>Adds a Scale ImageOperation to chain.</p>
<h5>Parameters</h5>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<td valign="top"> proportions </td>
<td valign="top"> Sets which dimension to control proportions from. Valid values are:<ul>
<tr>
<td valign="top">proportions</td>
<td valign="top">Sets which dimension to control proportions from. Valid values are:
<ul>
<li>&quot;ignore&quot; - treat the dimensions independently.</li>
<li>&quot;height&quot; - keep proportions based on the width.</li>
<li>&quot;width&quot; - keep proportions based on the height.</li>
<li>&quot;cover&quot; - keep proportions and fit in the supplied dimensions.</li>
<li>&quot;fit&quot; - keep proportions and cover the supplied dimensions.</li>
</ul></td>
<td align="center"> no (defaults to <i>ignore</i>) </td>
</ul>
</td>
<td align="center">no (defaults to <i>ignore</i>)</td>
</tr>
<tr>
<td valign="top"> width </td>
<td valign="top"> Sets the width of the image, either as an integer or a %. </td>
<td valign="top">width</td>
<td valign="top">Sets the width of the image, either as an integer or a %.</td>
<!-- todo: if integer, what kind? cm, px, inches, ... -->
<td align="center"> no (defaults to <i>100%</i>) </td>
<td align="center">no (defaults to <i>100%</i>)</td>
</tr>
<tr>
<td valign="top"> height </td>
<td valign="top"> Sets the height of the image, either as an integer or a %. </td>
<td valign="top">height</td>
<td valign="top">Sets the height of the image, either as an integer or a %.</td>
<!-- todo: if integer, what kind? cm, px, inches, ... -->
<td align="center"> no (defaults to <i>100%</i>) </td>
<td align="center">no (defaults to <i>100%</i>)</td>
</tr>
</table>

@@ -182,21 +186,21 @@ ImageOperation can handle nested Rotate, Draw, Rectangle, Text and Scale objects
<p>Adds a Draw ImageOperation to chain. DrawOperation DataType objects can be
nested inside the Draw object.</p>
<h5>Parameters</h5>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top"> xloc </td>
<td valign="top"> X-Position where to draw nested image elements. </td>
<td align="center"> no (defaults to <i>0</i>) </td>
<td valign="top">xloc</td>
<td valign="top">X-Position where to draw nested image elements.</td>
<td align="center">no (defaults to <i>0</i>)</td>
</tr>
<tr>
<td valign="top"> yloc </td>
<td valign="top"> Y-Position where to draw nested image elements. </td>
<td align="center"> no (defaults to <i>0</i>) </td>
<td valign="top">yloc</td>
<td valign="top">Y-Position where to draw nested image elements.</td>
<td align="center">no (defaults to <i>0</i>)</td>
</tr>
</table>

@@ -250,12 +254,5 @@ and stores the <i>src</i>.</p>
<p>Same as above but stores the resulting file names will be prefixed
by "scaled-".</p>

<blockquote><pre>
</pre></blockquote>



</body>
</html>



+ 5
- 7
manual/Tasks/import.html View File

@@ -14,7 +14,6 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
@@ -22,7 +21,7 @@
<title>Import Task</title>
</head>
<body>
<h2><a name="import">Import</a></h2>
<h2 id="import">Import</h2>
<h3>Description</h3>
<p>
Imports another build file into the current project.
@@ -44,7 +43,7 @@

<p>
In the common use case where only Ant's default project helper is
used, it basically works like the
used, it basically works like the
<a href="http://ant.apache.org/faq.html#xml-entity-include">Entity
Includes as explained in the Ant FAQ</a>, as if the imported file was
contained in the importing file, minus the top <code>&lt;project&gt;</code>
@@ -57,12 +56,11 @@
</p>
<p>
There are two further functional aspects that pertain to this task and
that are not possible with entity includes:
that are not possible with entity includes:</p>
<ul>
<li>target overriding</li>
<li>special properties</li>
</ul>
</p>
<h4>Target overriding</h4>

<p>If a target in the main file is also present in at least one of the
@@ -165,7 +163,7 @@ project).</p>
</pre>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tbody>
<tr>
<td valign="top"><b>Attribute</b></td>
@@ -179,7 +177,7 @@ project).</p>
<td valign="top">
The file to import. If this is a relative file name, the file name will be resolved
relative to the <i>importing</i> file. <b>Note</b>, this is unlike most other
ant file attributes, where relative files are resolved relative to ${basedir}.
Ant file attributes, where relative files are resolved relative to ${basedir}.
</td>
<td valign="top" align="center">Yes or a nested resource collection</td>
</tr>


+ 3
- 5
manual/Tasks/include.html View File

@@ -14,7 +14,6 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
@@ -22,7 +21,7 @@
<title>Include Task</title>
</head>
<body>
<h2><a name="include">Include</a></h2>
<h2 id="include">Include</h2>
<h3>Description</h3>
<p>
Include another build file into the current project.
@@ -53,12 +52,11 @@
</p>
<p>
There are two further functional aspects that pertain to this task and
that are not possible with entity includes:
that are not possible with entity includes:</p>
<ul>
<li>target rewriting</li>
<li>special properties</li>
</ul>
</p>
<h4>Target rewriting</h4>

<p>Any target in the included file will be renamed
@@ -160,7 +158,7 @@ project).</p>
</pre>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tbody>
<tr>
<td valign="top"><b>Attribute</b></td>


+ 15
- 20
manual/Tasks/input.html View File

@@ -24,11 +24,11 @@

<body>

<h2><a name="input">Input</a></h2>
<h2 id="input">Input</h2>
<h3>Description</h3>

<p>Allows user interaction during the build process by prompting for
input. To do so, it uses the configured
input. To do so, it uses the configured
<a href="../inputhandler.html">InputHandler</a>.</p>

<p>The prompt can be set via the message attribute or as character
@@ -42,7 +42,7 @@ one of the predefined.</p>
user. This property can then be used during the following build
run. Input behaves according to <a href="property.html">property
task</a> which means that existing properties cannot be overridden.
Since Apache Ant 1.6, <code>&lt;input&gt;</code> will not prompt for input if
<em>Since Apache Ant 1.6</em>, <code>&lt;input&gt;</code> will not prompt for input if
a property should be set by the task that has already been set in the
project (and the task wouldn't have any effect).</p>

@@ -50,8 +50,8 @@ project (and the task wouldn't have any effect).</p>
characters to the console, this is a critical security defect, we must fix it
immediately, etc, etc. This problem was due to the lack in early versions of
Java of a (fully functional) facility for handling secure console input.
In Java 1.6 that shortcoming in Java's API was addressed and Ant versions 1.7.1
and 1.8 have added support for Java 1.6's secure console input feature
In Java 6 that shortcoming in Java's API was addressed and Ant versions 1.7.1
and 1.8 have added support for Java 6 secure console input feature
(see <a href="#handler.type">handler type</a>).</p>

<p>
@@ -60,7 +60,7 @@ type it in. For this situation, place the password in a (secured) property
file and load in before the input task.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -101,16 +101,16 @@ file and load in before the input task.</p>
<h4>Handler</h4>
<p>Since <b>Ant 1.7</b>, a nested &lt;handler&gt; element can be used to
specify an InputHandler, so that different InputHandlers may be used
among different Input tasks.
among different Input tasks.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top"><a name="handler.type" />type</td>
<tr id="handler.type">
<td valign="top">type</td>
<td valign="top">one of "default","propertyfile", "greedy", or "secure" (since Ant 1.8).
</td>
<td align="center" valign="top" rowspan="3">One of these</td>
@@ -142,7 +142,7 @@ among different Input tasks.
<td valign="top">No</td>
</tr>
</table>
<br />
<p>
The classpath can also be specified by means of one or more nested
&lt;classpath&gt; elements.</p>

@@ -157,8 +157,7 @@ implementation you use.</p>
continue...&quot; and pause the build run until return key is pressed
(again, the concrete behavior is implementation dependent).</p>
<pre> &lt;input
message=&quot;Press Return key to continue...&quot;
/&gt;</pre>
message=&quot;Press Return key to continue...&quot;/&gt;</pre>
<p>Will display the message &quot;Press Return key to
continue...&quot; and pause the build run until return key is pressed
(see above).</p>
@@ -166,8 +165,7 @@ continue...&quot; and pause the build run until return key is pressed
&lt;input
message=&quot;All data is going to be deleted from DB continue (y/n)?&quot;
validargs=&quot;y,n&quot;
addproperty=&quot;do.delete&quot;
/&gt;
addproperty=&quot;do.delete&quot;/&gt;
&lt;condition property=&quot;do.abort&quot;&gt;
&lt;equals arg1=&quot;n&quot; arg2=&quot;${do.delete}&quot;/&gt;
&lt;/condition&gt;
@@ -179,20 +177,17 @@ exit build with following message &quot;Build aborted by
user.&quot;.</p>
<pre> &lt;input
message=&quot;Please enter db-username:&quot;
addproperty=&quot;db.user&quot;
/&gt;</pre>
addproperty=&quot;db.user&quot;/&gt;</pre>
<p>Will display the message &quot;Please enter db-username:&quot; and set the
property <code>db.user</code> to the value entered by the user.</p>

<pre> &lt;input
message=&quot;Please enter db-username:&quot;
addproperty=&quot;db.user&quot;
defaultvalue=&quot;Scott-Tiger&quot;
/&gt;</pre>
defaultvalue=&quot;Scott-Tiger&quot;/&gt;</pre>
<p>Same as above, but will set <code>db.user</code> to the value
<i>Scott- Tiger</i> if the user enters no value (simply types
&lt;return&gt;).</p>


</body>
</html>

+ 32
- 36
manual/Tasks/jar.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="jar">Jar</a></h2>
<h2 id="jar">Jar</h2>
<h3>Description</h3>
<p>Jars a set of files.</p>
<p>The <i>basedir</i> attribute is the reference directory from where to jar.</p>
@@ -91,12 +91,12 @@ to a value other than its default, <code>"add"</code>.</b></p>
<p>To cryptographically sign your JAR file, use the <a href="signjar.html">SignJar task</a> on the JAR that you create from this task.</p>

<p>For creating a simple version of a <a target="_blank" href="http://openjdk.java.net/jeps/238">JEP-238 multi release jar</a>,
you don't need any special tools. Just set the required manifest entry and place the files where required, as you could see
in the <a href="#jep238-example">JEP238-example</a>. If you want to tune this kind of jar, e.g. decreasing the size by deleting
'same' classes from the versions-branches, you have to do more ...</p>
you don't need any special tools. Just set the required manifest entry and place the files where required, as you could see
in the <a href="#jep238-example">JEP238-example</a>. If you want to tune this kind of jar, e.g. decreasing the size by deleting
'same' classes from the versions-branches, you have to do more ...</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -203,9 +203,9 @@ in the <a href="#jep238-example">JEP238-example</a>. If you want to tune this ki
</tr>
<tr>
<td valign="top">index</td>
<td valign="top">whether to create an <A
HREF="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index">index
list</A> to speed up classloading. This is a JDK 1.3+ specific
<td valign="top">whether to create an <a
href="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index">index
list</a> to speed up classloading. This is a JDK 1.3+ specific
feature. Unless you specify additional jars with nested <a
href="#indexjars"><code>indexjars</code></a> elements, only the
contents of this jar will be included in the index. Defaults to
@@ -263,7 +263,7 @@ in the <a href="#jep238-example">JEP238-example</a>. If you want to tune this ki
<li><b>ignore</b> = logs a message on verbose level (default)</li>
</ul>
<em>Since Ant 1.7.1</em></td>
<td valign="top" align="center">No, defaults to <tt>ignore</tt>. </td>
<td valign="top" align="center">No, defaults to <tt>ignore</tt>.</td>
</tr>
<tr>
<td valign="top">preserve0permissions</td>
@@ -365,9 +365,9 @@ If the manifest values have changed the jar will be updated or rebuilt, as
appropriate.
</p>

<a name="indexjars"><h4>indexjars</h4></a>
<h4 id="indexjars">indexjars</h4>

<p><em>since ant 1.6.2</em></p>
<p><em>since Ant 1.6.2</em></p>

<p>The nested <code>indexjars</code> element specifies a <a
href="../using.html#path">PATH like structure</a>. Its content is
@@ -393,9 +393,9 @@ depend on your manifest:</p>
the <code>indexmetainf</code> attribute has been set
to <code>true</code>.</p>

<a name="service"><h4>service</h4></a>
<h4 id="service">service</h4>

<p><em>since ant 1.7.0</em></p>
<p><em>since Ant 1.7.0</em></p>

<p>
The nested <code>service</code> element specifies a service.
@@ -413,7 +413,7 @@ depend on your manifest:</p>
"provider" nested elements.
</p>
<p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -439,8 +439,8 @@ depend on your manifest:</p>
If a JAR file has more that one implementation of the service, a number of
nested &lt;provider&gt; elements may be used.
</p>
<h3>Examples</h3>

<h4>Simple</h4>
@@ -453,8 +453,7 @@ called <code>app.jar</code> in the <code>${dist}/lib</code> directory.</p>

<blockquote><pre> &lt;jar destfile=&quot;${dist}/lib/app.jar&quot;
basedir=&quot;${build}/classes&quot;
excludes=&quot;**/Test.class&quot;
/&gt;</pre></blockquote>
excludes=&quot;**/Test.class&quot;/&gt;</pre></blockquote>
<p>jars all files in the <code>${build}/classes</code> directory into a file
called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Files
with the name <code>Test.class</code> are excluded.</p>
@@ -462,8 +461,7 @@ with the name <code>Test.class</code> are excluded.</p>
<blockquote><pre> &lt;jar destfile=&quot;${dist}/lib/app.jar&quot;
basedir=&quot;${build}/classes&quot;
includes=&quot;mypackage/test/**&quot;
excludes=&quot;**/Test.class&quot;
/&gt;</pre></blockquote>
excludes=&quot;**/Test.class&quot;/&gt;</pre></blockquote>
<p>jars all files in the <code>${build}/classes</code> directory into a file
called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Only
files under the directory <code>mypackage/test</code> are used, and files with
@@ -472,8 +470,7 @@ the name <code>Test.class</code> are excluded.</p>
<h4>Multiple filesets</h4>
<blockquote><pre> &lt;jar destfile=&quot;${dist}/lib/app.jar&quot;&gt;
&lt;fileset dir=&quot;${build}/classes&quot;
excludes=&quot;**/Test.class&quot;
/&gt;
excludes=&quot;**/Test.class&quot;/&gt;
&lt;fileset dir=&quot;${src}/resources&quot;/&gt;
&lt;/jar&gt;</pre></blockquote>
<p>jars all files in the <code>${build}/classes</code> directory and also
@@ -542,7 +539,7 @@ by Java).</p>
&lt;/jar&gt;</pre></blockquote>
<p>
This is an example of an inline manifest specification including the version of the build
program (Implementation-Version). Note that the Built-By attribute will take the value of the Ant
program (Implementation-Version). Note that the Built-By attribute will take the value of the Ant
property ${user.name}. The manifest produced by the above would look like this:
</p>

@@ -562,7 +559,7 @@ Sealed: false</code></pre></blockquote>

<p>
The following shows how to create a jar file specifying a service
with an implementation of the JDK6 scripting interface:
with an implementation of the JDK 6 scripting interface:
</p>
<blockquote><pre>&lt;jar destfile="pinky.jar"&gt;
&lt;fileset dir="build/classes"/&gt;
@@ -575,7 +572,7 @@ Sealed: false</code></pre></blockquote>

<p>
The following shows how to create a jar file specifing a service
with two implementations of the JDK6 scripting interface:
with two implementations of the JDK 6 scripting interface:
</p>
<blockquote><pre>
&lt;jar destfile="pinkyandbrain.jar"&gt;
@@ -588,22 +585,21 @@ Sealed: false</code></pre></blockquote>
</pre></blockquote>


<a name="jep238-example"/>
<h4>JEP238 example: a Multi-Release JAR Files</h4>
<h4 id="jep238-example">JEP238 example: a Multi-Release JAR Files</h4>
<p>
Here we want to create a <i>Multi-Release JAR File</i> according the specification
<a target="_blank" href="http://openjdk.java.net/jeps/238">JEP-238</a>.
It defines on top of a JAR the possibility to place additional or overwriting classes
in a jar, which are available according to the Java version you run.<br>
Basically it sais, that you have to set the manifest entry <tt>Multi-Release: true</tt>
and place all additional or overwriting classes in
<tt>META-INF/versions/<i>number</i>/package-structure</tt>, e.g.
It defines on top of a JAR the possibility to place additional or overwriting classes
in a jar, which are available according to the Java version you run.<br>
Basically it sais, that you have to set the manifest entry <tt>Multi-Release: true</tt>
and place all additional or overwriting classes in
<tt>META-INF/versions/<i>number</i>/package-structure</tt>, e.g.
<tt>META-INF/versions/9/org/apache/ant/MyClass.class</tt>
</p>
<p>
In this example we expect that the normal classes are compiled into
<code>${java.classes}</code> and the Java9 classes are compiled into
<code>${java9.classes}</code>.
<code>${java.classes}</code> and the Java 9 classes are compiled into
<code>${java9.classes}</code>.
</p>
<blockquote><pre>
&lt;jar destfile=&quot;mrjar.jar&quot;&gt;
@@ -612,9 +608,9 @@ Sealed: false</code></pre></blockquote>
&lt;attribute name=&quot;Multi-Release&quot; value=&quot;true&quot;/&gt;
&lt;/manifest&gt;
&lt;!-- directory structure according to the spec ... --&gt;
&lt;!-- ... default classes loadable by old (&lt;Java9) versions --&gt;
&lt;!-- ... default classes loadable by old (&lt;Java 9) versions --&gt;
&lt;fileset dir=&quot;${java.classes}&quot;/&gt;
&lt;!-- ... per release classes, require Java9+ for loadable via standard ClassLoader --&gt;
&lt;!-- ... per release classes, require Java 9+ for loadable via standard ClassLoader --&gt;
&lt;zipfileset prefix=&quot;META-INF/versions/9/&quot; dir=&quot;${java9.classes}&quot;/&gt;
&lt;/jar&gt;
</pre></blockquote>


+ 2
- 5
manual/Tasks/jarlib-available.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="jarlib-available">jarlib-available</a></h2>
<h2 id="jarlib-available">jarlib-available</h2>
<h3>Description</h3>
<p>Check whether an extension is present in a fileset or an extensionSet.
If the extension is present then a property is set.</p>
@@ -39,7 +39,7 @@ Java Standard Edition package, in file
Extension and ExtensionSet documentation</a> for further details</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -127,8 +127,5 @@ sets of files to check for extension.</p>
&lt;/jarlib-available&gt;
</pre>



</body>
</html>


+ 2
- 5
manual/Tasks/jarlib-display.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="jarlib-display">jarlib-display</a></h2>
<h2 id="jarlib-display">jarlib-display</h2>
<h3>Description</h3>
<p>Display the "Optional Package" and "Package Specification" information
contained within the specified jars.</p>
@@ -39,7 +39,7 @@ Java Standard Edition package, in file
Extension and ExtensionSet documentation</a> for further details</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -73,8 +73,5 @@ Extension and ExtensionSet documentation</a> for further details</p>
&lt;/jarlib-display&gt;
</pre>



</body>
</html>


+ 2
- 5
manual/Tasks/jarlib-manifest.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="jarlib-manifest">jarlib-manifest</a></h2>
<h2 id="jarlib-manifest">jarlib-manifest</h2>
<h3>Description</h3>
<p>Task to generate a manifest that declares all the dependencies
in manifest. The dependencies are determined by looking in the
@@ -41,7 +41,7 @@ Java Standard Edition package, in file
Extension and ExtensionSet documentation</a> for further details</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -116,8 +116,5 @@ Extension and ExtensionSet documentation</a> for further details</p>
&lt;/jarlib-manifest&gt;
</pre>



</body>
</html>


+ 6
- 9
manual/Tasks/jarlib-resolve.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="jarlib-resolve">jarlib-resolve</a></h2>
<h2 id="jarlib-resolve">jarlib-resolve</h2>
<h3>Description</h3>
<p>Try to locate a jar to satisfy an extension and place
location of jar into property. The task allows you to
@@ -38,13 +38,13 @@
works with extensions as defined by the "Optional Package" specification.
For more information about optional packages, see the document
<em>Optional Package Versioning</em> in the documentation bundle for your
Java2 Standard Edition package, in file
Java Standard Edition package, in file
<code>guide/extensions/versioning.html</code> or the online
<a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/extensions/versioning.html">
Extension and ExtensionSet documentation</a> for further details</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -76,7 +76,7 @@ Extension and ExtensionSet documentation</a> for further details</p>
<h4>location</h4>
<p>The location sub element allows you to look for a library in a
location relative to project directory.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -92,7 +92,7 @@ Extension and ExtensionSet documentation</a> for further details</p>
<h4>url</h4>
<p>The url resolver allows you to download a library from a URL to a
local file.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -119,7 +119,7 @@ Extension and ExtensionSet documentation</a> for further details</p>

<h4>ant</h4>
<p>The ant resolver allows you to run an Apache Ant build file to generate a library.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -204,8 +204,5 @@ Extension and ExtensionSet documentation</a> for further details</p>
&lt;/jarlib-resolve&gt;
</pre>



</body>
</html>


+ 20
- 22
manual/Tasks/java.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="java">Java</a></h2>
<h2 id="java">Java</h2>
<h3>Description</h3>
<p>Executes a Java class within the running (Apache Ant) VM or forks another VM if
specified.</p>
@@ -36,8 +36,7 @@ JVM.
sending input to it via the <code>input</code> and <code>inputstring</code>
attributes.</p>

<h4><a name="background">Running Ant as a background process on
Unix(-like) systems</a></h4>
<h4 id="background">Running Ant as a background process on Unix(-like) systems</h4>

<p>If you run Ant as a background process (like <code>ant &</code>)
and use the <code>&lt;java&gt;</code> task with <code>spawn</code>
@@ -47,14 +46,14 @@ attributes.</p>
standard input.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top"><a name="classname">classname</a></td>
<tr id="classname">
<td valign="top">classname</td>
<td valign="top">the Java class to execute.</td>
<td align="center" valign="top">Either <tt>jar</tt>, <tt>classname</tt> or <tt>module</tt></td>
</tr>
@@ -92,7 +91,7 @@ attributes.</p>
</tr>
<tr>
<td valign="top">spawn</td>
<td valign="top">if enabled allows to start a process which will outlive ant.<br>
<td valign="top">if enabled allows to start a process which will outlive Ant.<br>
Requires fork=true, and not compatible
with timeout, input, output, error, result attributes.<br>
(disabled by default)</td>
@@ -166,7 +165,7 @@ attributes.</p>
<tr>
<td valign="top">error</td>
<td valign="top">The file to which the standard error of the command should be
redirected. </td>
redirected.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
@@ -287,7 +286,7 @@ and treated like indicated in <i>failonerror</i>.</p>
<p>Note:<br>
If you do not specify permissions,
a set of default permissions will be added to your Java invocation to make
sure that the ant run will continue or terminated as indicated by
sure that the Ant run will continue or terminated as indicated by
<i>failonerror</i>. All permissions not granted per default will be
checked by whatever security manager was already in place. exitVM will be
disallowed.
@@ -306,20 +305,20 @@ subelement.</p>

<p><em>since Ant 1.6.</em></p>

<a name="redirector"><h4>redirector</h4></a>
<i><b>Since Ant 1.6.2</b></i>
<h4 id="redirector">redirector</h4>
<em>Since Ant 1.6.2</em>
<p>A nested <a href="../Types/redirector.html">I/O Redirector</a>
can be specified. In general, the attributes of the redirector behave
as the corresponding attributes available at the task level. The most
notable peculiarity stems from the retention of the <code>&lt;java&gt;</code>
attributes for backwards compatibility. Any file mapping is done
using a <CODE>null</CODE> sourcefile; therefore not all
using a <code>null</code> sourcefile; therefore not all
<a href="../Types/mapper.html">Mapper</a> types will return
results. When no results are returned, redirection specifications
will fall back to the task level attributes. In practice this means that
defaults can be specified for input, output, and error output files.
</p>
<a name="failonerror"><h3>Errors and return codes</h3></a>
<h3 id="failonerror">Errors and return codes</h3>
By default the return code of a <code>&lt;java&gt;</code> is ignored.
Alternatively, you can set <code>resultproperty</code> to the name
of a property and have it assigned to the result code (barring immutability,
@@ -327,22 +326,21 @@ of course).
When you set <code>failonerror="true"</code>, the only possible value for
<code>resultproperty</code> is 0. Any non-zero response is treated as an
error and would mean the build exits.
<p> Similarly, if <code>failonerror="false"</code> and <code>fork="false"</code>
, then <code>&lt;java&gt;</code> <b>must</b> return 0 otherwise the build will
<p>Similarly, if <code>failonerror="false"</code> and <code>fork="false"</code>,
then <code>&lt;java&gt;</code> <b>must</b> return 0 otherwise the build will
exit, as the class was run by the build JVM.</p>

<a name="modulepath"><h4>modulepath</h4>
<i><b>Since Ant 1.9.7</b></i>
<h4 id="modulepath">modulepath</h4>
<em>Since Ant 1.9.7</em>
<p><code>Java</code>'s <i>modulepath</i> attribute is a <a
href="../using.html#path">PATH like structure</a> and can also be set via a nested
<i>modulepath</i> element.</p>

<a name="upgrademodulepath"><h4>upgrademodulepath</h4>
<i><b>Since Ant 1.9.7</b></i>
<h4 id="upgrademodulepath">upgrademodulepath</h4>
<em>Since Ant 1.9.7</em>
<p>The location of modules that replace upgradeable modules in the runtime image
can be specified using this <a href="../using.html#path">PATH like structure</a>.</p>


<h3>JAR file execution</h3>

<p>The parameter of the <tt>jar</tt> attribute is of type <tt>File</tt>;
@@ -351,9 +349,9 @@ base directory of the project, <i>not</i> the directory in which the Java
task is run. If you need to locate a JAR file relative to the directory
the task will be run in, you need to explicitly create the full path
to the JAR file.</p>
<p>When using the <tt>jar</tt> attribute, all classpath settings are
<p>When using the <tt>jar</tt> attribute, all classpath settings are
ignored according to <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/java.html">Oracle's
specification</a>.
specification</a>.


<h3>Examples</h3>


+ 32
- 46
manual/Tasks/javac.html View File

@@ -14,7 +14,7 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<html lang="en-us">
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
@@ -24,7 +24,7 @@

<body>

<h2><a name="javac">Javac</a></h2>
<h2 id="javac">Javac</h2>
<h3>Description</h3>
<p>Compiles a Java source tree.</p>
<p>The source and destination directory will be recursively scanned for Java
@@ -57,7 +57,7 @@ element(s), or by using wildcard patterns. See the section on
<a href="../dirtasks.html#directorybasedtasks">directory-based tasks</a>,
for information on how the
inclusion/exclusion of files works, and how to write wildcard patterns.</p>
<p>It is possible to use different compilers. This can be specified by
<p id="compilervalues">It is possible to use different compilers. This can be specified by
either setting the global <code>build.compiler</code> property, which will
affect all <code>&lt;javac&gt;</code> tasks throughout the build, by
setting the <code>compiler</code> attribute, specific to the current
@@ -65,9 +65,9 @@ setting the <code>compiler</code> attribute, specific to the current
<a href="typedef.html">typedef</a>fed or
<a href="componentdef.html">componentdef</a>fed type that implements
<code>org.apache.tools.ant.taskdefs.compilers.CompilerAdapter</code>.
<a name="compilervalues">Valid values for either the
Valid values for either the
<code>build.compiler</code> property or the <code>compiler</code>
attribute are:</a></p>
attribute are:</p>
<ul>
<li><code>classic</code> (the standard compiler of JDK 1.1/1.2) &ndash;
<code>javac1.1</code> and
@@ -106,7 +106,7 @@ classname in the <code>build.compiler</code> property or the
</p>
<p>The fork attribute overrides the <code>build.compiler</code> property
or <code>compiler</code> attribute setting and
expects a JDK1.1 or higher to be set in <code>JAVA_HOME</code>.
expects a JDK 1.1 or higher to be set in <code>JAVA_HOME</code>.
</p>
<p>You can also use the <code>compiler</code> attribute to tell Ant
which JDK version it shall assume when it puts together the command
@@ -136,7 +136,7 @@ invoking the compiler.</p>
corresponding <code>.java</code> file the file will not get compiled
even if a native header file generated for it would be outdated.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -299,7 +299,8 @@ invoking the compiler.</p>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">depend</td> <td valign="top">Enables dependency-tracking
<td valign="top">depend</td>
<td valign="top">Enables dependency-tracking
for compilers that support this (<code>jikes</code> and
<code>classic</code>).</td>
<td align="center" valign="top">No</td>
@@ -424,7 +425,7 @@ invoking the compiler.</p>
<tr>
<td valign="top">updatedProperty</td>
<td valign="top">
The property to set (to the value "true")
The property to set (to the value "true")
if compilation has taken place
and has been successful.
<em>Since Ant 1.7.1</em>.
@@ -568,7 +569,7 @@ are specified like <a href="../using.html#arg">Command-line
Arguments</a> but have an additional attribute that can be used to
enable arguments only if a given compiler implementation will be
used.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -630,8 +631,7 @@ used.</p>
destdir=&quot;${build}&quot;
classpath=&quot;xyz.jar&quot;
debug=&quot;on&quot;
source=&quot;1.4&quot;
/&gt;</pre>
source=&quot;1.4&quot;/&gt;</pre>
<p>compiles all <code>.java</code> files under the <code>${src}</code>
directory, and stores
the <code>.class</code> files in the <code>${build}</code> directory.
@@ -643,8 +643,7 @@ so you can use <code>assert</code> statements.</p>
destdir=&quot;${build}&quot;
fork=&quot;true&quot;
source=&quot;1.2&quot;
target=&quot;1.2&quot;
/&gt;</pre>
target=&quot;1.2&quot;/&gt;</pre>
<p>compiles all <code>.java</code> files under the <code>${src}</code>
directory, and stores the <code>.class</code> files in the
<code>${build}</code> directory. This will fork off the javac
@@ -655,8 +654,7 @@ the class files should be runnable under JDK 1.2+ as well.</p>
<pre> &lt;javac srcdir=&quot;${src}&quot;
destdir=&quot;${build}&quot;
fork=&quot;java$$javac.exe&quot;
source=&quot;1.5&quot;
/&gt;</pre>
source=&quot;1.5&quot;/&gt;</pre>
<p>compiles all <code>.java</code> files under the <code>${src}</code>
directory, and stores the <code>.class</code> files in the
<code>${build}</code> directory. This will fork off the javac
@@ -669,8 +667,7 @@ The source level is 1.5, so you can use generics.</p>
includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;
excludes=&quot;mypackage/p1/testpackage/**&quot;
classpath=&quot;xyz.jar&quot;
debug=&quot;on&quot;
/&gt;</pre>
debug=&quot;on&quot;/&gt;</pre>
<p>compiles <code>.java</code> files under the <code>${src}</code>
directory, and stores the
<code>.class</code> files in the <code>${build}</code> directory.
@@ -686,8 +683,7 @@ so the actual values used will depend on which JDK you ran Ant with.</p>
includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;
excludes=&quot;mypackage/p1/testpackage/**&quot;
classpath=&quot;xyz.jar&quot;
debug=&quot;on&quot;
/&gt;</pre>
debug=&quot;on&quot;/&gt;</pre>

<p>is the same as the previous example, with the addition of a second
source path, defined by
@@ -715,10 +711,9 @@ Java VM of a different version:</p>
destdir=&quot;${build}&quot;
fork=&quot;yes&quot;
executable=&quot;/opt/java/jdk1.1/bin/javac&quot;
compiler=&quot;javac1.1&quot;
/&gt;</pre>
compiler=&quot;javac1.1&quot;/&gt;</pre>

<p><a name="srcdirnote"><b>Note:</b></a>
<p id="srcdirnote"><b>Note:</b>
If you wish to compile only source files located in certain packages below a
common root, use the <code>include</code>/<code>exclude</code> attributes
or <code>&lt;include&gt;</code>/<code>&lt;exclude&gt;</code> nested elements
@@ -732,13 +727,13 @@ for additional information.</p>
<p>
If you wish to compile only files explicitly specified and disable
javac's default searching mechanism then you can unset the sourcepath
attribute:
attribute:</p>
<pre> &lt;javac sourcepath=&quot;&quot; srcdir=&quot;${src}&quot;
destdir=&quot;${build}&quot; &gt;
&lt;include name="**/*.java"/&gt;
&lt;exclude name="**/Example.java"/&gt;
&lt;/javac&gt;</pre>
That way the javac will compile all java source files under &quot;${src}&quot;
<p>That way the javac will compile all java source files under &quot;${src}&quot;
directory but skip the examples. The compiler will even produce errors if some of
the non-example files refers to them.
</p>
@@ -746,14 +741,12 @@ the non-example files refers to them.
<p>
If you wish to compile with a special JDK (another than the one Ant is currently using),
set the <code>executable</code> and <code>fork</code> attribute. Using <code>taskname</code>
could show in the log, that these settings are fix.
<pre> &lt;javac srcdir=&quot;&quot;
could show in the log, that these settings are fix.</p>
<pre> &lt;javac srcdir=&quot;&quot;
destdir=&quot;&quot;
executable=&quot;path-to-java14-home/bin/javac&quot;
executable=&quot;path-to-java14-home/bin/javac&quot;
fork=&quot;true&quot;
taskname=&quot;javac1.4&quot; /&gt;</pre>
</p>

taskname=&quot;javac1.4&quot;/&gt;</pre>

<p><b>Note:</b> If you are using Ant on Windows and a new DOS window pops up
for every use of an external compiler, this may be a problem of the JDK you are
@@ -762,13 +755,12 @@ using. This problem may occur with all JDKs &lt; 1.2.</p>

<p>
If you want to activate other compiler options like <i>lint</i> you could use
the <tt>&lt;compilerarg&gt;</tt> element:
the <tt>&lt;compilerarg&gt;</tt> element:</p>
<pre> &lt;javac srcdir="${src.dir}"
destdir="${classes.dir}"
classpathref="libraries"&gt;
&lt;compilerarg value="-Xlint"/&gt;
&lt;/javac&gt; </pre>
</p>
&lt;/javac&gt;</pre>

<p>If you want to use a custom
CompilerAdapter <code>org.example.MyAdapter</code> you can either
@@ -776,8 +768,7 @@ the <tt>&lt;compilerarg&gt;</tt> element:
<pre>
&lt;javac srcdir="${src.dir}"
destdir="${classes.dir}"
compiler="org.example.MyAdapter"/&gt;
</pre>
compiler="org.example.MyAdapter"/&gt;</pre>
<p>or a define a type and nest this into the task like in:</p>
<pre>
&lt;componentdef classname="org.example.MyAdapter"
@@ -794,8 +785,7 @@ the <tt>&lt;compilerarg&gt;</tt> element:
destdir=&quot;${build}&quot;
includeantruntime=&quot;false&quot;
modulepath=&quot;modules&quot;
source=&quot;9&quot;
/&gt;</pre>
source=&quot;9&quot;/&gt;</pre>
<p>compiles all <code>.java</code> files in a single module under the <code>${src}</code> directory,
and stores the <code>.class</code> files in the <code>${build}</code> directory. The compilation uses
application modules located in <code>modules</code> folder.The source level is <code>9</code> to enable modules.</p>
@@ -804,8 +794,7 @@ the <tt>&lt;compilerarg&gt;</tt> element:
destdir=&quot;${build}&quot;
includeantruntime=&quot;false&quot;
modulepath=&quot;modules&quot;
source=&quot;9&quot;
/&gt;</pre>
source=&quot;9&quot;/&gt;</pre>
<p>compiles all <code>.java</code> files in <code>gen/classes</code>, <code>lin32/classes</code> and
<code>lin64/classes</code> in all source modules under the <code>${src}</code> directory.
Generates module directories in the <code>${build}</code> directory. Each generated module directory under
@@ -831,7 +820,7 @@ interpreted as anything other than false. By default,
<code>build.compiler.warnings</code> is <code>true</code>,
while all others are <code>false</code>.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Property</b></td>
<td valign="top"><b>Description</b></td>
@@ -893,7 +882,7 @@ while all others are <code>false</code>.</p>
<code>build.compiler.jvc.extensions</code> to false before invoking
<code>&lt;javac&gt;</code>.</p>

<h3><a name="bootstrap">Bootstrap Options</h3>
<h3 id="bootstrap">Bootstrap Options</h3>
<p>
The Sun javac compiler has a <em>bootclasspath</em> command
line option - this corresponds to the "bootclasspath" attribute/element
@@ -913,9 +902,6 @@ while all others are <code>false</code>.</p>
&lt;/javac&gt;
</pre>

</p>

<h3>OpenJDK Notes</h3>
<p>
The <a href="https://openjdk.dev.java.net/">openjdk</a>
@@ -945,7 +931,7 @@ while all others are <code>false</code>.</p>

<h3>Note on package-info.java</h3>
<p>
<code>package-info.java</code> files were introduced in Java5 to
<code>package-info.java</code> files were introduced in Java 5 to
allow package level annotations. On compilation, if the java file
does not contain runtime annotations, there will be no .class file
for the java file. Up to <b>Ant 1.7.1</b>, when the &lt;javac&gt;


+ 4
- 8
manual/Tasks/javacc.html View File

@@ -24,10 +24,10 @@

<body>

<h2><a name="javacc">JavaCC</a></h2>
<h2 id="javacc">JavaCC</h2>
<h3>Description</h3>
<p>
Invokes the <a HREF="http://javacc.dev.java.net/" target="_top">JavaCC</a> compiler
Invokes the <a href="http://javacc.dev.java.net/" target="_top">JavaCC</a> compiler
compiler on a grammar file.
</p>
<p>
@@ -48,7 +48,7 @@
</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -194,8 +194,7 @@
target=&quot;src/Parser.jj&quot;
outputdirectory=&quot;build/src&quot;
javacchome=&quot;c:/program files/JavaCC&quot;
static=&quot;true&quot;
/&gt;
static=&quot;true&quot;/&gt;
</pre></blockquote>
<p>
This invokes JavaCC on grammar file src/Parser.jj, writing the generated
@@ -203,8 +202,5 @@
invoking JavaCC.
</p>


</body>
</html>



+ 14
- 17
manual/Tasks/javadoc.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="javadoc">Javadoc/<i>Javadoc2</i></a></h2>
<h2 id="javadoc">Javadoc/<i>Javadoc2</i></h2>
<h3>Description</h3>
<p>Generates code documentation using the javadoc tool.</p>
<p>The source directory will be recursively scanned for Java source files to process
@@ -81,7 +81,7 @@ to &lt;javadoc&gt; using <tt>classpath</tt>, <tt>classpathref</tt> attributes or
with the exclude patterns of the packageset (and vice versa).</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -523,8 +523,8 @@ to &lt;javadoc&gt; using <tt>classpath</tt>, <tt>classpathref</tt> attributes or
order to mitigate CVE-2013-1571. Defaults to true. <em>Since Ant
1.9.2</em><br>
There is a frame injection attack possible in javadocs generated by Oracle
JDKs prior to Java7 Update 25 (<a href="http://www.oracle.com/technetwork/java/javase/7u25-relnotes-1955741.html#jpi-upt" target="_blank">details</a>).
When this flag is set to true, Ant will check whether the docs are vulnerable
JDKs prior to Java 7 update 25 (<a href="http://www.oracle.com/technetwork/java/javase/7u25-relnotes-1955741.html#jpi-upt" target="_blank">details</a>).
When this flag is set to true, Ant will check whether the docs are vulnerable
and will try to fix them.
</td>
<td align="center" valign="top">1.4</td>
@@ -532,7 +532,7 @@ to &lt;javadoc&gt; using <tt>classpath</tt>, <tt>classpathref</tt> attributes or
</tr>
</table>

<h4><a name="groupattribute">Format of the group attribute</a></h4>
<h4 id="groupattribute">Format of the group attribute</h4>
<p>The arguments are comma-delimited. Each single argument is 2
space-delimited strings, where the first one is the group's title and
the second one a colon delimited list of packages.</p>
@@ -588,7 +588,7 @@ javadoc as source files.</p>
<p>Same as one entry in the list given by <code>packagenames</code>.</p>

<h5>Parameters</h5>
<table width="90%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -611,7 +611,7 @@ Same as for <code>package</code>.
<p>Same as one entry in the list given by <code>sourcefiles</code>.</p>

<h5>Parameters</h5>
<table width="90%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -651,7 +651,7 @@ syntax (or both at once), but with the nested elements you can easily
specify multiple occurrences of the arguments.</p>

<h5>Parameters</h5>
<table width="90%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -692,7 +692,7 @@ specify multiple occurrences of the arguments.</p>
</tr>
</table>

<h4><a name="groupelement">group</a></h4>
<h4 id="groupelement">group</h4>
<p>Separates packages on the overview page into whatever groups you
specify, one group per table. This performs the same role as the group
attribute. You can use either syntax (or both at once), but with the
@@ -700,7 +700,7 @@ nested elements you can easily specify multiple occurrences of the
arguments.</p>

<h5>Parameters</h5>
<table width="90%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -745,14 +745,14 @@ of the doclet element is shown below:</p>
&lt;/javadoc&gt;
</pre>

<h4><a name="tagelement">tag</a></h4>
<h4 id="tagelement">tag</h4>

<p>If you want to specify a standard tag using a nested tag element
because you want to determine the order the tags are output, you must
not set the description attribute for those tags.</p>

<h5>Parameters</h5>
<table width="90%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -803,12 +803,12 @@ the javadoc program.
</tr>
</table>

<h4><a name="tagletelement">taglet</a></h4>
<h4 id="tagletelement">taglet</h4>
<p>The taglet nested element is used to specify custom
<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html">taglets</a> beyond <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags" target="_blank">the default taglets</a>.</p>

<h5>Parameters</h5>
<table width="90%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -908,8 +908,5 @@ arguments</a>. <em>Since Ant 1.6</em></p>
&lt;link href=&quot;http://docs.oracle.com/javase/7/docs/api/&quot;/&gt;
&lt/javadoc&gt;</pre>



</body>
</html>


+ 15
- 15
manual/Tasks/javah.html View File

@@ -24,13 +24,13 @@

<body>

<h2><a name="javah">Javah</a></h2>
<h2 id="javah">Javah</h2>
<h3>Description</h3>
<p>Generates JNI headers from a Java class.</p>
<p> When this task executes, it will generate the C header and source files that
<p>When this task executes, it will generate the C header and source files that
are needed to implement native methods. JNI operates differently depending on
whether <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javah.html">JDK1.2+</a>
or <a href="http://java.sun.com/products/jdk/1.1/docs/tooldocs/win32/javah.html">pre-JDK1.2</a>
whether <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javah.html">JDK 1.2+</a>
or <a href="http://java.sun.com/products/jdk/1.1/docs/tooldocs/win32/javah.html">pre-1.2 JDK</a>
systems are used.</p>

<p>If you are building with Java 8 or above consider
@@ -39,12 +39,13 @@ systems are used.</p>
generate the native header files with a single step.</p>

<p><b>Note</b> the <code>javah</code> has been deprecated as of Java 9
and removed as of Java 10. Trying to use it with Java10 will
and removed as of Java 10. Trying to use it with Java 10 will
fail.</p>

<p>It is possible to use different compilers. This can be selected
with the <code>implementation</code> attribute or a nested element. <a
name="implementationvalues">Here are the choices of the attribute</a>:</p>
<p id="implementationvalues">It is possible to use different
compilers. This can be selected with the <code>implementation</code>
attribute or a nested element. Here are the choices of the
attribute:</p>
<ul>
<li>default - the default compiler for the platform.</li>
<li>sun (the standard compiler of the JDK)</li>
@@ -64,7 +65,7 @@ name="implementationvalues">Here are the choices of the attribute</a>:</p>
breaking the amount of classes to compile into smaller chunks.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -88,13 +89,13 @@ name="implementationvalues">Here are the choices of the attribute</a>:</p>
</tr>
<tr>
<td valign="top">force</td>
<td valign="top">specifies that output files should always be written (JDK1.2 only)</td>
<td valign="top">specifies that output files should always be written (JDK 1.2 only)</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">old</td>
<td valign="top">specifies that old JDK1.0-style header files should be generated
(otherwise output file contain JNI-style native method function prototypes) (JDK1.2 only)</td>
<td valign="top">specifies that old JDK 1.0-style header files should be generated
(otherwise output file contain JNI-style native method function prototypes) (JDK 1.2 only)</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
@@ -143,7 +144,7 @@ specified like <a href="../using.html#arg">Command-line Arguments</a>
but have an additional attribute that can be used to enable arguments
only if a given compiler implementation will be used.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -201,7 +202,7 @@ only if a given compiler implementation will be used.</p>

<h3>Examples</h3>
<pre> &lt;javah destdir=&quot;c&quot; class=&quot;org.foo.bar.Wibble&quot;/&gt;</pre>
<p>makes a JNI header of the named class, using the JDK1.2 JNI model. Assuming
<p>makes a JNI header of the named class, using the JDK 1.2 JNI model. Assuming
the directory 'c' already exists, the file <tt>org_foo_bar_Wibble.h</tt>
is created there. If this file already exists, it is left unchanged.</p>
<pre> &lt;javah outputFile=&quot;wibble.h&quot;&gt;
@@ -251,5 +252,4 @@ describe its progress.</p>
nested elements of its own.</p>

</body>

</html>

+ 40
- 47
manual/Tasks/jdepend.html View File

@@ -14,27 +14,24 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">

<html>
<head>
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>JDepend Task</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>JDepend Task</title>
<meta http-equiv="Content-Language" content="en-us">
</head>

<body>

<h2><a NAME="JDepend"></a>JDepend</h2>
<h2 id="jdepend">JDepend</h2>

<h3>Description</h3>

<P>Invokes the <a href="http://www.clarkware.com/software/JDepend.html">JDepend</a> parser.</P>
<p>Invokes the <a href="http://www.clarkware.com/software/JDepend.html">JDepend</a> parser.</p>

<P>This parser &quot;traverses a set of Java source file directories and generates design quality metrics for each Java package&quot;.
<p>This parser &quot;traverses a set of Java source file directories and generates design quality metrics for each Java package&quot;.
It allows to &quot;automatically measure the quality of a design in terms of its extensibility, reusability, and maintainability to
effectively manage and control package dependencies.&quot;</P>
effectively manage and control package dependencies.&quot;</p>

<p>Source file directories are defined by nested
<code>&lt;sourcespath&gt;</code>; Class file directories are defined
@@ -43,68 +40,68 @@ href="#nested">nested elements</a>.</p>

<p>Optionally, you can also set the <code>outputfile</code> name where the output is stored. By default the task writes its report to the standard output.</P>

<p> The task requires at least the JDepend 1.2 version. </p>
<p>The task requires at least the JDepend 1.2 version.</p>

<h3>Parameters</h3>

<table BORDER=1 CELLSPACING=0 CELLPADDING=2 >
<table>
<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"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td VALIGN=TOP>outputfile</td>
<td VALIGN=TOP>The output file name. If not set, the output is printed on the standard output.</td>
<td ALIGN=CENTER VALIGN=TOP>No</td>
<td valign="top">outputfile</td>
<td valign="top">The output file name. If not set, the output is printed on the standard output.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td VALIGN=TOP>format</td>
<td VALIGN=TOP>The format to write the output in. The default is "text", the alternative is "xml"</td>
<td ALIGN=CENTER VALIGN=TOP>No</td>
<td valign="top">format</td>
<td valign="top">The format to write the output in. The default is "text", the alternative is "xml"</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td VALIGN=TOP>fork</td>
<td VALIGN=TOP>Run the tests in a separate VM.</td>
<td ALIGN=CENTER VALIGN=TOP>No, default is "off"</td>
<td valign="top">fork</td>
<td valign="top">Run the tests in a separate VM.</td>
<td align="center" valign="top">No, default is "off"</td>
</tr>
<tr>
<td VALIGN=TOP>haltonerror</td>
<td VALIGN=TOP>Stop the build process if an error occurs during the jdepend analysis.</td>
<td ALIGN=CENTER VALIGN=TOP>No, default is "off"</td>
<td valign="top">haltonerror</td>
<td valign="top">Stop the build process if an error occurs during the jdepend analysis.</td>
<td align="center" valign="top">No, default is "off"</td>
</tr>
<tr>
<td VALIGN=TOP>timeout</td>
<td VALIGN=TOP>Cancel the operation if it doesn't finish in the given time (measured in milliseconds). (Ignored if fork is disabled.)</td>
<td ALIGN=CENTER VALIGN=TOP>No</td>
<td valign="top">timeout</td>
<td valign="top">Cancel the operation if it doesn't finish in the given time (measured in milliseconds). (Ignored if fork is disabled.)</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td VALIGN=TOP>jvm</td>
<td VALIGN=TOP>The command used to invoke the Java Virtual Machine, default is 'java'. The command is resolved by java.lang.Runtime.exec(). (Ignored if fork is disabled.)</td>
<td ALIGN=CENTER VALIGN=TOP>No, default "java"</td>
<td valign="top">jvm</td>
<td valign="top">The command used to invoke the Java Virtual Machine, default is 'java'. The command is resolved by java.lang.Runtime.exec(). (Ignored if fork is disabled.)</td>
<td align="center" valign="top">No, default "java"</td>
</tr>
<tr>
<td VALIGN=TOP>dir</td>
<td VALIGN=TOP>The directory to invoke the VM in. (Ignored if fork is disabled)</td>
<td ALIGN=CENTER VALIGN=TOP>No</td>
<td valign="top">dir</td>
<td valign="top">The directory to invoke the VM in. (Ignored if fork is disabled)</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td VALIGN=TOP>includeruntime</td>
<td VALIGN=TOP>Implicitly add the classes required to run jdepend
<td valign="top">includeruntime</td>
<td valign="top">Implicitly add the classes required to run jdepend
in forked mode. (Ignored if fork is disabled). Since Apache Ant 1.6.</td>
<td ALIGN=CENTER VALIGN=TOP>No, default is "no".</td>
<td align="center" valign="top">No, default is "no".</td>
</tr>
<tr>
<td VALIGN=TOP>classpathref</td>
<td VALIGN=TOP>the classpath to use, given as reference to a PATH defined elsewhere.</td>
<td ALIGN=CENTER VALIGN=TOP>No</td>
<td valign="top">classpathref</td>
<td valign="top">the classpath to use, given as reference to a PATH defined elsewhere.</td>
<td align="center" valign="top">No</td>
</tr>
</table>

<h3><a name="nested">Nested Elements</a></h3>
<h3 id="nested">Nested Elements</h3>

<p><code>jdepend</code> supports four nested elements:
<code>&lt;classpath&gt;, &lt;classespath&gt; </code> and
<code>&lt;classpath&gt;, &lt;classespath&gt;</code> and
<code>&lt;sourcespath&gt;</code>, that represent <a
href="../using.html#path">PATH like structures</a>, and
<code>&lt;exclude&gt;</code>.</p>
@@ -127,7 +124,6 @@ to ignore (requires JDepend 2.5 or above).</p>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &lt;pathelement location="build"/&gt;
&nbsp;&nbsp;&nbsp; &lt;/classespath&gt;
&lt;/jdepend&gt;

</pre>
</blockquote>

@@ -152,7 +148,7 @@ classpath reference.</p>
<p>This invokes JDepend in a separate VM on the <code>src</code> and
<code>testsrc</code> directories, writing the output to the
<code>&lt;docs/jdepend.xml&gt;</code> file in xml format. The
classpath is defined using nested elements. </p>
classpath is defined using nested elements.</p>

<blockquote>
<pre>
@@ -170,8 +166,5 @@ classpath is defined using nested elements. </p>
files to analyze, and will ignore all classes in the java.* and
javax.* packages.</p>


</body>
</html>



+ 24
- 30
manual/Tasks/jjdoc.html View File

@@ -14,18 +14,15 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>JJDoc Task</title>
</head>
<body>

<h2>
<a NAME="jjtree"></a>JJDoc</h2>
<h2 id="jjtree">JJDoc</h2>
<p><em>Since Apache Ant 1.6</em></p>
<h3>Description</h3>

@@ -36,7 +33,7 @@ It can operate in three modes, determined by command line options.
<p>To use the jjdoc task, set the <i>target</i> attribute to the name
of the JavaCC grammar file to process. You also need to specify the directory
containing the JavaCC installation using the <i>javacchome</i> attribute,
so that ant can find the JavaCC classes. Optionally, you can also set the
so that Ant can find the JavaCC classes. Optionally, you can also set the
<i>outputfile</i> to write the generated BNF documentation file to a specific (directory and) file.
Otherwise jjdoc writes the generated BNF documentation file as the JavaCC
grammar file with a suffix .txt or .html.</p>
@@ -45,55 +42,55 @@ generated BNF documentation file.</p>

<h3>Parameters</h3>

<table BORDER CELLSPACING=0 CELLPADDING=2 >
<table>
<tr>
<td VALIGN=TOP><b>Attribute</b></td>
<td valign="top"><b>Attribute</b></td>

<td VALIGN=TOP><b>Description</b></td>
<td valign="top"><b>Description</b></td>

<td ALIGN=CENTER VALIGN=TOP><b>Required</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>

<tr>
<td VALIGN=TOP>target</td>
<td valign="top">target</td>

<td VALIGN=TOP>The javacc grammar file to process.</td>
<td valign="top">The javacc grammar file to process.</td>

<td ALIGN=CENTER VALIGN=TOP>Yes</td>
<td align="center" valign="top">Yes</td>
</tr>

<tr>
<td VALIGN=TOP>javacchome</td>
<td valign="top">javacchome</td>

<td VALIGN=TOP>The directory containing the JavaCC distribution.</td>
<td valign="top">The directory containing the JavaCC distribution.</td>

<td ALIGN=CENTER VALIGN=TOP>Yes</td>
<td align="center" valign="top">Yes</td>
</tr>

<tr>
<td VALIGN=TOP>outputfile</td>
<td valign="top">outputfile</td>

<td VALIGN=TOP>The file to write the generated BNF documentation file to. If not set,
<td valign="top">The file to write the generated BNF documentation file to. If not set,
the file is written with the same name as the JavaCC grammar file but with a the suffix .html or .txt.&nbsp;</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>text</td>
<td valign="top">text</td>

<td VALIGN=TOP>Sets the TEXT BNF documentation option. This is a boolean
<td valign="top">Sets the TEXT BNF documentation option. This is a boolean
option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>onetable</td>
<td valign="top">onetable</td>

<td VALIGN=TOP>Sets the ONE_TABLE BNF documentation option. This is a boolean option.</td>
<td valign="top">Sets the ONE_TABLE BNF documentation option. This is a boolean option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
@@ -108,16 +105,13 @@ option.</td>
Example</h3>

<blockquote>
<pre>&lt;jjdoc&nbsp;
&nbsp;&nbsp;&nbsp; target="src/Parser.jj"&nbsp;
<pre>&lt;jjdoc
&nbsp;&nbsp;&nbsp; target="src/Parser.jj"
&nbsp;&nbsp;&nbsp; outputfile="doc/ParserBNF.html"
&nbsp;&nbsp;&nbsp; javacchome="c:/program files/JavaCC"&nbsp;
/&gt;</pre>
&nbsp;&nbsp;&nbsp; javacchome="c:/program files/JavaCC"/&gt;</pre>
</blockquote>
This invokes JJDoc on grammar file src/Parser.jj, writing the generated
BNF documentation file, ParserBNF.html, file to doc.
<br>

</body>
</html>


+ 63
- 75
manual/Tasks/jjtree.html View File

@@ -14,21 +14,17 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>JJTree Task</title>
</head>
<body>

<h2>
<a NAME="jjtree"></a>JJTree</h2>
<h2 id="jjtree">JJTree</h2>

<h3>
Description</h3>
<h3>Description</h3>
<p>Invokes the <a href="http://javacc.dev.java.net/">JJTree</a> preprocessor
for the JavaCC compiler compiler. It inserts parse tree building actions
at various places in the JavaCC source that it generates. The output of
@@ -49,143 +45,143 @@ generated JavaCC file.</p>

<h3>Parameters</h3>

<table BORDER CELLSPACING=0 CELLPADDING=2 >
<table>
<tr>
<td VALIGN=TOP><b>Attribute</b></td>
<td valign="top"><b>Attribute</b></td>

<td VALIGN=TOP><b>Description</b></td>
<td valign="top"><b>Description</b></td>

<td ALIGN=CENTER VALIGN=TOP><b>Required</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>

<tr>
<td VALIGN=TOP>target</td>
<td valign="top">target</td>

<td VALIGN=TOP>The jjtree grammar file to process.</td>
<td valign="top">The jjtree grammar file to process.</td>

<td ALIGN=CENTER VALIGN=TOP>Yes</td>
<td align="center" valign="top">Yes</td>
</tr>

<tr>
<td VALIGN=TOP>javacchome</td>
<td valign="top">javacchome</td>

<td VALIGN=TOP>The directory containing the JavaCC distribution.</td>
<td valign="top">The directory containing the JavaCC distribution.</td>

<td ALIGN=CENTER VALIGN=TOP>Yes</td>
<td align="center" valign="top">Yes</td>
</tr>

<tr>
<td VALIGN=TOP>outputdirectory</td>
<td valign="top">outputdirectory</td>

<td VALIGN=TOP>The directory to write the generated JavaCC grammar and node files to.
<td valign="top">The directory to write the generated JavaCC grammar and node files to.
If not set, the files are written to the directory containing the grammar file.&nbsp;</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>outputfile</td>
<td valign="top">outputfile</td>

<td VALIGN=TOP>The file to write the generated JavaCC grammar file
<td valign="top">The file to write the generated JavaCC grammar file
to. If not set, the file is written with the same name as the JJTree
grammar file but with a the suffix <code>.jj</code>. This is a
filename relative to <em>outputdirectory</em> if specified, the
project's basedir.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>buildnodefiles</td>
<td valign="top">buildnodefiles</td>

<td VALIGN=TOP>Sets the BUILD_NODE_FILES grammar option. This is a boolean
<td valign="top">Sets the BUILD_NODE_FILES grammar option. This is a boolean
option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>multi</td>
<td valign="top">multi</td>

<td VALIGN=TOP>Sets the MULTI grammar option. This is a boolean option.</td>
<td valign="top">Sets the MULTI grammar option. This is a boolean option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>nodedefaultvoid</td>
<td valign="top">nodedefaultvoid</td>

<td VALIGN=TOP>Sets the NODE_DEFAULT_VOID grammar option. This is a boolean
<td valign="top">Sets the NODE_DEFAULT_VOID grammar option. This is a boolean
option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>nodefactory</td>
<td valign="top">nodefactory</td>

<td VALIGN=TOP>Sets the NODE_FACTORY grammar option. This is boolean option.</td>
<td valign="top">Sets the NODE_FACTORY grammar option. This is boolean option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>nodescopehook</td>
<td valign="top">nodescopehook</td>

<td VALIGN=TOP>Sets the NODE_SCOPE_HOOK grammar option. This is a boolean
<td valign="top">Sets the NODE_SCOPE_HOOK grammar option. This is a boolean
option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>nodeusesparser</td>
<td valign="top">nodeusesparser</td>

<td VALIGN=TOP>Sets the NODE_USES_PARSER grammar option. This is a boolean
<td valign="top">Sets the NODE_USES_PARSER grammar option. This is a boolean
option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>static</td>
<td valign="top">static</td>

<td VALIGN=TOP>Sets the STATIC grammar option. This is a boolean option.</td>
<td valign="top">Sets the STATIC grammar option. This is a boolean option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>visitor</td>
<td valign="top">visitor</td>

<td VALIGN=TOP>Sets the VISITOR grammar option. This is a boolean option.</td>
<td valign="top">Sets the VISITOR grammar option. This is a boolean option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>nodepackage</td>
<td valign="top">nodepackage</td>

<td VALIGN=TOP>Sets the NODE_PACKAGE grammar option. This is a string option.</td>
<td valign="top">Sets the NODE_PACKAGE grammar option. This is a string option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>visitorexception</td>
<td valign="top">visitorexception</td>

<td VALIGN=TOP>Sets the VISITOR_EXCEPTION grammar option. This is a string
<td valign="top">Sets the VISITOR_EXCEPTION grammar option. This is a string
option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
<td VALIGN=TOP>nodeprefix</td>
<td valign="top">nodeprefix</td>

<td VALIGN=TOP>Sets the NODE_PREFIX grammar option. This is a string option.</td>
<td valign="top">Sets the NODE_PREFIX grammar option. This is a string option.</td>

<td ALIGN=CENTER VALIGN=TOP>No</td>
<td align="center" valign="top">No</td>
</tr>

<tr>
@@ -196,16 +192,14 @@ option.</td>
</tr>
</table>

<h3>
Example</h3>
<h3>Example</h3>

<blockquote>
<pre>&lt;jjtree&nbsp;
&nbsp;&nbsp;&nbsp; target="src/Parser.jjt"&nbsp;
&nbsp;&nbsp;&nbsp; target="src/Parser.jjt"
&nbsp;&nbsp;&nbsp; outputdirectory="build/src"
&nbsp;&nbsp;&nbsp; javacchome="c:/program files/JavaCC"&nbsp;
&nbsp;&nbsp;&nbsp; nodeusesparser="true"
/&gt;</pre>
&nbsp;&nbsp;&nbsp; javacchome="c:/program files/JavaCC"
&nbsp;&nbsp;&nbsp; nodeusesparser="true"/&gt;</pre>
</blockquote>
This invokes JJTree on grammar file src/Parser.jjt, writing the generated
grammar file, Parser.jj, file to build/src. The grammar option NODE_USES_PARSER
@@ -214,7 +208,7 @@ is set to true when invoking JJTree.

<h3>Comparison output locations between command line JJTree and different Ant taskdef versions</h3>

<table cellpadding="3" border="1">
<table>
<tr>
<td><b>Command Line JJTree options</b>
<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i>and Generated Files</i> (working directory: <code>/tmp</code>)</td>
@@ -541,23 +535,17 @@ is set to true when invoking JJTree.
</tr>
</table>

<p>*) <u>Footnote</u>: When running JJTree with the Ant taskdef <i>jjtree</i> the option <code>-OUTPUT_DIRECTORY</code> must always
be set, because the project's basedir and the Ant working directory might differ. So even if you don't specify the jjtree taskdef
<i>outputdirectory</i> JJTree will be called with the <code>-OUTPUT_DIRECTORY</code> set to the project's basedirectory.
But when the <code>-OUTPUT_DIRECTORY</code> is set, the <code>-OUTPUT_FILE</code> setting is handled as if relative to this
<code>-OUTPUT_DIRECTORY</code>. Thus when the <code>-OUTPUT_FILE</code> is absolute or contains a drive letter we have a
problem.
<p>*) <u>Footnote</u>: When running JJTree with the Ant taskdef <i>jjtree</i> the option <code>-OUTPUT_DIRECTORY</code> must always
be set, because the project's basedir and the Ant working directory might differ. So even if you don't specify the jjtree taskdef
<i>outputdirectory</i> JJTree will be called with the <code>-OUTPUT_DIRECTORY</code> set to the project's basedirectory.
But when the <code>-OUTPUT_DIRECTORY</code> is set, the <code>-OUTPUT_FILE</code> setting is handled as if relative to this
<code>-OUTPUT_DIRECTORY</code>. Thus when the <code>-OUTPUT_FILE</code> is absolute or contains a drive letter we have a
problem.
Therefore absolute <i>outputfile</i>s (when the <i>outputdirectory</i> isn't specified) are made relative to the default directory.
And for this reason <i>outputfile</i>s that contain a drive letter can't be supported.</p>

<p>By the way: specifying a drive letter in the <code>-OUTPUT_FILE</code> when the <code>-OUTPUT_DIRECTORY</code> is set, also
<p>By the way: specifying a drive letter in the <code>-OUTPUT_FILE</code> when the <code>-OUTPUT_DIRECTORY</code> is set, also
results in strange behavior when running JJTree from the command line.</p>

<br>




</body>
</html>


+ 21
- 23
manual/Tasks/jlink.html View File

@@ -21,7 +21,7 @@
</head>
<body>

<h2><a name="jlink">Jlink</a></h2>
<h2 id="jlink">Jlink</h2>
<h3><i>Deprecated</i></h3>
<p><i>This task has been deprecated. Use a <a href="../Types/zipfileset.html">zipfileset</a>
or <a href="../Tasks/zip.html#zipgroupfileset">zipgroupfileset</a> with the
@@ -31,32 +31,32 @@
<h3><b>Description:</b></h3>
<p>Links entries from sub-builds and libraries.</p>

<p>The jlink task can be used to build jar and zip files, similar to
<p>The jlink task can be used to build jar and zip files, similar to
the <i>jar</i> task.
However, jlink provides options for controlling the way entries from
However, jlink provides options for controlling the way entries from
input files
are added to the output file. Specifically, capabilities for merging
are added to the output file. Specifically, capabilities for merging
entries from
multiple zip or jar files is available.</p>

<p>If a mergefile is specified directly (eg. at the top level of a
<p>If a mergefile is specified directly (eg. at the top level of a
<i>mergefiles</i>
pathelement) <i>and</i> the mergefile ends in &quot;.zip&quot; or
pathelement) <i>and</i> the mergefile ends in &quot;.zip&quot; or
&quot;.jar&quot;,
entries in the mergefile will be merged into the outfile. A file with
entries in the mergefile will be merged into the outfile. A file with
any other extension
will be added to the output file, even if it is specified in the
will be added to the output file, even if it is specified in the
mergefiles element.
Directories specified in either the mergefiles or addfiles element
Directories specified in either the mergefiles or addfiles element
are added to the
output file as you would expect: all files in subdirectories are
output file as you would expect: all files in subdirectories are
recursively added to
the output file with appropriate prefixes in the output file
the output file with appropriate prefixes in the output file
(without merging).
</p>

<p>
In the case where duplicate entries and/or files are found among the
In the case where duplicate entries and/or files are found among the
files to be merged or
added, jlink merges or adds the first entry and ignores all subsequent entries.
</p>
@@ -66,11 +66,11 @@ jlink ignores META-INF directories in mergefiles. Users should supply their
own manifest information for the output file.
</p>

<p>It is possible to refine the set of files that are being jlinked.
<p>It is possible to refine the set of files that are being jlinked.
This can be
done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>,
done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>,
<i>excludesfile</i>,
and <i>defaultexcludes</i> attributes on the <i>addfiles</i> and
and <i>defaultexcludes</i> attributes on the <i>addfiles</i> and
<i>mergefiles</i>
nested elements. With the <i>includes</i> or <i>includesfile</i>
attribute you specify the files you want to have included by using patterns.
@@ -85,7 +85,7 @@ relative to the <i>base</i> directory.</p>


<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -98,7 +98,7 @@ relative to the <i>base</i> directory.</p>
</tr>
<tr>
<td valign="top">compress</td>
<td valign="top">whether or not the output should be compressed.
<td valign="top">whether or not the output should be compressed.
<i>true</i>,
<i>yes</i>, or <i>on</i> result in compressed output.
If omitted, output will be uncompressed (inflated).</td>
@@ -107,7 +107,7 @@ relative to the <i>base</i> directory.</p>
<tr>
<td valign="top">mergefiles</td>
<td valign="top">files to be merged into the output, if possible.</td>
<td valign="middle" align="center" rowspan="2">At least one of
<td valign="middle" align="center" rowspan="2">At least one of
mergefiles or addfiles</td>
</tr>
<tr>
@@ -118,7 +118,7 @@ mergefiles or addfiles</td>

<h3>Examples</h3>

<p>The following will merge the entries in mergefoo.jar and mergebar.jar
<p>The following will merge the entries in mergefoo.jar and mergebar.jar
into out.jar.
mac.jar and pc.jar will be added as single entries to out.jar.</p>
<pre>
@@ -148,9 +148,9 @@ mac.jar and pc.jar will be added as single entries to out.jar.</p>
&lt;/jar&gt;
</pre>

<p>Suppose the file foo.jar contains two entries: bar.class and
<p>Suppose the file foo.jar contains two entries: bar.class and
barnone/myClass.zip.
Suppose the path for file foo.jar is build/tempbuild/foo.jar. The
Suppose the path for file foo.jar is build/tempbuild/foo.jar. The
following example
will provide the entry tempbuild/foo.jar in the out.jar.</p>
<pre>
@@ -171,7 +171,5 @@ namely bar.class and barnone/myClass.zip</p>
&lt;/jlink&gt;
</pre>


</body>

</html>

+ 2
- 2
manual/Tasks/jspc.html View File

@@ -80,7 +80,7 @@ and test your pages, all in one go.
<h3>Parameters</h3>
<p>The Task has the following attributes:</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -242,7 +242,7 @@ a reference to an existing classpath
Instructions to jasper to build an entire web application.
The base directory must have a WEB-INF subdirectory beneath it.
When used, the task hands off all dependency checking to the compiler.
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>


+ 34
- 35
manual/Tasks/junit.html View File

@@ -21,7 +21,7 @@
</head>
<body>

<h2><a name="junit">JUnit</a></h2>
<h2 id="junit">JUnit</h2>
<h3>Description</h3>

<p>This task runs tests from the JUnit testing framework. The latest
@@ -71,7 +71,7 @@ FAQ</a> for details.
elements</a>).</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -152,7 +152,7 @@ elements</a>).</p>
<tr>
<td valign="top">maxmemory</td>
<td valign="top">Maximum amount of memory to allocate to the forked VM.
Ignored if <code>fork</code> is disabled. <strong>Note</strong>:
Ignored if <code>fork</code> is disabled. <strong>Note</strong>:
If you get <code>java.lang.OutOfMemoryError: Java heap space</code>
in some of your tests then you need to raise the size like
<code>maxmemory="128m"</code></td>
@@ -234,7 +234,7 @@ elements</a>).</p>
formatter output to find the failing tests.
<em>since Ant 1.8.0</em></td>
<td align="center" valign="top">No</td>
</tr>
</tr>
<tr>
<td valign="top">enableTestListenerEvents</td>
<td valign="top">Whether Ant should send fine grained information
@@ -268,21 +268,21 @@ clean up, and still fail the build in the event of a failure.</p>
stack traces before reporting them.
It works with both the plain and XML formatters. It filters out any lines
that begin with the following string patterns:<pre>
"junit.framework.TestCase"
"junit.framework.TestResult"
"junit.framework.TestSuite"
"junit.framework.Assert."
"junit.swingui.TestRunner"
"junit.awtui.TestRunner"
"junit.textui.TestRunner"
"java.lang.reflect.Method.invoke("
"sun.reflect."
"org.apache.tools.ant."
"org.junit."
"junit.framework.JUnit4TestAdapter"
" more"</pre>
<h3><a name="nested">Nested Elements</a></h3>
&quot;junit.framework.TestCase&quot;
&quot;junit.framework.TestResult&quot;
&quot;junit.framework.TestSuite&quot;
&quot;junit.framework.Assert.&quot;
&quot;junit.swingui.TestRunner&quot;
&quot;junit.awtui.TestRunner&quot;
&quot;junit.textui.TestRunner&quot;
&quot;java.lang.reflect.Method.invoke(&quot;
&quot;sun.reflect.&quot;
&quot;org.apache.tools.ant.&quot;
&quot;org.junit.&quot;
&quot;junit.framework.JUnit4TestAdapter&quot;
&quot; more&quot;</pre>
<h3 id="nested">Nested Elements</h3>

<p>The <code>&lt;junit&gt;</code> task
supports a nested <code>&lt;classpath&gt;</code>
@@ -353,20 +353,20 @@ support it (i.e. Java 1.1).</p>
<p><em>since Ant 1.6</em>.</p>

<h4>permissions</h4>
<p>Security permissions can be revoked and granted during the execution of the
<p>Security permissions can be revoked and granted during the execution of the
class via a nested <i>permissions</i> element. For more information please
see <a href="../Types/permissions.html">permissions</a></p>

<p>Settings will be ignored if fork is enabled.</p>

<p><em>since Ant 1.6</em>.</p>
<h4>assertions</h4>

<p>You can control enablement of Java 1.4 assertions with an
<a href="../Types/assertions.html"><tt>&lt;assertions&gt;</tt></a>
subelement.</p>
<p>Assertion statements are currently ignored in non-forked mode.</p>

<p><em>since Ant 1.6.</em></p>
@@ -407,14 +407,14 @@ can be specified.</p>
that your tests have written as some characters are illegal in XML
documents and will be dropped.</p>

<p>The fourth formatter named <code>failure</code> (since Ant 1.8.0)
<p>The fourth formatter named <code>failure</code> (since Ant 1.8.0)
collects all failing <code>testXXX()</code>
methods and creates a new <code>TestCase</code> which delegates only these
failing methods. The name and the location can be specified via Java System property or Ant property
<code>ant.junit.failureCollector</code>. The value has to point to the directory and
<code>ant.junit.failureCollector</code>. The value has to point to the directory and
the name of the resulting class (without suffix). It defaults to <i>java-tmp-dir</i>/FailedTests.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -450,14 +450,14 @@ the name of the resulting class (without suffix). It defaults to <i>java-tmp-dir
<td valign="top">unless</td>
<td valign="top">Only use formatter <a href="../properties.html#if+unless">if the named property is <b>not</b> set</a>.</td>
<td align="center">No; default is <code>true</code>.</td>
</tr>
</tr>
</table>

<h4>test</h4>

<p>Defines a single test class.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -487,7 +487,7 @@ the name of the resulting class (without suffix). It defaults to <i>java-tmp-dir
is specified, then no test method from the suite will be executed.</p>
</td>
<td align="center">No; default is to run all test methods in the suite.</td>
</tr>
</tr>
<tr>
<td valign="top">fork</td>
<td valign="top">Run the tests in a separate VM.
@@ -581,7 +581,7 @@ generates a test class name for each resource that ends in
prior to Ant 1.7 only <code>&lt;fileset&gt;</code> has been
supported.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -697,8 +697,7 @@ supported.</p>

<p>to your <code>junit</code> task.</p>

<h3><a name="enabletestlistenerevents"><code>ant.junit.enabletestlistenerevents</code></a>
magic property</h3>
<h3 id="enabletestlistenerevents"><code>ant.junit.enabletestlistenerevents</code> magic property</h3>

<p><em>Since Ant 1.8.2</em> the <code>enableTestListenerEvents</code>
attribute of the task controls whether fine grained logging messages
@@ -760,7 +759,7 @@ stopped if the test fails.</p>
<p>Runs <code>my.test.TestCase</code> in the same VM, ignoring the
given CLASSPATH; only a warning is printed if this test fails. In
addition to the plain text test results, for this test a XML result
will be output to <code>result.xml</code>.
will be output to <code>result.xml</code>.
Then, for each matching file in the directory defined for
<code>${src.tests}</code> a
test is run in a separate VM. If a test fails, the build process is
@@ -776,7 +775,7 @@ aborted. Results are collected in files named
&lt;delete&gt;
&lt;fileset dir=&quot;${collector.dir}&quot; includes=&quot;${collector.class}*.class&quot;/&gt;
&lt;/delete&gt;
&lt;!-- compile the FailedTests class if present --&gt;
&lt;!-- compile the FailedTests class if present --&gt;
&lt;javac srcdir=&quot;${collector.dir}&quot; destdir=&quot;${collector.dir}&quot;/&gt;
&lt;available file=&quot;${collector.dir}/${collector.class}.class&quot; property=&quot;hasFailingTests&quot;/&gt;
&lt;junit haltonerror=&quot;false&quot; haltonfailure=&quot;false&quot;&gt;
@@ -802,8 +801,8 @@ aborted. Results are collected in files named
</pre>
<p>On the first run all tests are collected via the <code>&lt;batchtest/&gt;</code>
element. Its <code>plain</code> formatter shows the output on the console. The
<code>failure</code> formatter creates a java source file in
<code>${build.dir}/failingTests/FailedTests.java</code> which extends
<code>failure</code> formatter creates a java source file in
<code>${build.dir}/failingTests/FailedTests.java</code> which extends
<code>junit.framework.TestCase</code> and returns from a <code>suite()</code>
method a test suite for the failing tests. <br/>
On a second run the collector class exists and instead of the <code>&lt;batchtest/&gt;</code>


+ 11
- 12
manual/Tasks/junitreport.html View File

@@ -22,7 +22,7 @@

<body>

<h2><a name="junitreport">JUnitReport</a></h2>
<h2 id="junitreport">JUnitReport</h2>
<h3>Description</h3>
Merge the individual XML files generated by the JUnit task and eventually apply
a stylesheet on the resulting merged document to provide a browsable report of
@@ -39,10 +39,10 @@ href="http://xml.apache.org/xalan-j/">Xalan 2.4.1+ or Xalan XSLTC</a>
(JDK 1.4 contains a version of Xalan-J 2.x while JDK 1.5 ships with a
version of XSLTC). Starting from JDK 1.4.2-01 it ships with a bundled
Xalan-J 2.4.1+, meaning that JDK version prior to 1.4.2-01 won't work
out of the box. The table below summarize the compatibility status.
out of the box. The table below summarize the compatibility status.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr><th>Xalan</th><th>Sun JDK Bundle</th><th>Status<th></tr>
<table>
<tr><th>Xalan</th><th>Sun JDK Bundle</th><th>Status<th></tr>
<tr><td>2.4.1+</td><td>JDK 1.4.2-01+</td><td>OK</td></tr>
<tr><td>XSLTC</td><td>JDK 1.5.x</td><td>OK</td></tr>
<tr><td>2.x</td><td>JDK 1.4.x</td><td>DEPRECATED<br><i>Use ${ant.home}/etc/junit-frames-xalan1.xsl
@@ -52,11 +52,11 @@ out of the box. The table below summarize the compatibility status.
<p>With Ant 1.6.2 we had to decide between supporting Xalan-J 1/Xalan J 2.4.1-
and Xalan 2.4.1+/XSLTC, since there was no way to support both couples at the same
time.</p>
<p>With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not
<p>With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not
available anymore for quite some time.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -75,7 +75,7 @@ available anymore for quite some time.</p>
<td align="center" valign="top">No. Default to current directory</td>
</tr>
</table>
<h3><a name="nested">Nested Elements</a></h3>
<h3 id="nested">Nested Elements</h3>
<h4>fileset</h4>
<p><code>junitreport</code> collects individual xml files generated by the JUnit
task using the nested <a href="../Types/fileset.html"><code>&lt;FileSet&gt;</code></a>
@@ -83,7 +83,7 @@ element.</p>
<h4>report</h4>
<p>Generate a browsable report based on the document created by the merge.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -113,7 +113,7 @@ element.</p>
<td align="center" valign="top">No. Default to current directory</td>
</tr>
</table>
<p> Ant assumes the following concerning the <tt>frames</tt> and <tt>noframes</tt> formats :</p>
<p>Ant assumes the following concerning the <tt>frames</tt> and <tt>noframes</tt> formats:</p>
<p>The <tt>frames</tt> format uses
a stylesheet which is generating output <em>only</em> by redirecting.</p>
<p>The
@@ -126,7 +126,7 @@ file called <tt>junit-noframes.html</tt>.</p>
<em>Since Ant 1.7</em>the report tag supports nested param tags.
These tags can pass XSL parameters to the stylesheet.
<h3>Parameters</h3>
<table width="60%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -156,7 +156,7 @@ These tags can pass XSL parameters to the stylesheet.
</table>

<p>The built-in stylesheets support the following parameters:</p>
<table width="60%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>XSL-Parameter</b></td>
<td valign="top"><b>Description</b></td>
@@ -212,5 +212,4 @@ generate the default framed report in the directory <tt>report/html</tt>.</p>
The XSL parameters key1 and key2 will be passed to the XSL transformation.</p>

</body>

</html>

+ 3
- 5
manual/Tasks/length.html View File

@@ -29,9 +29,9 @@
<p>Display or set a property containing length information for
a string, a file, or one or more nested
<a href="../Types/resources.html#collection">Resource Collection</a>s.
Can also be used as a condition. <b>Since Apache Ant 1.6.3</b></p>
Can also be used as a condition. <em>Since Apache Ant 1.6.3</em></p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -111,7 +111,7 @@
&lt;fileset dir=&quot;.&quot; includes=&quot;foo,bar&quot;/&gt;
&lt;/length&gt;
</pre>
<p>Writes the file paths of <i>foo</i> and <i>bar</i> and their length into
<p>Writes the file paths of <i>foo</i> and <i>bar</i> and their length into
the property <i>length</i>.</p>

<pre>
@@ -121,7 +121,5 @@ the property <i>length</i>.</p>
</pre>
<p>Adds the length of <i>foo</i> and <i>bar</i> and stores the result in property <i>length</i>.</p>


</body>
</html>


+ 5
- 10
manual/Tasks/loadfile.html View File

@@ -23,7 +23,7 @@
<body>


<h2><a name="loadfile">LoadFile</a></h2>
<h2 id="loadfile">LoadFile</h2>
<h3>Description</h3>
<p>
Specialization of <a href="loadresource.html">loadresource</a> that
@@ -31,12 +31,12 @@ works on files exclusively and provides a srcFile attribute for
convenience. Unless an encoding is specified, the encoding of the
current locale is used.
</p>
<p>If the resource content is empty (maybe after processing a filterchain)
<p>If the resource content is empty (maybe after processing a filterchain)
the property is not set.</p>


<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -64,9 +64,9 @@ the property is not set.</p>
</tr>
<tr>
<td valign="top">quiet</td>
<td valign="top">Do not display a diagnostic message (unless Apache Ant has been
<td valign="top">Do not display a diagnostic message (unless Apache Ant has been
invoked with the <code>-verbose</code> or <code>-debug</code>
switches) or modify the exit status to reflect an error. Setting this to
switches) or modify the exit status to reflect an error. Setting this to
"true" implies setting failonerror to "false".
<em>Since Ant 1.7.0.</em>
</td>
@@ -88,7 +88,6 @@ can print this. This is identical to
&lt;file file="message.txt"/&gt;
&lt;/loadresource&gt;
</pre>
</p>

<pre> &lt;loadfile property="encoded-file"
srcFile="loadfile.xml"
@@ -125,9 +124,5 @@ merging lines to ensure this happens.
Load an XML file into a property, expanding all properties declared
in the file in the process.




</body>
</html>


+ 2
- 4
manual/Tasks/loadproperties.html View File

@@ -23,7 +23,7 @@
<body>


<h2><a name="loadproperties">LoadProperties</a></h2>
<h2 id="loadproperties">LoadProperties</h2>
<h3>Description</h3>
<p>
Load a file's contents as Apache Ant properties. This is equivalent
@@ -40,7 +40,7 @@ the <a href="property.html"><code>&lt;property&gt;</code></a>
task.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -134,7 +134,5 @@ Ant properties.
Load contents of http://example.org/url.properties.gz, uncompress it
on the fly and load the contents as Ant properties.



</body>
</html>

+ 4
- 6
manual/Tasks/loadresource.html View File

@@ -23,7 +23,7 @@
<body>


<h2><a name="loadresource">LoadResource</a></h2>
<h2 id="loadresource">LoadResource</h2>

<p><em>Since Apache Ant 1.7</em></p>

@@ -41,7 +41,7 @@ processing a filterchain) the property is not set.
of an existing property.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -64,9 +64,9 @@ processing a filterchain) the property is not set.
</tr>
<tr>
<td valign="top">quiet</td>
<td valign="top">Do not display a diagnostic message (unless Ant has been
<td valign="top">Do not display a diagnostic message (unless Ant has been
invoked with the <code>-verbose</code> or <code>-debug</code>
switches) or modify the exit status to reflect an error. Setting this to
switches) or modify the exit status to reflect an error. Setting this to
"true" implies setting failonerror to "false".
</td>
<td align="center" valign="top">No, default "false"</td>
@@ -87,7 +87,5 @@ Load the entry point of Ant's homepage into property "homepage"; an

<p>For more examples see the <a href="loadfile.html">loadfile</a> task.</p>


</body>
</html>


+ 1
- 2
manual/Tasks/local.html View File

@@ -40,7 +40,7 @@ in the buildfile. <b>Since Ant 1.8</b></p>
precedes its definition. See the examples section.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -183,4 +183,3 @@ step2:

</body>
</html>


+ 11
- 12
manual/Tasks/macrodef.html View File

@@ -17,14 +17,14 @@
<html>

<head>
<meta http-equiv="Content-Language" content="en-us"></meta>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>MacroDef Task</title>
</head>

<body>

<h2><a name="macrodef">MacroDef</a></h2>
<h2 id="macrodef">MacroDef</h2>
<h3>Description</h3>
<p>
This defines a new task using a <code>&lt;sequential&gt;</code>
@@ -42,7 +42,7 @@
<em>since Apache Ant 1.6</em>
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -88,7 +88,7 @@
</p>
<p>
This attribute is placed in the body of the templated
task using a notation similar to the ant property notation
task using a notation similar to the Ant property notation
- @{attribute name}. (May be remembered as "put the substitution
AT this location").
</p>
@@ -102,7 +102,7 @@
same as @{MyAttribute}.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -124,7 +124,7 @@
<td valign="top">description</td>
<td valign="top">
This contains a description of the attribute.
<em>since ant 1.6.1</em>
<em>Since Ant 1.6.1</em>
</td>
<td valign="top" align="center">No</td>
</tr>
@@ -133,7 +133,7 @@
<td valign="top">
Controls whether or not property references in the attribute are expanded twice or just once.
See the <a href="http://ant.apache.org/faq.html#macrodef-property-expansion">FAQ</a> for details.
<em>since Ant 1.8.3</em>
<em>Since Ant 1.8.3</em>
</td>
<td valign="top" align="center">No; default true</td>
</tr>
@@ -148,7 +148,7 @@
The case of the element name is ignored.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -175,7 +175,7 @@
any nested elements of the macrodef instance will be placed
in the element indicated by the name of this element.
There can only be one element if an element is implicit.
The default value is false. <em>since ant 1.6.2</em>
The default value is false. <em>Since Ant 1.6.2</em>
</td>
<td valign="top" align="center">No</td>
</tr>
@@ -184,7 +184,7 @@
<td valign="top">
This contains a description
informing the user what the contents of the element are expected to be.
<em>since ant 1.6.1</em>
<em>Since Ant 1.6.1</em>
</td>
<td valign="top" align="center">No</td>
</tr>
@@ -201,7 +201,7 @@
The case of the text name is ignored.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -380,6 +380,5 @@
</pre>
</blockquote>


</body>
</html>

+ 11
- 13
manual/Tasks/mail.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="mail">Mail</a></h2>
<h2 id="mail">Mail</h2>
<h3>Description</h3>
<p>
A task to send SMTP email.
@@ -49,13 +49,13 @@
</p>
<p>
<strong>Note:</strong> This task may depend on external libraries
that are not included in the Ant distribution.
that are not included in the Ant distribution.
See <a href="../install.html#librarydependencies">Library Dependencies</a>
for more information.
</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -149,18 +149,18 @@
<tr>
<td valign="top">user</td>
<td valign="top">user name for SMTP auth</td>
<td valign="center">Yes, if SMTP auth is required on your SMTP server<br></br>
<td valign="center">Yes, if SMTP auth is required on your SMTP server<br>
the email message will be then sent using Mime and requires JavaMail</td>
</tr>
<tr>
<td valign="top">password</td>
<td valign="top">password for SMTP auth</td>
<td valign="center">Yes, if SMTP auth is required on your SMTP server<br></br>
<td valign="center">Yes, if SMTP auth is required on your SMTP server<br>
the email message will be then sent using Mime and requires JavaMail</td>
</tr>
<tr>
<td valign="top">ssl</td>
<td valign="top">"true", "on" or "yes" accepted here<br></br>
<td valign="top">"true", "on" or "yes" accepted here<br>
indicates whether you need TLS/SSL</td>
<td align="center" valign="top">No</td>
</tr>
@@ -193,7 +193,7 @@
</tr>
<tr>
<td valign="top">enableStartTLS</td>
<td valign="top">"true", "on" or "yes" accepted here<br></br>
<td valign="top">"true", "on" or "yes" accepted here<br>
whether the STARTTLS command used to switch to an encrypted
connection for authentication should be supported. Requires
JavaMail. <em>Since Ant 1.8.0</em></td>
@@ -216,10 +216,10 @@ can contain email addresses of the form :

<h3>Parameters specified as nested elements</h3>

<h4>to / cc / bcc / from/ replyto </h4>
<h4>to / cc / bcc / from/ replyto</h4>
<p>Adds an email address element. It takes the following attributes:</p>

<table width="60%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -242,7 +242,7 @@ can contain email addresses of the form :
<p>Specifies the message to include in the email body. It takes the following
attributes:</p>

<table width="60%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -287,7 +287,7 @@ the <code>&lt;message&gt;</code> element.</p>
<p><strong>Since Ant 1.7</strong>, arbitrary mail headers can be added by
specifying these attributes on one or more nested header elements:</p>

<table width="60%" border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -356,7 +356,5 @@ will be replaced with the <code>buildname</code> property's value.</p>
<p>Sends an eMail from <i>me@myisp.com</i> to <i>all@xyz.com</i> with a subject of
<i>Test Build</i>, the message body being coded in UTF-8



</body>
</html>

+ 9
- 13
manual/Tasks/manifest.html View File

@@ -24,16 +24,14 @@

<body>

<h2><a name="manifest">Manifest</a></h2>
<h2 id="manifest">Manifest</h2>
<h3>Description</h3>
<p>Creates a manifest file.</p>

<p>This task can be used to write a Manifest file, optionally
replacing or updating an existing file.</p>



<p>Manifests are processed according to the
<p>Manifests are processed according to the
<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html">Jar
file specification.</a>. Specifically, a manifest element consists of
a set of attributes and sections. These sections in turn may contain
@@ -52,14 +50,14 @@ line.</p>

<p>
If you find that Ant generates manifests incompatible with your runtime, take
a manifest it has built, fix it up however you need and switch to using the &lt;zip&gt
a manifest it has built, fix it up however you need and switch to using the <a href="zip.html">zip</a>
task to create the JAR, feeding in the hand-crafted manifest.
</p>



<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -104,10 +102,10 @@ line.</p>
</table>

<h3>Nested elements</h3>
<h4><a name="attribute">attribute</a></h4>
<h4 id="attribute">attribute</h4>
<p>One attribute for the manifest file. Those attributes that are
not nested into a section will be added to the "Main" section.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -132,7 +130,7 @@ not nested into a section will be added to the "Main" section.</p>
<p>A manifest section - you can nest <a
href="#attribute">attribute</a> elements into sections.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -156,7 +154,7 @@ href="#attribute">attribute</a> elements into sections.</p>
&lt;attribute name=&quot;Specification-Version&quot; value=&quot;${version}&quot;/&gt;
&lt;attribute name=&quot;Specification-Vendor&quot; value=&quot;Example Organization&quot;/&gt;
&lt;attribute name=&quot;Implementation-Title&quot; value=&quot;common&quot;/&gt;
&lt;attribute name=&quot;Implementation-Version&quot; value=&quot;${version} ${TODAY}&quot;/&gt;
&lt;attribute name=&quot;Implementation-Version&quot; value=&quot;${version} ${TODAY}&quot;/&gt;
&lt;attribute name=&quot;Implementation-Vendor&quot; value=&quot;Example Corp.&quot;/&gt;
&lt;/section&gt;
&lt;section name=&quot;common/class1.class&quot;&gt;
@@ -168,7 +166,7 @@ href="#attribute">attribute</a> elements into sections.</p>
<p>Creates or replaces the file MANIFEST.MF. Note that the Built-By
attribute will take the value of the Ant property ${user.name}. The
same is true for the ${version} and ${TODAY} properties. This example
produces a MANIFEST.MF that contains
produces a MANIFEST.MF that contains
<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/versioning/spec/versioning2.html#wp90779">package
version identification</a> for the package <code>common</code>.</p>

@@ -191,7 +189,5 @@ Sealed: false

</code></pre>


</body>
</html>


+ 4
- 6
manual/Tasks/manifestclasspath.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="manifestclasspath">Manifestclasspath</a></h2>
<h2 id="manifestclasspath">Manifestclasspath</h2>

<h3>Description</h3>
<p>Converts a <a href="../using.html#path">Path</a> into a property
@@ -54,7 +54,7 @@ defined property is re-referenced.</p>
<p><em>since Apache Ant 1.7</em></p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -105,13 +105,11 @@ This classpath must not be empty, and is required.</p>
</pre></blockquote>
<p>Assuming a path of id "classpath" was already defined, convert this
path relatively to the build/ directory that will contain acme.jar, which
can later be created with <code>&lt;jar&gt;</code> with a nested
can later be created with <code>&lt;jar&gt;</code> with a nested
<code>&lt;manifest&gt;</code> element that lists an
<code>&lt;attribute name="Class-Path" value="${jar.classpath}" /&gt;</code>.
<code>&lt;attribute name="Class-Path" value="${jar.classpath}"/&gt;</code>.
</p>
</div>



</body>
</html>

+ 2
- 4
manual/Tasks/mimemail.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="mimemail">MimeMail</a></h2>
<h2 id="mimemail">MimeMail</h2>

<h3><i>Deprecated</i></h3>
<p><i>This task has been deprecated. Use the <a href="../Tasks/mail.html">mail</a> task instead.</i></p>
@@ -36,7 +36,7 @@ and <a href="http://www.oracle.com/technetwork/java/javase/jaf-135115.html">Java
Activation Framework</a> are required for this task.</p>
<p>Multiple files can be attached using <a href="../Types/fileset.html">FileSets.</a></p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -109,7 +109,5 @@ Activation Framework</a> are required for this task.</p>
&lt;/mimemail&gt;
</pre>


</body>
</html>


+ 2
- 3
manual/Tasks/mkdir.html View File

@@ -24,12 +24,12 @@

<body>

<h2><a name="mkdir">Mkdir</a></h2>
<h2 id="mkdir">Mkdir</h2>
<h3>Description</h3>
<p>Creates a directory. Also non-existent parent directories are created, when
necessary. Does nothing if the directory already exist.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -47,6 +47,5 @@ necessary. Does nothing if the directory already exist.</p>
<pre>&lt;mkdir dir=&quot;${dist}/lib&quot;/&gt;</pre>
<p>creates a directory <code>${dist}/lib</code>.</p>


</body>
</html>

+ 2
- 4
manual/Tasks/move.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="move">Move</a></h2>
<h2 id="move">Move</h2>
<h3>Description</h3>
<p>Moves a file to a new file or directory, or collections of files to
a new directory. By default, the
@@ -47,7 +47,7 @@ set.</p>
there is a directory by the same name in <i>todir</i>, the action will fail.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -252,7 +252,5 @@ in a directory.</b></p>
&lt;/move&gt;
</pre>


</body>
</html>


+ 13
- 9
manual/Tasks/native2ascii.html View File

@@ -15,8 +15,10 @@
limitations under the License.
-->
<html>
<head><link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Native2Ascii Task</title></head>
<head>
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Native2Ascii Task</title>
</head>
<body>
<h2>Native2Ascii</h2>

@@ -57,20 +59,22 @@
and <code>&lt;patternset&gt;</code> elements.
</p>

<p>It is possible to use different converters. This can be selected
with the <code>implementation</code> attribute or a nested element.
<a name="implementationvalues">Here are the choices of the attribute</a>:</p>
<p id="implementationvalues">
It is possible to use different converters. This can be selected
with the <code>implementation</code> attribute or a nested
element. Here are the choices of the attribute:
</p>
<ul>
<li>default - the default converter for the platform - kaffee
when run on Kaffee, builtin otherwise.</li>
<li>sun (used to be the standard converter of the JDK < 9)</li>
<li>kaffe (the standard converter
of <a href="http://www.kaffe.org" target="_top">Kaffe</a>)</li>
<li>builtin - Ant's internal implementation. <em>since ant
<li>builtin - Ant's internal implementation. <em>Since Ant
1.9.8</em></li>
</ul>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td><b>Attribute</b></td>
<td><b>Description</b></td>
@@ -156,7 +160,7 @@ specified like <a href="../using.html#arg">Command-line Arguments</a>
but have an additional attribute that can be used to enable arguments
only if a given converter implementation will be used.</p>

<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -245,6 +249,6 @@ only if a given converter implementation will be used.</p>
</pre>
<p>in which case your native2ascii adapter can support attributes and
nested elements of its own.</p>
</body>

</body>
</html>

+ 2
- 4
manual/Tasks/netrexxc.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="netrexxc">NetRexxC</a></h2>
<h2 id="netrexxc">NetRexxC</h2>
<h3>Description</h3>
<p>Compiles a <a href="http://www2.hursley.ibm.com/netrexx" target="_top">NetRexx</a>
source tree within the running (Apache Ant) VM.</p>
@@ -63,7 +63,7 @@ included in the Apache Ant distribution. See <a href="../install.html#librarydep
for more information.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -335,7 +335,5 @@ for more information.</p>
</p>
</blockquote>


</body>
</html>


+ 2
- 4
manual/Tasks/nice.html View File

@@ -24,12 +24,12 @@

<body>

<h2><a name="echo">Nice</a></h2>
<h2 id="echo">Nice</h2>
<h3>Description</h3>
<p>Provide "nice-ness" to the current thread
and/or query the current value.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -64,7 +64,5 @@ priority in the user property "currentpriority". This
can be used to set the priority back to its original value later.
</p>


</body>
</html>


+ 2
- 3
manual/Tasks/pack.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="pack">GZip/BZip2</a></h2>
<h2 id="pack">GZip/BZip2/XZ</h2>
<h3>Description</h3>
<p>Packs a resource using the GZip, BZip2 or XZ algorithm.
The output file is only generated if it doesn't exist or the source
@@ -36,7 +36,7 @@ See <a href="../install.html#librarydependencies">Library
Dependencies</a> for more information.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -80,6 +80,5 @@ resource collection</h4>
<p>downloads <i>http://example.org/archive.tar</i> and compresses it
to <i>archive.tar.gz</i> in the project's basedir on the fly.</p>


</body>
</html>

+ 15
- 17
manual/Tasks/parallel.html View File

@@ -28,12 +28,12 @@
<h3>Description</h3>
<p>
Executes nested tasks in parallel with no guarantees of thread safety.
Every task will run in its own thread, with the likelihood of
Every task will run in its own thread, with the likelihood of
concurrency problems scaling with the number of CPUs on the host system.
</p>
<p><b>Warning:</b> While the Apache Ant core is believed to be thread safe, no such
<p><b>Warning:</b> While the Apache Ant core is believed to be thread safe, no such
guarantees are made about tasks, which are not tested for thread safety during
Ant's test process.
Ant's test process.
Third party tasks may or may not be thread safe, and some of Ant's core tasks, such as
<code>&lt;javac&gt;</code> are definitely not re-entrant. This is because they use libraries that
were never designed to be used in a multithreaded environment.
@@ -44,16 +44,16 @@
same time. Anyone trying to run large Ant task sequences in parallel, such
as javadoc and javac at the same time, is implicitly taking on the task
of identifying and fixing all concurrency bugs the tasks that they run.
</p>
<p>
Accordingly, while this task has uses, it should be considered an advanced
task which should be used in certain batch-processing or testing situations,
rather than an easy trick to speed up build times on a multiway CPU.
rather than an easy trick to speed up build times on a multiway CPU.
</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -130,13 +130,13 @@ processors (there is no affinity to a particular processor however). This will
override the value in <code>threadCount</code>. If <code>threadsPerProcessor</code>
is specified on any older JVM, then the value in <code>threadCount</code> will be used as is.</p>

<p>When using <code>threadCount</code> and <code>threadsPerProcessor</code>
care should be taken to ensure that the build does not deadlock.
<p>When using <code>threadCount</code> and <code>threadsPerProcessor</code>
care should be taken to ensure that the build does not deadlock.
This can be caused by tasks such as <code>waitfor</code>
taking up all available threads before the tasks that would unlock the
taking up all available threads before the tasks that would unlock the
<code>waitfor</code>
would occur. This is not a replacement for Java Language level thread
semantics and is best used for "embarassingly parallel" tasks.</p>
semantics and is best used for "embarrassingly parallel" tasks.</p>


<h3>Parameters specified as nested elements</h3>
@@ -169,7 +169,7 @@ terminated from Ant. By using <code>&lt;daemons&gt;</code> such servers do not h
&lt;/parallel&gt;
</pre>
<p>This example represents a typical pattern for testing a server application.
In one thread the server is started (the <code>&lt;wlrun&gt;</code> task).
In one thread the server is started (the <code>&lt;wlrun&gt;</code> task).
The other thread consists
of a three tasks which are performed in sequence. The <code>&lt;sleep&gt;</code> task is used to
give the server time to come up. Another task which is capable of validating
@@ -191,8 +191,8 @@ resource utilization during the build. In this instance, some servlets are being
compiled in one thead and a set of JSPs is being precompiled in another. Developers
need to be careful that the two tasks are independent, both in
terms of their dependencies and in terms of their potential interactions in
Ant's external environment. Here we set <code>fork="true"</code> for the
<code>&lt;javac&gt;</code> task, so that it runs in a new process;
Ant's external environment. Here we set <code>fork="true"</code> for the
<code>&lt;javac&gt;</code> task, so that it runs in a new process;
if the <code>&lt;wljspc&gt;</code> task used the javac compiler in-VM
(it may), concurrency problems may arise.
</p>
@@ -206,7 +206,7 @@ if the <code>&lt;wljspc&gt;</code> task used the javac compiler in-VM
&lt;/java&gt;
&lt;/sequential&gt;
&lt;/macrodef&gt;
&lt;parallel threadCount="4"&gt;
&lt;dbpurge file="db/one" /&gt;
&lt;dbpurge file="db/two" /&gt;
@@ -223,13 +223,11 @@ if the <code>&lt;wljspc&gt;</code> task used the javac compiler in-VM
<p>This example represents a typical need for use of the threadCount and
threadsPerProcessor attributes. Spinning up all 40 of those tasks could cripple
the system for memory and CPU time. By limiting the number of
concurrent executions you can reduce contention for CPU, memory and disk IO,
concurrent executions you can reduce contention for CPU, memory and disk IO,
and so actually finish faster. This is also a good
candidate for use of threadCount (and possibly threadsPerProcessor) because
each task is independent (every new JVM is forked) and has no dependencies on
the other tasks.</p>


</body>
</html>


+ 16
- 19
manual/Tasks/patch.html View File

@@ -24,63 +24,62 @@

<body>

<h2><a name="patch">Patch</a></h2>
<h2 id="patch">Patch</h2>
<h3>Description</h3>
<p>Applies a diff file to originals. ; requires "patch" to be
on the execution path. </p>
<p>Applies a diff file to originals. Requires "patch" to be on the execution path.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">patchfile</td>
<td valign="top">patchfile</td>
<td valign="top">the file that includes the diff output</td>
<td align="center" valign="top">Yes</td>
</tr>
<tr>
<td valign="top">originalfile</td>
<td valign="top">originalfile</td>
<td valign="top">the file to patch</td>
<td align="center" valign="top">No, tries to guess it from the diff
<td align="center" valign="top">No, tries to guess it from the diff
file</td>
</tr>
<tr>
<td valign="top">destfile</td>
<td valign="top">destfile</td>
<td valign="top">the file to send the output to instead of
patching the file(s) in place. <em>since Apache Ant 1.6</em></td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top">backups</td>
<td valign="top">backups</td>
<td valign="top">Keep backups of the unpatched files</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">quiet</td>
<td valign="top">quiet</td>
<td valign="top">Work silently unless an error occurs</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">reverse</td>
<td valign="top">Assume patch was created with old and new files
<td valign="top">reverse</td>
<td valign="top">Assume patch was created with old and new files
swapped.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">ignorewhitespace</td>
<td valign="top">ignorewhitespace</td>
<td valign="top">Ignore whitespace differences.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">strip</td>
<td valign="top">Strip the smallest prefix containing <i>num</i> leading
<td valign="top">strip</td>
<td valign="top">Strip the smallest prefix containing <i>num</i> leading
slashes from filenames.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">dir</td>
<td valign="top">dir</td>
<td valign="top">The directory in which to run the patch command.</td>
<td align="center" valign="top">No, default is the project's basedir.</td>
</tr>
@@ -102,10 +101,8 @@ the diff output looked like</p>
<pre>
--- a/mod1.0/A Mon Jun 5 17:28:41 2000
+++ a/mod1.1/A Mon Jun 5 17:28:49 2000
</pre>
</pre>
the leading <i>a/</i> will be stripped.


</body>
</html>


+ 15
- 17
manual/Tasks/pathconvert.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="pathconvert">Pathconvert</a></h2>
<h2 id="pathconvert">Pathconvert</h2>
<h3>Description</h3>
<p>Converts nested <a href="../Types/resources.html#collection">
ResourceCollection</a>s, or a reference to just one, into a path
@@ -38,11 +38,11 @@ of files in a FileList into a path.
drive letters to Unix paths, and vice-versa.</p>
<p>More complex transformations can be achieved using a nested
<a href="../Types/mapper.html"><code>&lt;mapper&gt;</code></a>
(since Apache Ant 1.6.2).
(<em>since Apache Ant 1.6.2</em>).
</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -51,7 +51,7 @@ drive letters to Unix paths, and vice-versa.</p>
<tr>
<td valign="top">targetos</td>
<td valign="top">
The target architecture. Must be one of 'unix', 'windows',
The target architecture. Must be one of 'unix', 'windows',
'netware', 'tandem' or 'os/2'.
This is a shorthand mechanism for specifying both
<code>pathsep</code> and <code>dirsep</code>
@@ -98,14 +98,14 @@ drive letters to Unix paths, and vice-versa.</p>
</tr>
<tr>
<td valign="top">preserveduplicates</td>
<td valign="top">Whether to preserve duplicate resources. <b>Since Ant 1.8</b></td>
<td valign="top">Whether to preserve duplicate resources. <em>Since Ant 1.8</em></td>
<td valign="top" align="center">No; default &quot;false&quot;.
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>map</h4>
<p>Specifies the mapping of path prefixes between Unix and Windows.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -115,7 +115,7 @@ drive letters to Unix paths, and vice-versa.</p>
<td valign="top">from</td>
<td valign="top">
The prefix to match. Note that this value is case-insensitive when
the build is running on a Windows platform and case-sensitive
the build is running on a Windows platform and case-sensitive
when running on a Unix platform.
<em>Since Ant 1.7.0</em>, on Windows this value is also insensitive
to the slash style used for directories, one can use '/' or '\'.
@@ -136,8 +136,8 @@ drive letters to Unix paths, and vice-versa.</p>
<p><strong>Note</strong>: The map elements are applied in the order specified,
and only the first matching map element is applied. So, the ordering of
your map elements can be important, if any <code>from</code> values are
prefixes of other <code>from</code> values.</i>
</p>
prefixes of other <code>from</code> values.
</p>
<h4>Resource Collections</h4>
<p>If the <code>refid</code> attribute is not specified, then one or more
nested <a href="../Types/resources.html#collection">Resource
@@ -145,7 +145,7 @@ Collection</a>s must be supplied.</p>
<h4>mapper</h4>
<p>A single nested <a href="../Types/mapper.html">
<code>&lt;mapper&gt;</code></a> element can be specified
to perform any of various filename transformations (since Ant 1.6.2).
to perform any of various filename transformations (<em>since Ant 1.6.2</em>).
</p>

<h3>Examples</h3>
@@ -161,15 +161,15 @@ has the value
&lt;pathelement location=&quot;${wl.home}/mssqlserver4/classes&quot;/&gt;
&lt;pathelement location=&quot;c:\winnt\System32&quot;/&gt;
&lt;/path&gt;
&lt;pathconvert targetos=&quot;unix&quot; property=&quot;wl.path.unix&quot; refid=&quot;wl.path&quot;&gt;
&lt;map from=&quot;${wl.home}&quot; to=&quot;${wl.home.unix}&quot;/&gt;
&lt;map from=&quot;c:&quot; to=&quot;&quot;/&gt;
&lt;/pathconvert&gt;
</pre>
<p> will generate the path shown below
and store it in the property named <code>wl.path.unix</code>.
</p>
<p>
will generate the path shown below and store it in the property named <code>wl.path.unix</code>.
</p>
<pre>
/weblogic/lib/weblogicaux.jar:/weblogic/classes:/weblogic/mssqlserver4/classes:/WINNT/SYSTEM32
</pre>
@@ -197,7 +197,7 @@ will convert the list of files to the following Unix path:
&lt;fileset dir=&quot;${src.dir}&quot; id=&quot;src.files&quot;&gt;
&lt;include name=&quot;**/*.java&quot;/&gt;
&lt;/fileset&gt;
&lt;pathconvert pathsep=&quot;,&quot; property=&quot;javafiles&quot; refid=&quot;src.files&quot;/&gt;
</pre>
<p>This example takes the set of files determined by the fileset (all files ending
@@ -220,5 +220,3 @@ list of files.
</p>
</body>
</html>


+ 9
- 16
manual/Tasks/presetdef.html View File

@@ -15,21 +15,16 @@
limitations under the License.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us"></meta>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>PreSetDef Task</title>
<style type="text/css">
<!--
.code { background: #EFEFEF; margin-top: }
-->
</style>
<title>PreSetDef Task</title>
</head>

<body>
<h2><a name="presetdef">PreSetDef</a></h2>

<h2 id="presetdef">PreSetDef</h2>
<h3>Description</h3>
<p>
The preset definition generates a new definition
@@ -45,7 +40,7 @@
when the preset definition is defined.
</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -70,7 +65,7 @@
This nested element can be any other type or task. The attributes
and elements that need to be preset are placed here.
</p>
<h3>Examples</h3>
The following fragment defines a javac task with the debug, deprecation
srcdir and destdir
@@ -177,8 +172,6 @@ properties to be available in child builds run with
&lt;/macrodef&gt;
&lt;showmessage-presetdef messageval="${message}"/&gt;
</pre></blockquote>
<hr></hr>

</body>
</html>


+ 1
- 2
manual/Tasks/projecthelper.html View File

@@ -35,7 +35,7 @@ the default one (ProjectHelper2)
<p>See the description of Apache Ant's
<a href="../projecthelper.html">Project Helper</a> for more information.
</p>
<p><b>Since Ant 1.8.2</b></p>
<p><em>Since Ant 1.8.2</em></p>

<h3>Parameters specified as nested elements</h3>

@@ -56,4 +56,3 @@ You may specify many configured <code>org.apache.tools.ant.ProjectHelper</code>

</body>
</html>


+ 25
- 27
manual/Tasks/property.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="property">Property</a></h2>
<h2 id="property">Property</h2>
<h3>Description</h3>
<p>Sets a <a href="../using.html#properties">property</a>
(by name and value), or set of properties (from file or
@@ -60,11 +60,11 @@ This also holds for properties loaded from a property file.</p>
href="../properties.html#built-in-props">here</a>.</p>
<p>Since Apache Ant 1.8.0 it is possible to load properties defined in xml
according to <a href="http://java.sun.com/dtd/properties.dtd">Suns DTD</a>,
if Java5+ is present. For this the name of the file, resource or url has
if Java 5+ is present. For this the name of the file, resource or url has
to end with <tt>.xml</tt>.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -177,7 +177,7 @@ SYSTEM).
</p>

<h4>Any OS except OpenVMS</h4>
<p>Starting with Ant 1.8.2 if Ant detects it is running of a Java 1.5
<p>Starting with Ant 1.8.2 if Ant detects it is running of a Java 5
VM (or better) Ant will use <code>System.getenv</code> rather than
its own OS dependent native implementation. For some OSes this
causes minor differences when compared to older versions of Ant.
@@ -288,58 +288,56 @@ deploy.port=8080
deploy.url=http://${deploy.server}:${deploy.port}/
</pre>


<a name="notes-env"></a>
<h3>Notes about environment variables</h3>
<h3 id="notes-env">Notes about environment variables</h3>
<p>
Ant runs on Java 1.2 therefore it cannot use Java5 features for accessing environment
Ant runs on Java 1.2 therefore it cannot use Java 5 features for accessing environment
variables. So it starts a command in a new process which prints the environment variables,
analyzes the output and creates the properties. <br>
analyzes the output and creates the properties.<br>
There are commands for the following operating systems implemented in
<a href="https://git-wip-us.apache.org/repos/asf?p=ant.git;a=blob;f=src/main/org/apache/tools/ant/taskdefs/Execute.java;hb=24e5a0e881dba01a6f012c4a271b743946412a0d">
Execute.java</a> (method <tt>getProcEnvCommand()</tt>):
</p>
<table>
<tr>
<th>OS</th>
<th>command</th>
</tr>
<tr>
<td> os/2 </td>
<td> cmd /c set </td>
<td>os/2</td>
<td>cmd /c set</td>
</tr>
<tr>
<td colspan="2"> windows </td>
<td colspan="2"> windows</td>
</tr>
<tr>
<td> * win9x </td>
<td> command.com /c set </td>
<td>* win9x</td>
<td>command.com /c set</td>
</tr>
<tr>
<td> * other </td>
<td> cmd /c set </td>
<td>* other</td>
<td>cmd /c set</td>
</tr>
<tr>
<td> z/os </td>
<td> /bin/env <b>OR</b> /usr/bin/env <b>OR</b> env <i>(depending on read rights)</i> </td>
<td>z/os</td>
<td>/bin/env <b>OR</b> /usr/bin/env <b>OR</b> env <i>(depending on read rights)</i></td>
</tr>
<tr>
<td> unix </td>
<td> /bin/env <b>OR</b> /usr/bin/env <b>OR</b> env <i>(depending on read rights)</i> </td>
<td>unix</td>
<td>/bin/env <b>OR</b> /usr/bin/env <b>OR</b> env <i>(depending on read rights)</i></td>
</tr>
<tr>
<td> netware </td>
<td> env </td>
<td>netware</td>
<td>env</td>
</tr>
<tr>
<td> os/400 </td>
<td> env </td>
<td>os/400</td>
<td>env</td>
</tr>
<tr>
<td> openvms </td>
<td> show logical </td>
<td>openvms</td>
<td>show logical</td>
</tr>
</table>
</p>

</body>
</html>

+ 9
- 13
manual/Tasks/propertyfile.html View File

@@ -24,9 +24,8 @@
<body>

<h1>PropertyFile</h1>

<hr>
<h2><a name="introduction">Introduction</a></h2>
<hr/>
<h2 id="introduction">Introduction</h2>
<p>Apache Ant provides an optional task for editing property files. This is
very useful when wanting to make unattended modifications to
configuration files for application servers and
@@ -40,10 +39,10 @@ file are preserved.</p>
In general, linefeeds of the updated file will be the same as the
first linefeed found when reading it.</p>

<hr>
<h2><a name="proptask">PropertyFile Task</a></h2>
<hr/>
<h2 id="proptask">PropertyFile Task</h2>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
@@ -73,10 +72,10 @@ previous behaviour of the task, in which the layout and any comments
in the properties file were lost by the task.</p>

<h3>Parameters specified as nested elements</h3>
<h4><a name="entryElement">Entry</a></h4>
<h4 id="entryElement">Entry</h4>
<p>Use nested <code>&lt;entry&gt;</code>
elements to specify actual modifications to the property file itself.</p>
<table border="1" cellpadding="2" cellspacing="0">
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
@@ -156,7 +155,6 @@ operation occurs <b>after</b> these rules are considered.</p>
<li>If value and default are both specified and the property did not exist in
the property file, the property is set to default.</li>
</ul>
<p>&nbsp;</p>

<h3>Examples</h3>

@@ -186,7 +184,7 @@ formated.int=0014

formated.date=243 13\:47</pre>
<p>
The slashes conform to the expectations of the Properties class. The file will be stored in a manner so that each character is examined and escaped if necessary.
The slashes conform to the expectations of the Properties class. The file will be stored in a manner so that each character is examined and escaped if necessary.
</p>

<p>
@@ -228,7 +226,7 @@ Concatenation of strings :</p>
<p>Each time called, a &quot;.&quot; will be appended to &quot;progress&quot;
</p>

<p>Pumps the project version to the next minor version (increase minor and set path=0):
<p>Pumps the project version to the next minor version (increase minor and set path=0):</p>
<blockquote><pre>&lt;target name="nextMinorVersion"&gt;
&lt;property
name="header"
@@ -242,8 +240,6 @@ Concatenation of strings :</p>
&lt;/target&gt;
</pre></blockquote>
After running this target the version changed e.g. from 3.2.2 to 3.3.0.
</p>


</body>
</html>

Some files were not shown because too many files changed in this diff

Loading…
Cancel
Save