You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2018/02/28 07:01:42 UTC
[27/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/renameextensions.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/renameextensions.html b/manual/Tasks/renameextensions.html
index 664edfd..d8f2381 100644
--- a/manual/Tasks/renameextensions.html
+++ b/manual/Tasks/renameextensions.html
@@ -25,94 +25,81 @@
<body>
<h2 id="renameexts">RenameExtensions</h2>
-<h3><i>Deprecated</i></h3>
-<p><i>This task has been deprecated. Use the <a href="../Tasks/move.html">move</a>
-task with a <a href="../Types/mapper.html#glob-mapper">glob mapper</a> instead.</i></p>
+<h3><em><u>Deprecated</u></em></h3>
+<p><em>This task has been <u>deprecated</u>. Use the <a href="../Tasks/move.html">move</a> task
+with a <a href="../Types/mapper.html#glob-mapper">glob mapper</a> instead.</em></p>
<h3>Description</h3>
-<p>Renames files in the <code>srcDir</code> directory ending with the
-<code>fromExtension</code> string so that they end with the
-<code>toExtension</code> string. Files are only replaced if
-<code>replace</code> is true
-</p>
-<p>See the section on
-<a href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns.
-This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and
-supports most attributes of <code><fileset></code>
-(<code>dir</code> becomes <code>srcDir</code>) as well as the nested
-<code><include></code>, <code><exclude></code> and
-<code><patternset></code> elements.</p>
+<p>Renames files in the <var>srcDir</var> directory ending with the <var>fromExtension</var> string
+so that they end with the <var>toExtension</var> string. Files are only replaced
+if <var>replace</var> is <q>true</q>.</p>
+<p>See the section on <a href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on
+how the inclusion/exclusion of files works, and how to write patterns. This task forms an
+implicit <a href="../Types/fileset.html">FileSet</a> and supports most attributes
+of <code><fileset></code> (<var>dir</var> becomes <var>srcDir</var>) as well as the
+nested <code><include></code>, <code><exclude></code>
+and <code><patternset></code> elements.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top">indicates whether default excludes should be used or not
- ("yes"/"no"). Default excludes are used when
- omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
+ <td>No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">excludes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- excluded. No files (except default excludes) are excluded when
- omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>excludes</td>
+ <td>comma- or space-separated list of patterns of files that must be excluded.</td>
+ <td>No; defaults to default excludes or none if <var>defaultexcludes</var> is <q>no</q></td>
</tr>
<tr>
- <td valign="top">excludesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an exclude pattern</td>
- <td valign="top" align="center">No</td>
+ <td>excludesfile</td>
+ <td>name of a file. Each line of this file is taken to be an exclude pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">fromExtension</td>
- <td valign="top">The string that files must end in to be renamed</td>
- <td valign="top" align="center">Yes</td>
+ <td>fromExtension</td>
+ <td>The string that files must end in to be renamed</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">includes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- included. All files are included when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>includes</td>
+ <td>comma- or space-separated list of patterns of files that must be included.</td>
+ <td>No; defaults to all (<q>**</q>)</td>
</tr>
<tr>
- <td valign="top">includesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an include pattern</td>
- <td valign="top" align="center">No</td>
+ <td>includesfile</td>
+ <td>name of a file. Each line of this file is taken to be an include pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">replace</td>
- <td valign="top">Whether the file being renamed to should be
- replaced if it already exists</td>
- <td valign="top" align="center">No</td>
+ <td>replace</td>
+ <td>Whether the file being renamed to should be replaced if it already exists</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">srcDir</td>
- <td valign="top">The starting directory for files to search in</td>
- <td valign="top" align="center">Yes</td>
+ <td>srcDir</td>
+ <td>The starting directory for files to search in</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">toExtension</td>
- <td valign="top">The string that renamed files will end with on
- completion</td>
- <td valign="top" align="center">Yes</td>
+ <td>toExtension</td>
+ <td>The string that renamed files will end with on completion</td>
+ <td>Yes</td>
</tr>
</table>
<h3>Examples</h3>
- <pre><renameext srcDir="/source/project1"
- includes="**"
- excludes="**/samples/*"
- fromExtension=".java.keep"
- toExtension=".java"
- replace="true"/>
- </pre>
+<pre>
+<renameext srcDir="/source/project1"
+ includes="**"
+ excludes="**/samples/*"
+ fromExtension=".java.keep"
+ toExtension=".java"
+ replace="true"/></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/replace.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/replace.html b/manual/Tasks/replace.html
index c2981cd..3e2d011 100644
--- a/manual/Tasks/replace.html
+++ b/manual/Tasks/replace.html
@@ -26,141 +26,128 @@
<h2 id="replace">Replace</h2>
<h3>Description</h3>
-<p>Replace is a directory based task for replacing the occurrence of a given string with another string
-in selected file.</p>
-<p>If you want to replace a text that crosses line boundaries, you
-must use a nested <code><replacetoken></code> element.</p>
+<p><code>Replace</code> is a directory based task for replacing the occurrence of a given string
+with another string in selected file.</p>
+<p>If you want to replace a text that crosses line boundaries, you must use a
+nested <code><replacetoken></code> element.</p>
-<p>The output file is only written if it differs from the existing
-file. This prevents spurious rebuilds based on unchanged files which
-have been regenerated by this task.</p>
+<p>The output file is only written if it differs from the existing file. This prevents spurious
+rebuilds based on unchanged files which have been regenerated by this task.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">file for which the token should be replaced.</td>
- <td align="center" rowspan="2">Exactly one of the two</td>
+ <td>file</td>
+ <td>file for which the token should be replaced.</td>
+ <td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
- <td valign="top">dir</td>
- <td valign="top">The base directory to use when replacing a token in
- multiple files.</td>
+ <td>dir</td>
+ <td class="left">The base directory to use when replacing a token in multiple files.</td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">The encoding of the files upon which replace operates.</td>
- <td align="center">No - defaults to default JVM encoding</td>
+ <td>encoding</td>
+ <td>The encoding of the files upon which replace operates.</td>
+ <td>No; defaults to default JVM character encoding</td>
</tr>
<tr>
- <td valign="top">token</td>
- <td valign="top">the token which must be replaced.</td>
- <td valign="top" align="center">Yes, unless a nested
- <code>replacetoken</code> element or the replacefilterfile
- attribute is used.</td>
+ <td>token</td>
+ <td>the token which must be replaced.</td>
+ <td>Yes, unless a nested <code>replacetoken</code> element or the <var>replacefilterfile</var>
+ attribute is used.</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">the new value for the token. When omitted, an empty string
- ("") is used.</td>
- <td valign="top" align="center">No</td>
+ <td>value</td>
+ <td>the new value for the token.</td>
+ <td>No; defaults to empty string (<q></q>)</td>
</tr>
<tr>
- <td valign="top">summary</td>
- <td valign="top">Indicates whether a summary of the replace operation
- should be produced, detailing how many token occurrences
- and files were processed
- </td>
- <td valign="top" align="center">No, by default no summary is produced</td>
+ <td>summary</td>
+ <td>Indicates whether a summary of the replace operation should be produced, detailing how many
+ token occurrences and files were processed</td>
+ <td>No; defaults to no summary</td>
</tr>
<tr>
- <td valign="top">propertyFile</td>
- <td valign="top">valid property file from which properties specified using nested <code><replacefilter></code> elements are drawn.</td>
- <td valign="top" align="center">Yes only if <i>property</i> attribute of <code><replacefilter></code> is used.</td>
+ <td>propertyFile</td>
+ <td>valid property file from which properties specified using
+ nested <code><replacefilter></code> elements are drawn.</td>
+ <td>Yes, only if <var>property</var> attribute of <code><replacefilter></code> is
+ used.</td>
</tr>
<tr>
- <td valign="top">replacefilterfile</td>
- <td valign="top">valid property file. Each property will be
- treated as a replacefilter where <code>token</code> is the name of
- the property and <code>value</code> is the properties value.
- <td valign="top" align="center">No.</td>
+ <td>replacefilterfile</td>
+ <td>valid property file. Each property will be treated as a <code>replacefilter</code>
+ where <var>token</var> is the name of the property and <var>value</var> is the property's
+ value.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">includes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- included. All files are included when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>includes</td>
+ <td>comma- or space-separated list of patterns of files that must be included.</td>
+ <td>No; defaults to all (<q>**</q>)</td>
</tr>
<tr>
- <td valign="top">includesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an include pattern</td>
- <td valign="top" align="center">No</td>
+ <td>includesfile</td>
+ <td>name of a file. Each line of this file is taken to be an include pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">excludes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- excluded. No files (except default excludes) are excluded when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>excludes</td>
+ <td>comma- or space-separated list of patterns of files that must be excluded.</td>
+ <td>No; defaults to default excludes or none if <var>defaultexcludes</var> is <q>no</q></td>
</tr>
<tr>
- <td valign="top">excludesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an exclude pattern</td>
- <td valign="top" align="center">No</td>
+ <td>excludesfile</td>
+ <td>name of a file. Each line of this file is taken to be an exclude pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top">indicates whether default excludes should be used or not
- ("yes"/"no"). Default excludes are used when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
+ <td>No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">preserveLastModified</td>
- <td valign="top">Keep the file timestamp(s) even if the file(s)
- is(are) modified. <em>since Apache Ant 1.8.0</em>.</td>
- <td valign="top" align="center">No, defaults to false</td>
+ <td>preserveLastModified</td>
+ <td>Keep the file timestamp(s) even if the file(s) is(are) modified. <em>since Apache Ant
+ 1.8.0</em>.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">failOnNoReplacements</td>
- <td valign="top">Whether to fail the build if the task didn't do
- anything. <em>since Ant 1.8.0</em>.</td>
- <td valign="top" align="center">No, defaults to false</td>
+ <td>failOnNoReplacements</td>
+ <td>Whether to fail the build if the task didn't do anything. <em>since Ant 1.8.0</em>.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
</table>
<h3>Examples</h3>
-<pre> <replace file="${src}/index.html" token="@@@" value="wombat"/></pre>
-<p>replaces occurrences of the string "@@@" with the string
-"wombat", in the file <code>${src}/index.html</code>.</p>
+<pre><replace file="${src}/index.html" token="@@@" value="wombat"/></pre>
+<p>replaces occurrences of the string <q>@@@</q> with the string <q>wombat</q>, in the
+file <samp>${src}/index.html</samp>.</p>
<h3>Parameters specified as nested elements</h3>
-<p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and
-supports most attributes of <code><fileset></code> as well as the
-nested <code><include></code>, <code><exclude></code> and
-<code><patternset></code> elements.</p>
-<p>Since Ant 1.8.0 this task supports any filesystem
- based <a href="../Types/resources.html#collection">resource
- collections</a> as nested elements.</p>
+<p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and supports most
+attributes of <code><fileset></code> as well as the
+nested <code><include></code>, <code><exclude></code>
+and <code><patternset></code> elements.</p>
+<p><em>Since Ant 1.8.0</em>, this task supports any filesystem
+based <a href="../Types/resources.html#collection">resource collections</a> as nested elements.</p>
<h4>replacetoken and replacevalue</h4>
-<p>If either the text you want to replace or the replacement text
-cross line boundaries, you can use nested elements to specify
-them.</p>
+<p>If either the text you want to replace or the replacement text cross line boundaries, you can use
+nested elements to specify them.</p>
<p>The elements support attributes:</p>
<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>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">expandProperties</td>
- <td valign="top">Whether to expand properties in the nested text.
- <em>Since Ant 1.8.0</em>.</td>
- <td align="center">No, defaults to true.</td>
+ <td>expandProperties</td>
+ <td>Whether to expand properties in the nested text. <em>Since Ant 1.8.0</em>.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
<h3>Examples</h3>
@@ -169,71 +156,73 @@ them.</p>
<include name="**/*.html"/>
<replacetoken><![CDATA[multi line
token]]></replacetoken>
-</replace>
-</pre>
-<p>replaces occurrences of the string "multi
-line<i>\n</i>token" with the string "wombat", in all
-HTML files in the directory <code>${src}</code>.Where <i>\n</i> is
-the platform specific line separator.</p>
+</replace></pre>
+<p>replaces occurrences of the string <q>multi line<i>\n</i>token</q> with the string <q>wombat</q>,
+in all HTML files in the directory <samp>${src}</samp>. Here, <q><i>\n</i></q> is the platform
+specific line separator.</p>
<pre>
<replace file="${src}/index.html">
<replacetoken><![CDATA[two line
token]]></replacetoken>
<replacevalue><![CDATA[two line
token]]></replacevalue>
-</replace>
-</pre>
+</replace></pre>
<h4>replacefilter</h4>
-<p>In addition to allowing for multiple replacements, optional nested <code><replacefilter></code> elements allow replacement values to be extracted from a property file. The name of this file is specified using the <code><replace></code> attribute <i>propertyFile</i>.
-</p>
-<table>
+<p>In addition to allowing for multiple replacements, optional
+nested <code><replacefilter></code> elements allow replacement values to be extracted from a
+property file. The name of this file is specified using the <code><replace></code>
+attribute <var>propertyFile</var>.</p>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">token</td>
- <td valign="top">The string to search for.</td>
- <td align="center" valign="top">Yes unless a nested replacetoken
+ <td>token</td>
+ <td>The string to search for.</td>
+ <td>Yes, unless a nested <code>replacetoken</code>
is specified</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">The replacement string.</td>
- <td align="center" rowspan="2">Either may be specified, but not both. Both can be omitted, if desired.</td>
+ <td>value</td>
+ <td>The replacement string.</td>
+ <td rowspan="2">Either may be specified, but not both. Both can be omitted, if desired.</td>
</tr>
<tr>
- <td valign="top">property</td>
- <td valign="top">Name of the property whose value is to serve as the replacement value.</td>
+ <td>property</td>
+ <td class="left">Name of the property whose value is to serve as the replacement value.</td>
</tr>
</table>
-<p><em>Since Ant 1.8.0</em> token and value can be specified as nested elements
- just like in the task itself.</p>
-<p>If neither <i>value</i> nor <i>property</i> is used, the value provided using the <code><replace></code> attribute <i>value</i> and/or the <code><replacevalue></code> element is used. If no value was specified using either of these options, the token is replaced with an empty string.
-</p>
+<p><em>Since Ant 1.8.0</em>, <var>token</var> and <var>value</var> can be specified as nested
+elements just like in the task itself.</p>
+<p>If neither <var>value</var> nor <var>property</var> is used, the value provided using
+the <code><replace></code> attribute <var>value</var> and/or
+the <code><replacevalue></code> element is used. If no value was specified using either of
+these options, the token is replaced with an empty string.</p>
<h3>Examples</h3>
<pre>
-<replace
- file="configure.sh"
- value="defaultvalue"
- propertyFile="src/name.properties">
- <replacefilter
- token="@token1@"/>
- <replacefilter
- token="@token2@"
- value="value2"/>
- <replacefilter
- token="@token3@"
- property="property.key"/>
+<replace file="configure.sh"
+ value="defaultvalue"
+ propertyFile="src/name.properties">
+ <replacefilter token="@token1@"/>
+ <replacefilter token="@token2@"
+ value="value2"/>
+ <replacefilter token="@token3@"
+ property="property.key"/>
<replacefilter>
<replacetoken>@token4@</replacetoken>
<replacevalue>value4</replacevalue>
</replacefilter>
-</replace>
-</pre>
-<p>In file <code>configure.sh</code>, replace all instances of "@token1@" with "defaultvalue", all instances of "@token2@" with "value2", and all instances of "@token3@" with the value of the property "property.key", as it appears in property file <code>src/name.properties</code>.</p>
-<p><strong>Note</strong>: It is possible to use either the <i>token</i>/<code><replacetoken></code> and <i>value</i>/<code><replacevalue></code> attributes/elements, the nested replacefilter elements, or both in the same operation.</p>
+</replace></pre>
+<p>In file <samp>configure.sh</samp>, replace all instances of <q>@token1@</q>
+with <q>defaultvalue</q>, all instances of <q>@token2@</q> with <q>value2</q>, and all instances
+of <q>@token3@</q> with the value of the property <code>property.key</code>, as it appears in
+property file <samp>src/name.properties</samp>.</p>
+<p><strong>Note</strong>: It is possible to use either
+the <var>token</var>/<code><replacetoken></code>
+and <var>value</var>/<code><replacevalue></code> attributes/elements, the
+nested <code>replacefilter</code> elements, or both in the same operation.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/replaceregexp.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/replaceregexp.html b/manual/Tasks/replaceregexp.html
index 68f2c72..923373c 100644
--- a/manual/Tasks/replaceregexp.html
+++ b/manual/Tasks/replaceregexp.html
@@ -25,73 +25,71 @@
<h2 id="replaceregexp">ReplaceRegExp</h2>
<h3>Description</h3>
-<p>ReplaceRegExp is a directory based task for replacing the
-occurrence of a given regular expression with a substitution pattern
-in a selected file or set of files.</p>
+<p><code>ReplaceRegExp</code> is a directory based task for replacing the occurrence of a given
+regular expression with a substitution pattern in a selected file or set of files.</p>
-<p>The output file is only written if it differs from the existing
-file. This prevents spurious rebuilds based on unchanged files which
-have been regenerated by this task.</p>
+<p>The output file is only written if it differs from the existing file. This prevents spurious
+rebuilds based on unchanged files which have been regenerated by this task.</p>
-<p>Similar to <a href="../Types/mapper.html#regexp-mapper">regexp
-type mappers</a> this task needs a supporting regular expression
-library and an implementation of
-<code>org.apache.tools.ant.util.regexp.Regexp</code>.
-See details in the documentation of the <a href="../Types/regexp.html#implementation">Regexp Type</a>.</p>
+<p>Similar to <a href="../Types/mapper.html#regexp-mapper">regexp type mappers</a> this task needs a
+supporting regular expression library and an implementation
+of <code>org.apache.tools.ant.util.regexp.Regexp</code>. See details in the documentation of
+the <a href="../Types/regexp.html#implementation">Regexp Type</a>.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">file for which the regular expression should be replaced.</td>
- <td align="center">Yes if no nested <code><fileset></code> is used</td>
+ <td>file</td>
+ <td>file for which the regular expression should be replaced.</td>
+ <td>Yes, unless nested <code><fileset></code> is used</td>
</tr>
<tr>
- <td valign="top">match</td>
- <td valign="top">The regular expression pattern to match in the file(s)</td>
- <td align="center">Yes, if no nested <code><regexp></code> is used</td>
+ <td>match</td>
+ <td>The regular expression pattern to match in the file(s)</td>
+ <td>Yes, unless nested <code><regexp></code> is used</td>
</tr>
<tr>
- <td valign="top">replace</td>
- <td valign="top">The substitution pattern to place in the file(s) in place
- of the regular expression.</td>
- <td align="center">Yes, if no nested <code><substitution></code> is used</td>
+ <td>replace</td>
+ <td>The substitution pattern to place in the file(s) in place of the regular expression.</td>
+ <td>Yes, unless nested <code><substitution></code> is used</td>
</tr>
<tr>
- <td valign="top">flags</td>
- <td valign="top">The flags to use when matching the regular expression. For more
- information, consult the Perl5 syntax<br>
- g : Global replacement. Replace all occurrences found<br>
- i : Case Insensitive. Do not consider case in the match<br>
- m : Multiline. Treat the string as multiple lines of input, using "^" and "$" as the start or end of any line, respectively, rather than start or end of string.<br>
- s : Singleline. Treat the string as a single line of input, using "." to match any character, including a newline, which normally, it would not match.<br>
+ <td>flags</td>
+ <td>The flags to use when matching the regular expression. For more information, consult the
+ Perl 5 syntax<br>
+ <q>g</q> : Global replacement. Replace all occurrences found<br>
+ <q>i</q> : Case Insensitive. Do not consider case in the match<br>
+ <q>m</q> : Multiline. Treat the string as multiple lines of input, using <q>^</q>
+ and <q>$</q> as the start or end of any line, respectively, rather than start or end of
+ string.<br>
+ <q>s</q> : Singleline. Treat the string as a single line of input, using <q>.</q> to match
+ any character, including a newline, which normally, it would not match.<br>
</td>
- <td valign="top" align="center">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">byline</td>
- <td valign="top">Process the file(s) one line at a time, executing the replacement
- on one line at a time (<i>true/false</i>). This is useful if you
- want to only replace the first occurrence of a regular expression on
- each line, which is not easy to do when processing the file as a whole.
- Defaults to <i>false</i>.</td>
- <td valign="top" align="center">No</td>
+ <td>byline</td>
+ <td>Process the file(s) one line at a time, executing the replacement on one line at a time
+ (<q>true|false</q>). This is useful if you want to only replace the first occurrence of a
+ regular expression on each line, which is not easy to do when processing the file as a
+ whole.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">The encoding of the file. <em>since Apache Ant 1.6</em></td>
- <td align="center">No - defaults to default JVM encoding</td>
+ <td>encoding</td>
+ <td>The encoding of the file. <em>since Apache Ant 1.6</em></td>
+ <td>No; defaults to default JVM character encoding</td>
</tr>
<tr>
- <td valign="top">preserveLastModified</td>
- <td valign="top">Keep the file timestamp(s) even if the file(s)
- is(are) modified. <em>since Ant 1.8.0</em>.</td>
- <td valign="top" align="center">No, defaults to false</td>
+ <td>preserveLastModified</td>
+ <td>Keep the file timestamp(s) even if the file(s) is(are) modified. <em>since Ant
+ 1.8.0</em>.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
</table>
<h3>Examples</h3>
@@ -99,93 +97,81 @@ See details in the documentation of the <a href="../Types/regexp.html#implementa
<replaceregexp file="${src}/build.properties"
match="OldProperty=(.*)"
replace="NewProperty=\1"
- byline="true"
-/>
-</pre>
-<p>replaces occurrences of the property name "OldProperty"
- with "NewProperty" in a properties file, preserving the existing
-value, in the file <code>${src}/build.properties</code></p>
+ byline="true"/></pre>
+<p>replaces occurrences of the property name <q>OldProperty</q> with <q>NewProperty</q> in a
+properties file, preserving the existing value, in the file <samp>${src}/build.properties</samp></p>
<h3>Parameters specified as nested elements</h3>
-<p>This task supports a nested <a href="../Types/fileset.html">FileSet</a>
- element.</p>
+<p>This task supports a nested <a href="../Types/fileset.html">FileSet</a> element.</p>
<p><em>Since Ant 1.8.0</em>, this task supports any filesystem
- based <a href="../Types/resources.html#collection">resource
- collections</a> as nested elements.</p>
-<p>This task supports a nested <i><a href="../Types/regexp.html">Regexp</a></i> element to specify
- the regular expression. You can use this element to refer to a previously
- defined regular expression datatype instance.</p>
+based <a href="../Types/resources.html#collection">resource collections</a> as nested elements.</p>
+<p>This task supports a nested <a href="../Types/regexp.html">Regexp</a> element to specify the
+regular expression. You can use this element to refer to a previously defined regular expression
+datatype instance.</p>
- <regexp id="id" pattern="alpha(.+)beta"/><br>
- <regexp refid="id"/>
-
-<p>This task supports a nested <i>Substitution</i> element to specify
- the substitution pattern. You can use this element to refer to a previously
- defined substitution pattern datatype instance.</p>
-
- <substitution id="id" expression="beta\1alpha"/><br>
- <substitution refid="id"/>
+<pre>
+<regexp id="id" pattern="alpha(.+)beta"/>
+<regexp refid="id"/></pre>
+<p>This task supports a nested <code>Substitution</code> element to specify the substitution
+pattern. You can use this element to refer to a previously defined substitution pattern datatype
+instance.</p>
+<pre>
+<substitution id="id" expression="beta\1alpha"/><br>
+<substitution refid="id"/></pre>
<h3>Examples</h3>
<pre>
<replaceregexp byline="true">
- <regexp pattern="OldProperty=(.*)"/>
- <substitution expression="NewProperty=\1"/>
- <fileset dir=".">
- <include name="*.properties"/>
- </fileset>
-</replaceregexp>
-</pre>
-<p>replaces occurrences of the property name "OldProperty"
- with "NewProperty" in a properties file, preserving the existing
-value, in all files ending in <code>.properties</code> in the current directory</p>
-
-<pre><replaceregexp match="\s+" replace=" " flags="g" byline="true">
+ <regexp pattern="OldProperty=(.*)"/>
+ <substitution expression="NewProperty=\1"/>
+ <fileset dir=".">
+ <include name="*.properties"/>
+ </fileset>
+</replaceregexp></pre>
+<p>replaces occurrences of the property name <q>OldProperty</q> with <q>NewProperty</q> in a
+properties file, preserving the existing value, in all files ending in <samp>.properties</samp> in
+the current directory</p>
+
+<pre>
+<replaceregexp match="\s+" replace=" " flags="g" byline="true">
<fileset dir="${html.dir}" includes="**/*.html"/>
-</replaceregexp>
-</pre>
-<p>replaces all whitespaces (blanks, tabs, etc) by one blank remaining the
-line separator. So with input</p>
+</replaceregexp></pre>
+<p>replaces all whitespaces (blanks, tabs, etc) by one blank remaining the line separator. So with
+input</p>
<pre>
<html> <body>
<<TAB>><h1> T E S T </h1> <<TAB>>
-<<TAB>> </body></html>
-</pre>
+<<TAB>> </body></html></pre>
<p>would converted to</p>
<pre>
<html> <body>
- <h1> T E S T </h1> </body></html>
-</pre>
+ <h1> T E S T </h1> </body></html></pre>
<br><!-- small distance from code of the previous example -->
-<pre><replaceregexp match="\\n" replace="${line.separator}" flags="g" byline="true">
- <fileset dir="${dir}"/>
-</replaceregexp>
-</pre>
-<p>replaces all <tt>\n</tt> markers (beware the quoting of the backslash) by a line break.
-So with input</p>
<pre>
-one\ntwo\nthree
-</pre>
+<replaceregexp match="\\n" replace="${line.separator}" flags="g" byline="true">
+ <fileset dir="${dir}"/>
+</replaceregexp></pre>
+<p>replaces all <q>\n</q> markers (beware the quoting of the backslash) by a line break. So with
+input</p>
+<pre>one\ntwo\nthree</pre>
<p>would converted to</p>
<pre>
one
two
-three
-</pre>
+three</pre>
<p>Beware that inserting line breaks could break file syntax. For example in xml:</p>
<pre>
<root>
- <text>line breaks \n should work in text</text>
- <attribute value="but breaks \n attributes" />
-</root>
-</pre>
+ <text>line breaks \n should work in text</text>
+ <attribute value="but breaks \n attributes"/>
+</root></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/resourcecount.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/resourcecount.html b/manual/Tasks/resourcecount.html
index 39d9627..6e0649e 100644
--- a/manual/Tasks/resourcecount.html
+++ b/manual/Tasks/resourcecount.html
@@ -27,58 +27,59 @@
<h2>ResourceCount</h2>
<h3>Description</h3>
-<p>Display or set a property containing the size of a nested
- <a href="../Types/resources.html#collection">Resource Collection</a>.
- Can also be used as a condition. <em>Since Apache Ant 1.7</em></p>
+<p>Display or set a property containing the size of a
+nested <a href="../Types/resources.html#collection">Resource Collection</a>. Can also be used as a
+condition. <em>Since Apache Ant 1.7</em></p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th rowspan="2">Attribute</th>
+ <th rowspan="2">Description</th>
+ <th colspan="2">Required</th>
</tr>
<tr>
- <td valign="top">property</td>
- <td valign="top">The property to set. If omitted the results are written
- to the log. Ignored when processing as a condition.</td>
- <td valign="top" align="center">No</td>
+ <th>Task</th>
+ <th>Condition</th>
</tr>
<tr>
- <td valign="top">refid</td>
- <td valign="top">A <a href="../using.html#references">reference</a>
- to a Resource Collection.</td>
- <td valign="top" align="center">
- Yes, unless a nested Resource Collection is supplied
- </td>
+ <td>property</td>
+ <td>The property to set.</td>
+ <td class="center">No; by default, output value to the log</td>
+ <td>Ignored</td>
</tr>
<tr>
- <td valign="top">count</td>
- <td valign="top">Comparison count for processing as a condition.</td>
- <td valign="top" align="center">Yes, in condition mode</td>
+ <td>refid</td>
+ <td>A <a href="../using.html#references">reference</a> to a Resource Collection.</td>
+ <td colspan="2">Yes, unless a nested Resource Collection is supplied</td>
</tr>
<tr>
- <td valign="top">when</td>
- <td valign="top">Comparison type: "equal", "eq", "greater", "gt", "less",
- "lt", "ge" (greater or equal), "ne" (not equal), "le" (less or equal)
- for use when operating as a condition.</td>
- <td valign="top" align="center">No; default is "equal"</td>
+ <td>count</td>
+ <td>Comparison count.</td>
+ <td class="center">Ignored</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>when</td>
+ <td>Comparison
+ type: <q>equal</q>, <q>eq</q>, <q>greater</q>, <q>gt</q>, <q>less</q>, <q>lt</q>, <q>ge</q>
+ (greater or equal), <q>ne</q> (not equal), <q>le</q> (less or equal).</td>
+ <td class="center">Ignored</td>
+ <td>No; default is <q>equal</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>Resource Collection</h4>
-<p>A single
- <a href="../Types/resources.html#collection">Resource Collection</a>
-should be specified via a nested element or the <code>refid</code> attribute.
-</p>
+<p>A single <a href="../Types/resources.html#collection">Resource Collection</a> should be specified
+via a nested element or the <var>refid</var> attribute.</p>
<h3>Examples</h3>
-<pre><resourcecount property="count.foo">
- <filelist dir="." files="foo,bar" />
-</resourcecount>
-</pre>
-<p>Stores the number of resources in the specified filelist (two)
-in the property named <i>count.foo</i>.</p>
+<pre>
+<resourcecount property="count.foo">
+ <filelist dir="." files="foo,bar"/>
+</resourcecount></pre>
+<p>Stores the number of resources in the specified filelist (two) in the property
+named <samp>count.foo</samp>.</p>
<pre>
<project>
@@ -96,10 +97,9 @@ in the property named <i>count.foo</i>.</p>
</tokens>
</resourcecount>
<echo>The file '${file}' has ${file.lines} lines.</echo>
-</project>
-</pre>
-<p>Stores the number of lines of the current buildfile in the property <tt>file.lines</tt>.
-Requires Ant 1.7.1+ as <concat> has to be resource.</p>
+</project></pre>
+<p>Stores the number of lines of the current buildfile in the property <code>file.lines</code>.
+Requires Ant 1.7.1+ as <code><concat></code> has to be a resource.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/retry.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/retry.html b/manual/Tasks/retry.html
index 360019f..f847928 100644
--- a/manual/Tasks/retry.html
+++ b/manual/Tasks/retry.html
@@ -24,27 +24,27 @@
<body>
<h2>Retry</h2>
<h3>Description</h3>
-<p>Retry is a container which executes a single nested task until either: there is no failure; or:
-its <em>retrycount</em> has been exceeded. If this happens a BuildException is thrown.
-<em>Since Apache Ant 1.7.1</em></p>
+<p><code>Retry</code> is a container which executes a single nested task until either: there is no
+failure; or: its <var>retrycount</var> has been exceeded. If this happens a BuildException is
+thrown. <em>Since Apache Ant 1.7.1</em></p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">retrycount</td>
- <td valign="top">number of times to attempt to execute the nested task</td>
- <td valign="top" align="center">Yes</td>
+ <td>retrycount</td>
+ <td>number of times to attempt to execute the nested task</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">retrydelay</td>
- <td valign="top">number of milliseconds to wait between retry attempts
- task. <em>Since Apache Ant 1.8.3</em></td>
- <td valign="top" align="center">No, defaults to no delay</td>
+ <td>retrydelay</td>
+ <td>number of milliseconds to wait between retry attempts task. <em>Since Apache Ant
+ 1.8.3</em></td>
+ <td>No; defaults to no delay</td>
</tr>
</table>
<p>Any valid Ant task may be embedded within the retry task.</p>
@@ -53,9 +53,9 @@ its <em>retrycount</em> has been exceeded. If this happens a BuildException is t
<pre>
<retry retrycount="3">
<get src="http://www.unreliable-server.com/unreliable.tar.gz"
- dest="/home/retry/unreliable.tar.gz" />
-</retry>
-</pre>
-<p>This example shows how to use <code><retry></code> to wrap a task which must interact with an unreliable network resource.</p>
+ dest="/home/retry/unreliable.tar.gz"/>
+</retry></pre>
+<p>This example shows how to use <code><retry></code> to wrap a task which must interact with
+an unreliable network resource.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/rexec.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/rexec.html b/manual/Tasks/rexec.html
index c3940fc..609d0c2 100644
--- a/manual/Tasks/rexec.html
+++ b/manual/Tasks/rexec.html
@@ -26,20 +26,21 @@
<h2 id="rexec">RExec</h2>
<h3>Description</h3>
-Task to automate a remote rexec session. Just like the Telnet task,
-it uses nested <tt><read></tt> to indicate strings to wait for, and
-<tt><write></tt> tags to specify text to send to the remote process.
+<p>Task to automate a remote rexec session. Just like the <code>Telnet</code> task, it uses
+nested <code><read></code> to indicate strings to wait for, and
+<code><write></code> tags to specify text to send to the remote
+process.</p>
-<p><strong>Note</strong>: This task depends on external libraries not included in the Apache Ant distribution.
-See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p>
+<p><strong>Note</strong>: This task depends on external libraries not included in the Apache Ant
+distribution. See <a href="../install.html#librarydependencies">Library Dependencies</a> for more
+information.</p>
-<p>You can specify the commands you want to execute as nested elements
-or via the command attribute, we recommend you use the command
-attribute. If you use the command attribute, you must use the
-username and password attributes as well.</p>
+<p>You can specify the commands you want to execute as nested elements or via the <var>command</var>
+attribute, we recommend you use the <var>command</var> attribute. If you use the <var>command</var>
+attribute, you must use the <var>username</var> and <var>password</var> attributes as well.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -67,47 +68,40 @@ username and password attributes as well.</p>
</tr>
<tr>
<td>port</td>
- <td>the port number of the remote rexec server. Defaults to port 512 in BSD Unix systems.</td>
- <td>No</td>
+ <td>the port number of the remote rexec server.</td>
+ <td>No; defaults to <q>512</q> in Unix</td>
</tr>
<tr>
<td>timeout</td>
- <td>set a default timeout to wait for a response. Specified in seconds. Default is no timeout.</td>
- <td>No</td>
+ <td>set a default timeout to wait for a response, specified in seconds.</td>
+ <td>No; default is no timeout</td>
</tr>
</table>
<h3 id="nested">Nested Elements</h3>
-The input to send to the server, and responses to wait for, are
-described as nested elements.
+<p>The input to send to the server, and responses to wait for, are described as nested elements.</p>
<h4>read</h4>
-<p>declare (as a text child of this element) a string to wait for.
-The element supports the timeout attribute, which overrides any
-timeout specified for the task as a whole. It also has a <tt>string</tt>
-attribute, which is an alternative to specifying the string as
-a text element.
-</p>
-<i>It is not necessary to declare a closing <code><read></code> element like for the Telnet task. The connection is not broken until the command has completed and
-the input stream (output of the command) is terminated.
-</i>
+<p>declare (as a text child of this element) a string to wait for. The element supports
+the <var>timeout</var> attribute, which overrides any timeout specified for the task as a whole. It
+also has a <var>string</var> attribute, which is an alternative to specifying the string as a text
+element.</p>
+<p><em>It is not necessary to declare a closing <code><read></code> element like for
+the <code>Telnet</code> task. The connection is not broken until the command has completed and the
+input stream (output of the command) is terminated.</em></p>
+
<h4>write</h4>
-<p>describes the text to send to the server. The <tt>echo</tt> boolean
-attribute controls whether the string is echoed to the local log;
-this is "true" by default
-</p>
+<p>describes the text to send to the server. The <var>echo</var> boolean attribute controls whether
+the string is echoed to the local log; this is <q>true</q> by default.</p>
<h3>Example</h3>
-A simple example of connecting to a server and running a command.
+<p>A simple example of connecting to a server and running a command.</p>
+
+<pre><rexec userid="bob" password="badpass" server="localhost" command="ls"/></pre>
-<pre>
-<rexec userid="bob" password="badpass" server="localhost" command="ls"/>
-</pre>
+<p>The task can be used with other ports as well:</p>
-The task can be used with other ports as well:
-<pre>
-<rexec port="80" userid="bob" password="badpass" server="localhost" command="ls"/>
-</pre>
+<pre><rexec port="80" userid="bob" password="badpass" server="localhost" command="ls"/></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/rmic.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/rmic.html b/manual/Tasks/rmic.html
index 8ac52d5..9ba41b5 100644
--- a/manual/Tasks/rmic.html
+++ b/manual/Tasks/rmic.html
@@ -26,315 +26,282 @@
<h2 id="rmic">Rmic</h2>
<h3>Description</h3>
-<p>Runs the rmic compiler for a certain class.</p>
-<p>Rmic can be run on a single class (as specified with the classname
-attribute) or a number of classes at once (all classes below base that
-are neither _Stub nor _Skel classes). If you want to rmic a single
-class and this class is a class nested into another class, you have to
-specify the classname in the form <code>Outer$$Inner</code> instead of
-<code>Outer.Inner</code>.</p>
-<p>It is possible to refine the set of files that are being rmiced. This can be
-done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
-attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
-have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
-the files you want to have excluded. This is also done with patterns. And
-finally with the <i>defaultexcludes</i> attribute, you can specify whether you
-want to use default exclusions or not. See the section on <a
-href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the
+<p>Runs the <code>rmic</code> compiler for a certain class.</p>
+<p><code>Rmic</code> can be run on a single class (as specified with the classname attribute) or a
+number of classes at once (all classes below base that are neither <code>_Stub</code>
+nor <code>_Skel</code> classes). If you want to <code>rmic</code> a single class and this class is
+a class nested into another class, you have to specify the classname in the
+form <code>Outer$$Inner</code> instead of <code>Outer.Inner</code>.</p>
+<p>It is possible to refine the set of files that are being <code>rmic</code>ed. This can be done
+with the <var>includes</var>, <var>includesfile</var>, <var>excludes</var>, <var>excludesfile</var>
+and <var>defaultexcludes</var> attributes. With the <var>includes</var> or <var>includesfile</var>
+attribute you specify the files you want to have included by using patterns. The <var>exclude</var>
+or <var>excludesfile</var> attribute is used to specify the files you want to have excluded. This is
+also done with patterns. And finally with the <var>defaultexcludes</var> attribute, you can specify
+whether you want to use default exclusions or not. See the section
+on <a href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the
inclusion/exclusion of files works, and how to write patterns.</p>
-<p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and
-supports most attributes of <code><fileset></code>
-(<code>dir</code> becomes <code>base</code>) as well as the nested
-<code><include></code>, <code><exclude></code> and
-<code><patternset></code> elements.</p>
-<p id="compilervalues">It is possible to use different compilers. This can be selected
-with the "build.rmic" property, the <code>compiler</code>
-attribute, or a nested element. Here are the choices:</p>
+<p>This task forms an implicit <a href="../Types/fileset.html">FileSet</a> and supports most
+attributes of <code><fileset></code> (<var>dir</var> becomes <var>base</var>) as well as the
+nested <code><include></code>, <code><exclude></code>
+and <code><patternset></code> elements.</p>
+<p id="compilervalues">It is possible to use different compilers. This can be selected with
+the <code>build.rmic</code> property, the <var>compiler</var> attribute, or a nested element. Here
+are the choices:</p>
<ul>
- <li>default -the default compiler (kaffe, sun or forking) for the platform.
- <li>sun - the standard compiler of the JDK < 9</li>
- <li>kaffe - the standard compiler of <a href="http://www.kaffe.org" target="_top">Kaffe</a></li>
- <li>weblogic</li>
- <li>forking - (<em>since Apache Ant 1.7</em>) the sun compiler forked into a separate process.
- <em>Since Ant 1.9.8</em>, this is the default when running on JDK 9+.</li>
- <li>xnew - (<em>since Ant 1.7</em>) the sun compiler forked into a separate process,
- with the -Xnew option. This is the most reliable way to use -Xnew.<br>
- JDK 9 has removed support for -Xnew and <em>since Ant 1.9.8</em>
- this option will be rejected when running on JDK 9.</li>
- <li> "" (empty string). This has the same behaviour as not setting the compiler attribute.
- First the value of <tt>build.rmic</tt> is used if defined, and if not, the default
- for the platform is chosen. If build.rmic is set to this, you get the default.</li>
+ <li><q>default</q>—the default compiler (<q>kaffe</q>, <q>sun</q> or <q>forking</q>) for the
+ platform.
+ <li><q>sun</q>—the standard compiler of the JDK < 9</li>
+ <li><q>kaffe</q>—the standard compiler of <a href="http://www.kaffe.org"
+ target="_top">Kaffe</a></li>
+ <li><q>weblogic</q></li>
+ <li><q>forking</q>—(<em>since Apache Ant 1.7</em>) the <q>sun</q> compiler forked into a
+ separate process. <em>Since Ant 1.9.8</em>, this is the default when running on JDK 9+.</li>
+ <li><q>xnew</q>—(<em>since Ant 1.7</em>) the <q>sun</q> compiler forked into a separate
+ process, with the <code>-Xnew</code> option. This is the most reliable way to
+ use <code>-Xnew</code>.<br/>JDK 9 has removed support for <code>-Xnew</code> and <em>since Ant
+ 1.9.8</em> this option will be rejected when running on JDK 9.</li>
+ <li><q></q> (empty string). This has the same behaviour as not setting the compiler attribute.
+ First the value of <code>build.rmic</code> is used if defined, and if not, the default for the
+ platform is chosen. If <code>build.rmic</code> is set to this, you get the default.</li>
</ul>
-<p>The <a href="http://dione.zcu.cz/~toman40/miniRMI/">miniRMI</a>
-project contains a compiler implementation for this task as well,
-please consult miniRMI's documentation to learn how to use it.</p>
+<p>The <a href="https://web.archive.org/web/20131225023602/http://dione.zcu.cz/~toman40/miniRMI/">miniRMI</a>
+project contains a compiler implementation for this task as well, please consult miniRMI's
+documentation to learn how to use it.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
- <tr>
- <td valign="top">base</td>
- <td valign="top">the location to store the compiled files.
- Also serves as the parent directory for any non-Fileset includes, etc.
- (This functionality has remained unchanged.)</td>
- <td valign="top" align="center" rowspan="2"><a href="#footnote-1">*1</a></td>
+ <tr id="1">
+ <td>base</td>
+ <td>the location to store the compiled files. Also serves as the parent directory for any
+ non-Fileset includes, etc. (This functionality has remained unchanged.)</td>
+ <td rowspan="2">See <a href="#footnote-1">note</a></td>
</tr>
<tr>
- <td valign="top">destdir</td>
- <td valign="top">the location to store the compiled files.</td>
+ <td>destdir</td>
+ <td class="left">the location to store the compiled files.</td>
</tr>
<tr>
- <td valign="top">classname</td>
- <td valign="top">the class for which to run <code>rmic</code>.</td>
- <td valign="top" align="center">No</td>
+ <td>classname</td>
+ <td>the class for which to run <code>rmic</code>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">filtering</td>
- <td valign="top">indicates whether token filtering should take place</td>
- <td valign="top" align="center">No</td>
+ <td>filtering</td>
+ <td>indicates whether token filtering should take place</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">sourcebase</td>
- <td valign="top">Pass the "-keepgenerated" flag to rmic and
- move the generated source file to the given sourcebase directory.</td>
- <td align="center" valign="top">No</td>
+ <td>sourcebase</td>
+ <td>Pass the <code>-keepgenerated</code> flag to <code>rmic</code> and move the generated source
+ file to the given <var>sourcebase</var> directory.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">stubversion</td>
- <td valign="top">Specify the JDK version for the generated stub code.
- Specify "1.1" to pass the "-v1.1" option to rmic,
- "1.2" for -v12, compat for -vcompat.<br>
- <em>Since Ant 1.7</em>, if you do not specify a version, and do not ask
- for iiop or idl files, "compat" is selected.
-
- </td>
- <td align="center" valign="top">No, default="compat"</td>
+ <td>stubversion</td>
+ <td>Specify the JDK version for the generated stub code. Specify <q>1.1</q> to pass
+ the <code>-v1.1</code> option to <code>rmic</code>, <q>1.2</q>
+ for <code>-v12</code>, <q>compat</q> for <code>-vcompat</code>.<br>/<em>Since Ant 1.7</em>, if
+ you do not specify a version, and do not ask for <samp>.iiop</samp> or <samp>.idl</samp>
+ files, <q>compat</q> is selected.</td>
+ <td>No; default is <q>compat</q></td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">The classpath to use during compilation</td>
- <td align="center" valign="top">No</td>
+ <td>classpath</td>
+ <td>The classpath to use during compilation</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">The classpath to use during compilation, given as <a
- href="../using.html#references">reference</a> to a PATH defined elsewhere</td>
- <td align="center" valign="top">No</td>
+ <td>classpathref</td>
+ <td>The classpath to use during compilation, given
+ as <a href="../using.html#references">reference</a> to a path defined elsewhere</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">includes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- included. All files are included when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>includes</td>
+ <td>comma- or space-separated list of patterns of files that must be included.</td>
+ <td>No; defaults to all (<q>**</q>)</td>
</tr>
<tr>
- <td valign="top">includesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an include pattern</td>
- <td valign="top" align="center">No</td>
+ <td>includesfile</td>
+ <td>name of a file. Each line of this file is taken to be an include pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">excludes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- excluded. No files (except default excludes) are excluded when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>excludes</td>
+ <td>comma- or space-separated list of patterns of files that must be excluded.</td>
+ <td>No; defaults to default excludes or none if <var>defaultexcludes</var> is <q>no</q></td>
</tr>
<tr>
- <td valign="top">excludesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an exclude pattern</td>
- <td valign="top" align="center">No</td>
+ <td>excludesfile</td>
+ <td>name of a file. Each line of this file is taken to be an exclude pattern</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top">indicates whether default excludes should be used or not
- ("yes"/"no"). Default excludes are used when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
+ <td>No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">verify</td>
- <td valign="top">check that classes implement Remote before handing them
- to rmic (default is false)</td>
- <td align="center" valign="top">No</td>
+ <td>verify</td>
+ <td>check that classes implement <code>Remote</code> before handing them to <code>rmic</code></td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">iiop</td>
- <td valign="top">indicates that portable (RMI/IIOP) stubs should be generated</td>
- <td align="center" valign="top">No</td>
+ <td>iiop</td>
+ <td>indicates that portable (RMI/IIOP) stubs should be generated</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">iiopopts</td>
- <td valign="top">additional arguments for IIOP class generation</td>
- <td align="center" valign="top">No</td>
+ <td>iiopopts</td>
+ <td>additional arguments for IIOP class generation</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">idl</td>
- <td valign="top">indicates that IDL output files should be generated</td>
- <td align="center" valign="top">No</td>
+ <td>idl</td>
+ <td>indicates that IDL output files should be generated</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">idlopts</td>
- <td valign="top">additional arguments for IDL file generation</td>
- <td align="center" valign="top">No</td>
+ <td>idlopts</td>
+ <td>additional arguments for IDL file generation</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">debug</td>
- <td valign="top">generate debug info (passes -g to rmic). Defaults to false.</td>
- <td align="center" valign="top">No</td>
+ <td>debug</td>
+ <td>generate debug info (passes <code>-g</code> to <code>rmic</code>)</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">includeAntRuntime</td>
- <td valign="top">whether to include the Ant run-time libraries;
- defaults to <code>yes</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>includeAntRuntime</td>
+ <td>whether to include the Ant run-time libraries</td>
+ <td>No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">includeJavaRuntime</td>
- <td valign="top">whether to include the default run-time
- libraries from the executing VM; defaults to <code>no</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>includeJavaRuntime</td>
+ <td>whether to include the default run-time libraries from the executing JVM</td>
+ <td>No; defaults to <q>no</q></td>
</tr>
<tr>
- <td valign="top">extdirs</td>
- <td valign="top">location of installed extensions.</td>
- <td align="center" valign="top">No</td>
+ <td>extdirs</td>
+ <td>location of installed extensions</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">compiler</td>
- <td valign="top">The compiler implementation to use.
- If this attribute is not set, the value of the
- <code>build.rmic</code> property, if set, will be used.
- Otherwise, the default compiler for the current VM will be used.
- (See the above <a href="#compilervalues">list</a> of valid
- compilers.)</td>
- <td align="center" valign="top">No</td>
+ <td>compiler</td>
+ <td>The compiler implementation to use. (See the above <a href="#compilervalues">list</a> of
+ valid compilers.)</td>
+ <td>No; defaults to the value of the <code>build.rmic</code> property, if set, and the default
+ compiler for the current JDK otherwise</td>
</tr>
<tr>
- <td valign="top">executable</td>
- <td valign="top">Complete path to the <code>rmic</code>
- executable to use in case of the <code>forking</code>
- or <code>xnew</code> compiler.
- Defaults to the rmic compiler of the Java version that is currently
- running Ant.<br/>
- <em>Since Ant 1.8.0</em>.</td>
- <td align="center" valign="top">No</td>
+ <td>executable</td>
+ <td>Complete path to the <code>rmic</code> executable to use in case of the <q>forking</q>
+ or <q>xnew</q> compiler. <em>Since Ant 1.8.0</em>.</td>
+ <td>No; defaults to the <code>rmic</code> compiler of JDK that is currently running Ant</td>
</tr>
<tr>
- <td valign="top">listfiles</td>
- <td valign="top">Indicates whether the source files to be compiled will
- be listed; defaults to <code>no</code>.<br/>
- <em>Since Ant 1.8.0</em>.</td>
- <td align="center" valign="top">No</td>
+ <td>listfiles</td>
+ <td>Indicates whether the source files to be compiled will be listed. <em>Since Ant
+ 1.8.0</em>.</td>
+ <td>No; defaults to <q>no</q></td>
</tr>
</table>
-<p id="footnote-1">*1:</p>
+<p id="footnote-1"><a href="#1">Note</a>:</p>
<ul>
- <li>Maintaining compatibility, <code>base</code>, when specified by
- itself, serves as both the parent directory for any source files
- AND the output directory.</li>
- <li><code>destdir</code> can be used to specify the output
- directory, allowing for <code>base</code> to be used as the parent
- directory for any source files.</li>
- <li>At least one of either <code>base</code> or <code>destdir</code>
- must be specified and exist, or a runtime error will
- occur.</li>
+ <li>Maintaining compatibility, <var>base</var>, when specified by itself, serves as both the
+ parent directory for any source files AND the output directory.</li>
+ <li><var>destdir</var> can be used to specify the output directory, allowing for <var>base</var>
+ to be used as the parent directory for any source files.</li>
+ <li>At least one of either <var>base</var> or <var>destdir</var> must be specified and exist, or a
+ runtime error will occur.</li>
</ul>
<h3>Parameters specified as nested elements</h3>
<h4>classpath and extdirs</h4>
-<p><code>Rmic</code>'s <i>classpath</i> and <i>extdirs</i> attributes are <a
-href="../using.html#path">PATH like structure</a> and can also be set via a nested
-<i>classpath</i> and <i>extdirs</i> elements.</p>
+<p><code>Rmic</code>'s <var>classpath</var> and <var>extdirs</var> attributes
+are <a href="../using.html#path">path-like structure</a> and can also be set via a nested
+<code>classpath</code> and <code>extdirs</code> elements.</p>
<h4>compilerarg</h4>
-<p>You can specify additional command line arguments for the compiler
-with nested <code><compilerarg></code> elements. These elements
-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>
+<p>You can specify additional command line arguments for the compiler with
+nested <code><compilerarg></code> elements. These elements 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 class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">value</td>
- <td align="center" rowspan="4">See
- <a href="../using.html#arg">Command-line Arguments</a>.</td>
- <td align="center" rowspan="4">Exactly one of these</td>
+ <td>value</td>
+ <td rowspan="4">See <a href="../using.html#arg">Command-line Arguments</a>.</td>
+ <td rowspan="4">Exactly one of these</td>
</tr>
<tr>
- <td valign="top">line</td>
+ <td class="var">line</td>
</tr>
<tr>
- <td valign="top">file</td>
+ <td class="var">file</td>
</tr>
<tr>
- <td valign="top">path</td>
+ <td class="var">path</td>
</tr>
<tr>
- <td valign="top">prefix</td>
- <td align="center" rowspan="2">See
+ <td>prefix</td>
+ <td rowspan="2">See
<a href="../using.html#arg">Command-line Arguments</a>.
<em>Since Ant 1.8</em>.</td>
- <td valign="top" align="center">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">suffix</td>
- <td valign="top" align="center">No</td>
+ <td>suffix</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">compiler</td>
- <td>Only pass the specified argument if the chosen
- compiler implementation matches the value of this attribute.
- Legal values are the
- same as those in the above <a href="#compilervalues">list</a> of valid
- compilers.)</td>
- <td align="center">No</td>
+ <td>compiler</td>
+ <td>Only pass the specified argument if the chosen compiler implementation matches the value of
+ this attribute. Legal values are the same as those in the
+ above <a href="#compilervalues">list</a> of valid compilers.)</td>
+ <td>No</td>
</tr>
</table>
<h4>compilerclasspath (<em>since Ant 1.8.0</em>)</h4>
-<p>A <a href="../using.html#path">PATH like structure</a> holding the
- classpath to use when loading the compiler implementation if a
- custom class has been specified. Doesn't have any effect when
- using one of the built-in compilers.</p>
+<p>A <a href="../using.html#path">path-like structure</a> holding the classpath to use when loading
+the compiler implementation if a custom class has been specified. Doesn't have any effect when
+using one of the built-in compilers.</p>
-<h4>Any nested element of a type that implements RmicAdapter
- (<em>since Ant 1.8.0</em>)</h4>
+<h4>Any nested element of a type that implements RmicAdapter (<em>since Ant 1.8.0</em>)</h4>
-<p>If a defined type implements the <code>RmicAdapter</code>
- interface a nested element of that type can be used as an
- alternative to the <code>compiler</code> attribute.</p>
+<p>If a defined type implements the <code>RmicAdapter</code> interface a nested element of that type
+can be used as an alternative to the <var>compiler</var> attribute.</p>
<h3>Examples</h3>
-<pre> <rmic classname="com.xyz.FooBar" base="${build}/classes"/></pre>
-<p>runs the rmic compiler for the class <code>com.xyz.FooBar</code>. The
-compiled files will be stored in the directory <code>${build}/classes</code>.</p>
-<pre> <rmic base="${build}/classes" includes="**/Remote*.class"/></pre>
-<p>runs the rmic compiler for all classes with <code>.class</code>
-files below <code>${build}/classes</code> whose classname starts with
-<i>Remote</i>. The compiled files will be stored in the directory
-<code>${build}/classes</code>.</p>
+<pre><rmic classname="com.xyz.FooBar" base="${build}/classes"/></pre>
+<p>runs the <code>rmic</code> compiler for the class <code>com.xyz.FooBar</code>. The compiled files
+will be stored in the directory <samp>${build}/classes</samp>.</p>
+<pre><rmic base="${build}/classes" includes="**/Remote*.class"/></pre>
+<p>runs the <code>rmic</code> compiler for all classes with <samp>.class</samp> files
+below <samp>${build}/classes</samp> whose classname starts with <code>Remote</code>. The compiled
+files will be stored in the directory <samp>${build}/classes</samp>.</p>
-<p>If you want to use a custom
- RmicAdapter <code>org.example.MyAdapter</code> you can either
- use the compiler attribute:</p>
+<p>If you want to use a custom RmicAdapter <code>org.example.MyAdapter</code> you can either use
+the <var>compiler</var> attribute:</p>
<pre>
<rmic classname="com.xyz.FooBar"
base="${build}/classes"
- compiler="org.example.MyAdapter"/>
-</pre>
+ compiler="org.example.MyAdapter"/></pre>
<p>or a define a type and nest this into the task like in:</p>
<pre>
<componentdef classname="org.example.MyAdapter"
@@ -342,10 +309,8 @@ files below <code>${build}/classes</code> whose classname starts with
<rmic classname="com.xyz.FooBar"
base="${build}/classes">
<myadapter/>
-</rmic>
-</pre>
-<p>in which case your compiler adapter can support attributes and
- nested elements of its own.</p>
+</rmic></pre>
+<p>in which case your compiler adapter can support attributes and nested elements of its own.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/rpm.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/rpm.html b/manual/Tasks/rpm.html
index c430f62..158f121 100644
--- a/manual/Tasks/rpm.html
+++ b/manual/Tasks/rpm.html
@@ -26,97 +26,84 @@
<h2 id="rpm">Rpm</h2>
<h3>Description</h3>
-<p>
- A basic task for invoking the rpm executable to build a RedHat Package Manager Linux installation
- file. The task currently only works on Linux or other Unix platforms with rpm support.
-</p>
+<p> A basic task for invoking the <code>rpm</code> executable to build a RedHat Package Manager
+Linux installation file. The task currently only works on Linux or other Unix platforms
+with <code>rpm</code> support.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">specFile</td>
- <td valign="top">The name of the spec file to be used. This must be relative to the SPECS directory
- under the root of the RPM set in the topDir attribute.</td>
- <td valign="top" align="center">Yes</td>
+ <td>specFile</td>
+ <td>The name of the spec file to be used. This must be relative to the <samp>SPECS</samp>
+ directory under the root of the RPM set in the <var>topDir</var> attribute.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">topDir</td>
- <td valign="top">
- This is the directory which will have the expected
- subdirectories, SPECS, SOURCES, BUILD, SRPMS. If this isn't specified,
- the default RPM directory of the system (or user, if ~/.rpmmacros defines it) is used (often
- /usr/src/rpm.<br>
- Defining a topdir will set <tt>%_topdir</tt> to the specified directory -there is no need
- to edit your .rpmmacros file.
- </td>
- <td valign="top" align="center">No, but your build file is very brittle if it is not set.</td>
+ <td>topDir</td>
+ <td>This is the directory which will have the expected
+ subdirectories, <samp>SPECS</samp>, <samp>SOURCES</samp>, <samp>BUILD</samp>, <samp>SRPMS</samp>.
+ If this isn't specified, the default RPM directory of the system (or user,
+ if <samp>~/.rpmmacros</samp> defines it) is used (often <samp>/usr/src/rpm</samp>.<br>
+ Defining a <var>topdir</var> will set <code>%_topdir</code> to the specified
+ directory—there is no need to edit your <samp>.rpmmacros</samp> file.</td>
+ <td>No, but your build file is very brittle if it is not set.</td>
</tr>
<tr>
- <td valign="top">cleanBuildDir</td>
- <td valign="top">This will remove the generated files in the BUILD
- directory.
- See the the <tt>--clean</tt> option of rpmbuild.
- </td>
- <td align="center" valign="top">No</td>
+ <td>cleanBuildDir</td>
+ <td>This will remove the generated files in the <samp>BUILD</samp> directory. See the
+ the <code>--clean</code> option of rpmbuild.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">removeSpec</td>
- <td valign="top">This will remove the spec file from SPECS.
- See the the <tt>--rmspec</tt> option of rpmbuild.
- </td>
- <td align="center" valign="top">No</td>
+ <td>removeSpec</td>
+ <td>This will remove the spec file from <samp>SPECS</samp>. See the the <code>--rmspec</code>
+ option of <code>rpmbuild</code>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">removeSource</td>
- <td valign="top">Flag (optional, default=false)
- to remove the sources after the build.
- See the the <tt>--rmsource</tt> option of rpmbuild.</td>
- <td align="center" valign="top">No</td>
+ <td>removeSource</td>
+ <td>Flag to remove the sources after the build. See the <code>--rmsource</code> option
+ of <code>rpmbuild</code>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">rpmBuildCommand</td>
- <td valign="top">The executable to use for building the RPM.
- Defaults to <code>rpmbuild</code> if it can be found or
- <code>rpm</code> otherwise. Set this if you don't have either on
- your PATH or want to use a different executable. <em>Since Apache Ant
- 1.6</em>.</td>
- <td valign="top" align="center">No</td>
+ <td>rpmBuildCommand</td>
+ <td>The executable to use for building the RPM. Set this if default executables are not on
+ <code>PATH</code> or a different executable is needed. <em>Since Apache Ant 1.6</em>.</td>
+ <td>No; defaults to <code>rpmbuild</code> if it can be found or <code>rpm</code> otherwise</td>
</tr>
<tr>
- <td valign="top">command</td>
- <td valign="top">The command to pass to the rpmbuild program. The default is "-bb"</td>
- <td align="center" valign="top">No</td>
+ <td>command</td>
+ <td>The command to pass to the <code>rpmbuild</code> program.</td>
+ <td>No; default is <code>-bb</code></td>
</tr>
<tr>
- <td valign="top">quiet</td>
- <td valign="top">Suppress output. Defaults to false.</td>
- <td align="center" valign="top">No</td>
+ <td>quiet</td>
+ <td>Suppress output.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">output/error</td>
- <td valign="top">Where standard output and error go</td>
- <td align="center" valign="top">No</td>
+ <td>output/error</td>
+ <td>Where standard output and error go.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">failOnError</td>
- <td valign="top">Stop the buildprocess if the RPM build command exits with
- a non-zero returncode. Defaults to false</td>
- <td align="center" valign="top">No</td>
+ <td>failOnError</td>
+ <td>Stop the build process if the RPM build command exits with a non-zero return code.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
</table>
<h3>Examples</h3>
<pre>
- <rpm
- specFile="example.spec"
- topDir="build/rpm"
- cleanBuildDir="true"
- failOnError="true"/>
-</pre>
+<rpm specFile="example.spec"
+ topDir="build/rpm"
+ cleanBuildDir="true"
+ failOnError="true"/></pre>
</body>
</html>