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:02:01 UTC
[46/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/apply.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/apply.html b/manual/Tasks/apply.html
index 0ed8879..c9f59a9 100644
--- a/manual/Tasks/apply.html
+++ b/manual/Tasks/apply.html
@@ -24,380 +24,327 @@
<body>
-<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>
+<h2 id="apply">Apply</h2>
+<p><em>The name <code>execon</code> is <u>deprecated</u> and only kept for backwards
+compatibility.</em></p>
<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
-systems.</p>
+<p>Executes a system command. When the <var>os</var> attribute is specified, then the command is
+only executed when Apache Ant is run on one of the specified operating systems.</p>
-<p>The files and/or directories of a number of <a
-href="../Types/resources.html#collection">Resource Collection</a>s
-– including but not restricted to
- <a href="../Types/fileset.html">FileSet</a>s,
- <a href="../Types/dirset.html">DirSet</a>s
- (<em>since Ant 1.6</em>) or
- <a href="../Types/filelist.html">FileList</a>s
- (<em>since Ant 1.6</em>)
-– 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
-for in the given <i>dest</i>, if specified.</p>
-<p>At least one fileset or filelist is required,
-and you must not specify more than one mapper.</p>
+<p>The files and/or directories of a number of <a href="../Types/resources.html#collection">Resource
+Collection</a>s –- including but not restricted
+to <a href="../Types/fileset.html">FileSet</a>s, <a href="../Types/dirset.html">DirSet</a>s
+(<em>since Ant 1.6</em>) or <a href="../Types/filelist.html">FileList</a>s (<em>since Ant 1.6</em>)
+–- 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 <code>mapper</code> element and searched for in the given <var>dest</var>, if specified.</p>
+<p>At least one <code>fileset</code> or <code>filelist</code> is required, and you must not specify
+more than one <code>mapper</code>.</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>
+<p>Note that you cannot interact with the forked program, the only way to send input to it is via
+the <var>input</var> and <var>inputstring</var> attributes.</p>
-<h4 id="background">Running Ant as a background process on
- Unix(-like) systems</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><apply></code> task with <code>spawn</code>
- set to <code>false</code>, you must provide explicit input to the
- forked process or Ant will be suspended because it tries to read
- from the standard input.</p>
+<p>If you run Ant as a background process (like <code>ant &</code>) and use
+the <code><apply></code> task with <var>spawn</var> set to <q>false</q>, you must provide
+explicit input to the forked process or Ant will be suspended because it tries to read from the
+standard input.</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">executable</td>
- <td valign="top">the command to execute without any command line
- arguments.</td>
- <td align="center" valign="top">Yes</td>
+ <td>executable</td>
+ <td>the command to execute without any command line arguments.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">dest</td>
- <td valign="top">the directory where the command is expected to place
- target files when it is executed. This attribute is valid only when used
- in conjunction with a nested mapper; if omitted, the target filenames
- returned by the mapper will be interpreted as absolute paths.</td>
- <td align="center" valign="top">No</td>
+ <td>dest</td>
+ <td>the directory where the command is expected to place target files when it is executed.</td>
+ <td>No; ignored unless a nested mapper is specified; by default, the target filenames returned
+ by the mapper will be interpreted as absolute paths</td>
</tr>
<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>
- The input, output, error, and result property settings are not active when spawning a process.<br>
- <em>since Ant 1.6</em>
- </td>
- <td align="center" valign="top">No, default is <i>false</i></td>
+ <td>spawn</td>
+ <td>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/> The input, output, error, and result property settings are not
+ active when spawning a process.<br/> <em>since Ant 1.6</em></td>
+ <td>No; default is <q>false</q></td>
</tr>
-
<tr>
- <td valign="top">dir</td>
- <td valign="top">the directory in which the command should be executed.</td>
- <td align="center" valign="top">No.<br/>
- <strong>Note</strong>: the default used when dir has not been
- specified depends on the <code>vmlauncher</code> attribute. If
- <code>vmlauncher</code> is <code>true</code> the task will use
- the current working directory, otherwise it uses the project's basedir.
- </td>
+ <td>dir</td>
+ <td>the directory in which the command should be executed.</td>
+ <td>No; if <var>vmlauncher</var> is <q>true</q>, defaults to the current working directory,
+ otherwise the project's <var>basedir</var></td>
</tr>
<tr>
- <td valign="top">relative</td>
- <td valign="top">whether the filenames should be passed on the
- command line as relative pathnames (relative to the base directory
- of the corresponding fileset/list for source files or the
- <i>dest</i> attribute for target files).</td>
- <td align="center" valign="top">No, default is <i>false</i></td>
+ <td>relative</td>
+ <td>whether the filenames should be passed on the command line as relative pathnames (relative
+ to the base directory of the corresponding fileset/list for source files or
+ the <var>dest</var> attribute for target files).</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">forwardslash</td>
- <td valign="top">whether the file names should be passed
- with forward slashes even if the operating system requires other
- file separator. The option is ignored if the system file separator
- is a forward slash.</td>
- <td align="center" valign="top">No, default is <i>false</i></td>
+ <td>forwardslash</td>
+ <td>whether the file names should be passed with forward slashes even if the operating system
+ requires other file separator. The option is ignored if the system file separator is a forward
+ slash.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">os</td>
- <td valign="top">list of Operating Systems on which the command may be
- executed.</td>
- <td align="center" valign="top">No</td>
+ <td>os</td>
+ <td>list of Operating Systems on which the command may be executed.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">osfamily</td>
- <td valign="top">OS family as used in the <os> condition.
+ <td>osfamily</td>
+ <td>OS family as used in the <code><os></code> condition.
<em>since Ant 1.7</em></td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">output</td>
- <td valign="top">the file to which the output of the command
- should be redirected. If the error stream is not also redirected
- to a file or property, it will appear in this output.</td>
- <td align="center" valign="top">No</td>
+ <td>output</td>
+ <td>the file to which the output of the command should be redirected. If the error stream is
+ not also redirected to a file or property, it will appear in this output.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">error</td>
- <td valign="top">The file to which the standard error of the
- command should be redirected. <em>since Ant 1.6</em></td>
- <td align="center" valign="top">No</td>
+ <td>error</td>
+ <td>The file to which the standard error of the command should be redirected. <em>since Ant
+ 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">logError</td>
- <td valign="top">This attribute is used when you wish to see error
- output in Ant's log and you are redirecting output to a
- file/property. The error output will not be included in the output
- file/property. If you redirect error with the "error" or
- "errorProperty" attributes, this will have no effect.
- <em>since Ant 1.6</em></td>
- <td align="center" valign="top">No</td>
+ <td>logError</td>
+ <td>This attribute is used when you wish to see error output in Ant's log and you are
+ redirecting output to a file/property. The error output will not be included in the output
+ file/property. If you redirect error with the <var>error</var> or <var>errorProperty</var>
+ attributes, this will have no effect. <em>since Ant 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">append</td>
- <td valign="top">whether output should be appended to or overwrite
- an existing file. If you set parallel to false, you will probably
- want to set this one to true.</td>
- <td align="center" valign="top">No, default is <i>false</i></td>
+ <td>append</td>
+ <td>whether output should be appended to or overwrite an existing file. If you
+ set <var>parallel</var> to <q>false</q>, you will probably want to set this one
+ to <q>true</q>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">outputproperty</td>
- <td valign="top">the name of a property in which the output of the
- command should be stored. Unless the error stream is redirected
- to a separate file or stream, this property will include the error
+ <td>outputproperty</td>
+ <td>the name of a property in which the output of the command should be stored. Unless the
+ error stream is redirected to a separate file or stream, this property will include the error
output.</td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">errorproperty</td>
- <td valign="top">The name of a property in which the standard error of the
- command should be stored. <em>since Ant 1.6</em></td>
- <td align="center" valign="top">No</td>
+ <td>errorproperty</td>
+ <td>The name of a property in which the standard error of the command should be
+ stored. <em>since Ant 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">input</td>
- <td valign="top">A file from which the executed command's standard
- input is taken. This attribute is mutually exclusive with the
- inputstring attribute. <em>since Ant 1.6</em></td>
- <td align="center" valign="top">No</td>
+ <td>input</td>
+ <td>A file from which the executed command's standard input is taken. This attribute is mutually
+ exclusive with the <var>inputstring</var> attribute. <em>since Ant 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">inputstring</td>
- <td valign="top">A string which serves as the input stream for the
- executed command. This attribute is mutually exclusive with the
- input attribute. <em>since Ant 1.6</em></td>
- <td align="center" valign="top">No</td>
+ <td>inputstring</td>
+ <td>A string which serves as the input stream for the executed command. This attribute is
+ mutually exclusive with the <var>input</var> attribute. <em>since Ant 1.6</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">resultproperty</td>
- <td valign="top">the name of a property in which the return code
- of the command should be stored. Only of interest if
- failonerror=false. If you set parallel to false, only the result
- of the first execution will be stored.</td>
- <td align="center" valign="top">No</td>
+ <td>resultproperty</td>
+ <td>the name of a property in which the return code of the command should be stored. Only of
+ interest if <var>failonerror</var> is <q>false</q>. If you set <var>parallel</var>
+ to <q>false</q>, only the result of the first execution will be stored.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">timeout</td>
- <td valign="top">Stop the command if it doesn't finish within the
- specified time (given in milliseconds).</td>
- <td align="center" valign="top">No</td>
+ <td>timeout</td>
+ <td>Stop the command if it doesn't finish within the specified time (given in
+ milliseconds).</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">Stop the buildprocess if the command exits with a
- returncode other than 0.</td>
- <td align="center" valign="top">No</td>
+ <td>failonerror</td>
+ <td>Stop the build process if the command exits with a return code other than 0.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">failifexecutionfails</td>
- <td valign="top">Stop the build if we can't start the program.
- Defaults to true.</td>
- <td align="center" valign="top">No</td>
+ <td>failifexecutionfails</td>
+ <td>Stop the build if we can't start the program.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">skipemptyfilesets</td>
- <td valign="top">Don't run the command, if no source files have
- been found or are newer than their corresponding target
- files. Despite its name, this attribute applies to filelists as
+ <td>skipemptyfilesets</td>
+ <td>Don't run the command, if no source files have been found or are newer than their
+ corresponding target files. Despite its name, this attribute applies to filelists as
well.</td>
- <td align="center" valign="top">No, default is <i>false</i></td>
- </tr>
- <tr>
- <td valign="top">parallel</td>
- <td valign="top">Run the command only once, appending all files as
- arguments. If false, command will be executed once for every file.</td>
- <td align="center" valign="top">No, default is <i>false</i></td>
- </tr>
- <tr>
- <td valign="top">type</td>
- <td valign="top">One of <i>file</i>, <i>dir</i> or
- <i>both</i>. If set to <i>file</i>, only the names of plain
- files will be sent to the command. If set to <i>dir</i>, only
- the names of directories are considered.<br>
- <strong>Note</strong>: The type attribute does not apply to
- nested <i>dirset</i>s - <i>dirset</i>s always implicitly
- assume type to be <i>dir</i>.</td>
- <td align="center" valign="top">No, default is <i>file</i></td>
- </tr>
- <tr>
- <td valign="top">newenvironment</td>
- <td valign="top">Do not propagate old environment when new environment
- variables are specified.</td>
- <td align="center" valign="top">No, default is <i>false</i></td>
- </tr>
- <tr>
- <td valign="top">vmlauncher</td>
- <td valign="top">Run command using the Java VM's execution facilities
- where available. If set to false the underlying OS's shell,
- either directly or through the antRun scripts, will be used.
- Under some operating systems, this gives access to facilities
- not normally available through the VM including, under Windows,
- being able to execute scripts, rather than their associated
- interpreter. If you want to specify the name of the
- executable as a relative path to the directory given by the
- dir attribute, it may become necessary to set vmlauncher to
- false as well.</td>
- <td align="center" valign="top">No, default is <i>true</i></td>
- </tr>
- <tr>
- <td valign="top">resolveExecutable</td>
- <td valign="top">When this attribute is true, the name of the
- executable if resolved firstly against the project basedir and if
- that does not exist, against the execution directory if
- specified. On Unix systems, if you only want to allow execution of
- commands in the user's path, set this to false.
+ <td>No; default is <q>false</q></td>
+ </tr>
+ <tr>
+ <td>parallel</td>
+ <td>Run the command only once, appending all files as arguments. If <q>false</q>, command will
+ be executed once for every file.</td>
+ <td>No; default is <q>false</q></td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>One of <q>file</q>, <q>dir</q> or <q>both</q>. If set to <q>file</q>, only the names of
+ plain files will be sent to the command. If set to <q>dir</q>, only the names of directories
+ are considered.<br>
+ <strong>Note</strong>: The <var>type</var> attribute does not apply to
+ nested <code>dirset</code>s—<code>dirset</code>s always implicitly assume type to
+ be <q>dir</q>.</td>
+ <td>No; default is <q>file</q></td>
+ </tr>
+ <tr>
+ <td>newenvironment</td>
+ <td>Do not propagate old environment when new environment variables are specified.</td>
+ <td>No; default is <q>false</q></td>
+ </tr>
+ <tr>
+ <td>vmlauncher</td>
+ <td>Run command using the JVM's execution facilities where available. If set to <q>false</q> the
+ underlying OS's shell, either directly or through the <code>antRun</code> scripts, will be
+ used. Under some operating systems, this gives access to facilities not normally available
+ through JVM including, under Windows, being able to execute scripts, rather than their
+ associated interpreter. If you want to specify the name of the executable as a relative path
+ to the directory given by the <var>dir</var> attribute, it may become necessary to
+ set <var>vmlauncher</var> to <q>false</q> as well.</td>
+ <td>No; default is <q>true</q></td>
+ </tr>
+ <tr>
+ <td>resolveExecutable</td>
+ <td>When this attribute is <q>true</q>, the name of the executable if resolved firstly against
+ the project <var>basedir</var> and if that does not exist, against the execution directory if
+ specified. On Unix systems, if you only want to allow execution of commands in the user's
+ path, set this to <q>false</q>.
<em>since Ant 1.6</em></td>
- <td align="center" valign="top">No, default is <i>false</i></td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">maxparallel</td>
- <td valign="top">Limit the amount of parallelism by passing at
- most this many sourcefiles at once. Set it to <= 0 for
- unlimited. <em>Since Ant 1.6</em>.</td>
- <td align="center" valign="top">No, unlimited by default</td>
+ <td>maxparallel</td>
+ <td>Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to
+ negative integer for unlimited. <em>Since Ant 1.6</em>.</td>
+ <td>No, unlimited by default</td>
</tr>
<tr>
- <td valign="top">addsourcefile</td>
- <td valign="top">Whether source file names should be added to the
- command automatically. <em>Since Ant 1.6</em>.</td>
- <td align="center" valign="top">No, default is <i>true</i></td>
+ <td>addsourcefile</td>
+ <td>Whether source file names should be added to the command automatically. <em>Since Ant
+ 1.6</em>.</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">Whether to print a summary after execution or not.
- <em>Since Ant 1.6</em>.</td>
- <td align="center" valign="top">No, default <i>false</i></td>
+ <td>verbose</td>
+ <td>Whether to print a summary after execution or not. <em>Since Ant 1.6</em>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">ignoremissing</td>
- <td valign="top">Whether to ignore nonexistent files specified
- via filelists. <em>Since Ant 1.6.2</em>.</td>
- <td align="center" valign="top">No, default is <i>true</i></td>
+ <td>ignoremissing</td>
+ <td>Whether to ignore nonexistent files specified via filelists. <em>Since Ant 1.6.2</em>.</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">force</td>
- <td valign="top">Whether to bypass timestamp comparisons
- for target files. <em>Since Ant 1.6.3</em>.</td>
- <td align="center" valign="top">No, default is <i>false</i></td>
+ <td>force</td>
+ <td>Whether to bypass timestamp comparisons for target files. <em>Since Ant 1.6.3</em>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>fileset</h4>
-<p>You can use any number of nested <code><fileset></code>
-elements to define the files for this task and refer to
-<code><fileset></code>s defined elsewhere.</p>
+<p>You can use any number of nested <code><fileset></code> elements to define the files for
+this task and refer to <code><fileset></code>s defined elsewhere.</p>
<h4>filelist</h4>
<p><em>Since Ant 1.6</em></p>
-<p>You can use any number of nested <code><filelist></code>
-elements to define the files for this task and refer to
-<code><filelist></code>s defined elsewhere.</p>
+<p>You can use any number of nested <code><filelist></code> elements to define the files for
+this task and refer to <code><filelist></code>s defined elsewhere.</p>
<h4>dirset</h4>
<p><em>Since Ant 1.6</em></p>
-<p>You can use any number of nested <code><dirset></code>
-elements to define the directories for this task and refer to
-<code><dirset></code>s defined elsewhere.</p>
+<p>You can use any number of nested <code><dirset></code> elements to define the directories
+for this task and refer to <code><dirset></code>s defined elsewhere.</p>
-<h4>Any other <a href="../Types/resources.html#collection">Resource
-Collection</a></h4>
+<h4>Any other <a href="../Types/resources.html#collection">Resource Collection</a></h4>
<p><em>since Ant 1.7</em></p>
<p>You can use any number of nested resource collections.</p>
<h4>mapper</h4>
-<p>A single <code><mapper></code> specifies the target files relative
-to the <code>dest</code> attribute for dependency checking. If the
-<code>dest</code> attribute is specified it will be used as a base directory
-for resolving relative pathnames returned by the mapper. At least one
+<p>A single <code><mapper></code> specifies the target files relative to the <var>dest</var>
+attribute for dependency checking. If the <var>dest</var> attribute is specified it will be used as
+a base directory for resolving relative pathnames returned by the mapper. At least one
<code><fileset></code> or <code><filelist></code> is required.</p>
<h4>arg</h4>
-<p>Command line arguments should be specified as nested
-<code><arg></code> elements. See <a
-href="../using.html#arg">Command line arguments</a>.</p>
+<p>Command line arguments should be specified as nested <code><arg></code>
+elements. See <a href="../using.html#arg">Command line arguments</a>.</p>
<h4>srcfile</h4>
-<p>By default the file names of the source files will be added to the
-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><srcfile></code> element between your
-<code><arg></code> elements to mark the insertion point.</p>
-<table>
+<p>By default the file names of the source files will be added to the end of the command line
+(unless you set addsourcefile to <q>false</q>). If you need to place it somewhere different, use a
+nested <code><srcfile></code> element between your <code><arg></code> elements to mark
+the insertion point.</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">prefix</td>
- <td valign="top">a prefix to place in front of the file name when
- building the command line argument. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No.</td>
+ <td>prefix</td>
+ <td>a prefix to place in front of the file name when building the command line
+ argument. <em>Since Ant 1.8.0</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">suffix</td>
- <td valign="top">a suffix to append to the file name when
- building the command line argument. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No.</td>
+ <td>suffix</td>
+ <td>a suffix to append to the file name when building the command line argument. <em>Since Ant
+ 1.8.0</em></td>
+ <td>No</td>
</tr>
</table>
<h4>targetfile</h4>
-<p><code><targetfile></code> is similar to
-<code><srcfile></code> and marks the position of the target
-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>
+<p><code><targetfile></code> is similar to <code><srcfile></code> and marks the position
+of the target 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 class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">prefix</td>
- <td valign="top">a prefix to place in front of the file name when
- building the command line argument. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No.</td>
+ <td>prefix</td>
+ <td>a prefix to place in front of the file name when building the command line
+ argument. <em>Since Ant 1.8.0</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">suffix</td>
- <td valign="top">a suffix to append to the file name when
- building the command line argument. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No.</td>
+ <td>suffix</td>
+ <td>a suffix to append to the file name when building the command line argument. <em>Since Ant
+ 1.8.0</em></td>
+ <td>No</td>
</tr>
</table>
<h4>env</h4>
-<p>It is possible to specify environment variables to pass to the
-system command via nested <code><env></code> elements. See the
-description in the section about <a href="exec.html#env">exec</a></p>
+<p>It is possible to specify environment variables to pass to the system command via
+nested <code><env></code> elements. See the description in the section
+about <a href="exec.html#env">exec</a></p>
<h4>redirector</h4>
<em>Since Ant 1.6.2</em>
-<p>A nested <a href="../Types/redirector.html">I/O Redirector</a>
-can be specified. <apply>'s behavior is like that of
-<a href="exec.html#redirector">exec</a> with regard to
-redirectors, with the exception that, in non-<i>parallel</i> mode,
-file mapping will take place with each iteration. This grants the
-user the capacity to receive input from, and send output to, different
-files for each sourcefile.
-</p>
-<p>In <i>parallel</i>-mode the redirector will be reset for each batch
- of executions (with <i>maxparallel</i> > 0) and null will be used
- a source file just like it is in the case of <code>exec</code>.</p>
+<p>A nested <a href="../Types/redirector.html">I/O Redirector</a> can be specified. <apply>'s
+behavior is like that of <a href="exec.html#redirector">exec</a> with regard to redirectors, with
+the exception that, in non-<var>parallel</var> mode, file mapping will take place with each
+iteration. This grants the user the capacity to receive input from, and send output to, different
+files for each sourcefile.</p>
+<p>In <var>parallel</var> mode the redirector will be reset for each batch of executions
+(with <var>maxparallel</var> > 0) and null will be used a source file just like it is in the case
+of <code>exec</code>.</p>
<h3>Examples</h3>
<pre>
<apply executable="ls">
@@ -408,12 +355,10 @@ files for each sourcefile.
</patternset>
</fileset>
<fileset refid="other.files"/>
-</apply>
-</pre>
-<p>invokes <code>ls -l</code>, adding the absolute filenames of all
-files below <code>/tmp</code> not ending in <code>.txt</code> and all
-files of the FileSet with <code>id</code> <code>other.files</code> to
-the command line.</p>
+</apply></pre>
+<p>invokes <code>ls -l</code>, adding the absolute filenames of all files below <samp>/tmp</samp>
+not ending in <samp>.txt</samp> and all files of the FileSet
+with <var>id</var> <samp>other.files</samp> to the command line.</p>
<pre>
<apply executable="somecommand" parallel="false">
<arg value="arg1"/>
@@ -422,11 +367,10 @@ the command line.</p>
<fileset dir="/tmp"/>
</apply>
</pre>
-<p>invokes <code>somecommand arg1 SOURCEFILENAME arg2</code> for each
-file in <code>/tmp</code> replacing SOURCEFILENAME with the absolute
-filename of each file in turn. If <code>parallel</code> had been set
-to true, SOURCEFILENAME would be replaced with the absolute filenames
-of all files separated by spaces.</p>
+<p>invokes <code>somecommand arg1 SOURCEFILENAME arg2</code> for each file in <samp>/tmp</samp>
+replacing <code>SOURCEFILENAME</code> with the absolute filename of each file in
+turn. If <var>parallel</var> had been set to true, <code>SOURCEFILENAME</code> would be replaced
+with the absolute filenames of all files separated by spaces.</p>
<pre>
<apply executable="cc" dest="src/C" parallel="false">
<arg value="-c"/>
@@ -435,13 +379,11 @@ of all files separated by spaces.</p>
<srcfile/>
<fileset dir="src/C" includes="*.c"/>
<mapper type="glob" from="*.c" to="*.o"/>
-</apply>
-</pre>
-<p>invokes <code>cc -c -o TARGETFILE SOURCEFILE</code> for each
-<code>.c</code> file that is newer than the corresponding
-<code>.o</code>, replacing TARGETFILE with the absolute filename of
-the <code>.o</code> and SOURCEFILE with the absolute name of the
-<code>.c</code> file.</p>
+</apply></pre>
+<p>invokes <code>cc -c -o TARGETFILE SOURCEFILE</code> for each <samp>.c</samp> file that is newer
+than the corresponding <samp>.o</samp>, replacing <code>TARGETFILE</code> with the absolute filename
+of the <samp>.o</samp> and <code>SOURCEFILE</code> with the absolute name of the <samp>.c</samp>
+file.</p>
<pre>
<mapper id="out" type="glob"
from="src${file.separator}*.file"
@@ -453,17 +395,15 @@ the <code>.o</code> and SOURCEFILE with the absolute name of the
<redirector>
<outputmapper refid="out"/>
</redirector>
-</apply>
-</pre>
-Applies the fictitious "processfile" executable to all
-files matching <code>*.file</code> in the <code>src</code> directory.
-The <code>out</code> <code><mapper></code> has been set up to map
-<code>*.file</code> to <code>*.out</code>, then this <code><mapper></code>
-is used to specify <code>targetfile</code>s for this <apply>
-task. A reference to <code>out</code> is then used as an
-<code><outputmapper></code> nested in a <code><redirector></code>, which in turn is
-nested beneath this <code><apply></code> instance. This allows us to perform
-dependency checking against output files--the target files in this case.
+</apply></pre>
+<p>Applies the fictitious <code>processfile</code> executable to all files
+matching <samp>*.file</samp> in the <samp>src</samp> directory.
+The <samp>out</samp> <code><mapper></code> has been set up to map <samp>*.file</samp>
+to <samp>*.out</samp>, then this <code><mapper></code> is used to
+specify <code>targetfile</code>s for this <apply> task. A reference to <samp>out</samp> is
+then used as an <code><outputmapper></code> nested in a <code><redirector></code>, which
+in turn is nested beneath this <code><apply></code> instance. This allows us to perform
+dependency checking against output files—the target files in this case.</p>
<pre>
<apply executable="ls" parallel="true"
force="true" dest="${basedir}" append="true" type="both">
@@ -471,10 +411,9 @@ dependency checking against output files--the target files in this case.
<pathelement path="${env.PATH}"/>
</path>
<identitymapper/>
-</apply>
-</pre>
-Applies the "ls" executable to all directories in the PATH, effectively
-listing all executables that are available on the PATH.
+</apply></pre>
+<p>Applies the <code>ls</code> executable to all directories in the <code>PATH</code>, effectively
+listing all executables that are available on the <code>PATH</code>.</p>
<pre>
<apply executable="jsmin" addsourcefile="false">
@@ -487,12 +426,10 @@ listing all executables that are available on the PATH.
<!-- redirect STDOUT to file in dest-dir -->
<outputmapper id="out" type="glob" from="*.js" to="dest/*.js"/>
</redirector>
-</apply>
-</pre>
-Conversion of the command <code>jsmin < src/a.js > dest/a.js</code> but for
-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>.
+</apply></pre>
+<p>Conversion of the command <code>jsmin < src/a.js > dest/a.js</code> but for all files in
+the <samp>src</samp> directory. Because the filename itself should not be passed to
+the <code>jsmin</code> program, the <var>addsourcefile</var> is set to <q>false</q>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/attrib.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/attrib.html b/manual/Tasks/attrib.html
index dc8d734..79ea431 100644
--- a/manual/Tasks/attrib.html
+++ b/manual/Tasks/attrib.html
@@ -28,20 +28,18 @@
<p><em>Since Apache Ant 1.6</em>.</p>
<h3>Description</h3>
-<p>Changes the attributes of a file or all files inside specified
-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>Changes the attributes of a file or all files inside specified 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,
-<a href="../Types/dirset.html">DirSet</a>s or <a
-href="../Types/filelist.html">FileList</a>s can be specified using
-nested <code><fileset></code>, <code><dirset></code> and
-<code><filelist></code> elements.</p>
+<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><fileset></code>, <code><dirset></code> and <code><filelist></code>
+elements.</p>
-<p><em>Since Ant 1.7</em>, this task supports arbitrary <a
-href="../Types/resources.html#collection">Resource Collection</a>s
-as nested elements.</p>
+<p><em>Since Ant 1.7</em>, this task supports
+arbitrary <a href="../Types/resources.html#collection">Resource Collection</a>s as nested
+elements.</p>
<!--p>By default this task will use a single invocation of the underlying
attrib command. If you are working on a large number of files this
@@ -51,112 +49,107 @@ maxparallel attribute of this task to a non-zero value. The number to
use highly depends on the length of your file names (the depth of your
directory tree), so you'll have to experiment a little.</p-->
-<p>By default this task won't do anything unless it detects it is
- running on a Windows system. If you know for sure that you have a
- "attrib" executable on your PATH that is command line compatible with
- the Windows command, you can use the task's os attribute and set its
- value to your current os.</p>
+<p>By default this task won't do anything unless it detects it is running on a Windows system. If
+you know for sure that you have a <code>attrib</code> executable on your <code>PATH</code> that is
+command line compatible with the Windows command, you can use the task's <var>os</var> attribute and
+set its value to your current OS.</p>
-<p>See the <a href="setpermissions.html">setpermissions</a> task for a
- platform independent alternative.</p>
+<p>See the <a href="setpermissions.html">setpermissions</a> task for a platform independent
+alternative.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top" align="center"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">the file or directory of which the permissions must be
- changed.</td>
- <td valign="top" align="center">Yes, or nested
- <code><fileset/list></code> elements</td>
+ <td>file</td>
+ <td>the file or directory of which the permissions must be changed.</td>
+ <td>Yes, or nested <code><fileset/list></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>readonly</td>
+ <td>the readonly permission.</td>
+ <td rowspan="4">At least one of the four</td>
</tr>
<tr>
- <td valign="top">archive</td>
- <td valign="top">the archive permission.</td>
+ <td>archive</td>
+ <td class="left">the archive permission.</td>
</tr>
<tr>
- <td valign="top">system</td>
- <td valign="top">the system permission.</td>
+ <td>system</td>
+ <td class="left">the system permission.</td>
</tr>
<tr>
- <td valign="top">hidden</td>
- <td valign="top">the hidden permission.</td>
+ <td>hidden</td>
+ <td class="left">the hidden permission.</td>
</tr>
<tr>
- <td valign="top">type</td>
- <td valign="top">One of <i>file</i>, <i>dir</i> or <i>both</i>. If set to
- <i>file</i>, only the permissions of plain files are going to be changed.
- If set to <i>dir</i>, only the directories are considered.<br>
+ <td>type</td>
+ <td>One of <q>file</q>, <q>dir</q> or <q>both</q>. If set to <q>file</q>, only the permissions
+ of plain files are going to be changed. If set to <q>dir</q>, only the directories are
+ considered.<br/>
<strong>Note</strong>: The type attribute does not apply to
- nested <i>dirset</i>s - <i>dirset</i>s always implicitly
- assume type to be <i>dir</i>.</td>
- <td align="center" valign="top">No, default is <i>file</i></td>
+ nested <code>dirset</code>s—<code>dirset</code>s always implicitly assume type to
+ be <q>dir</q>.</td>
+ <td>No; default is <q>file</q></td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">Whether to print a summary after execution or not.
- Defaults to <code>false</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>verbose</td>
+ <td>Whether to print a summary after execution or not.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<!--tr>
- <td valign="top">parallel</td>
- <td valign="top">process all specified files using a single
- <code>chmod</code> command. Defaults to true.</td>
- <td valign="top" align="center">No</td>
+ <td>parallel</td>
+ <td>process all specified files using a single
+ <code>chmod</code> command.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">maxparallel</td>
- <td valign="top">Limit the amount of parallelism by passing at
- most this many sourcefiles at once. Set it to <= 0 for
- unlimited. Defaults to unlimited. <em>Since Ant 1.6</em>.</td>
- <td align="center" valign="top">No</td>
+ <td>maxparallel</td>
+ <td>Limit the amount of parallelism by passing at
+ most this many sourcefiles at once. Set it to negative integer for
+ unlimited. <em>Since Ant 1.6</em>.</td>
+ <td>No, defaults to unlimited</td>
</tr-->
<tr>
- <td valign="top">os</td>
- <td valign="top">list of Operating Systems on which the command may be
- executed.</td>
- <td align="center" valign="top">No</td>
+ <td>os</td>
+ <td>list of Operating Systems on which the command may be executed.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">osfamily</td>
- <td valign="top">OS family as used in
- the <a href="../Tasks/conditions.html#os"><os></a>
+ <td>osfamily</td>
+ <td>OS family as used in the <a href="../Tasks/conditions.html#os"><os></a>
condition.</td>
- <td align="center" valign="top">No - defaults to "windows"</td>
+ <td>No; defaults to <q>windows</q></td>
</tr>
</table>
<h3>Examples</h3>
<pre><attrib file="${dist}/run.bat" readonly="true" hidden="true"/></pre>
-<p>makes the "run.bat" file read-only and hidden.</p>
+
+<p>makes the <code>run.bat</code> file read-only and hidden.</p>
+
<pre><attrib readonly="false">
<fileset dir="${meta.inf}" includes="**/*.xml"/>
-</attrib>
-</pre>
-<p>makes all ".xml" files below <code>${meta.inf}</code> readable.</p>
+</attrib></pre>
+
+<p>makes all <samp>.xml</samp> files below <samp>${meta.inf}</samp> readable.</p>
+
<pre>
<attrib readonly="true" archive="true">
<fileset dir="shared/sources1">
<exclude name="**/trial/**"/>
</fileset>
<fileset refid="other.shared.sources"/>
-</attrib>
-</pre>
+</attrib></pre>
-<p>makes all files below <code>shared/sources1</code> (except those below any
- directory named trial) read-only and archived. In addition all files belonging
- to a FileSet with <code>id</code> <code>other.shared.sources</code> get the
- same attributes.</p>
+<p>makes all files below <samp>shared/sources1</samp> (except those below any directory
+named <samp>trial</samp>) read-only and archived. In addition all files belonging to a FileSet
+with <var>id</var> <samp>other.shared.sources</samp> get the same attributes.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/augment.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/augment.html b/manual/Tasks/augment.html
index 6699be8..6dee4be 100644
--- a/manual/Tasks/augment.html
+++ b/manual/Tasks/augment.html
@@ -27,57 +27,48 @@
<h2>Augment</h2>
<h3>Description</h3>
-<p>Modify an existing reference by adding nested elements or (re-)assigning properties
-mapped as XML attributes. This is an unusual task that makes use of Ant's internal
-processing mechanisms to reload a previously declared reference by means of the 'id'
-attribute, then treats the declared <code>augment</code> element as though it were the
-original element.
-<em>Since Apache Ant 1.8.1</em></p>
+<p>Modify an existing reference by adding nested elements or (re-)assigning properties mapped as XML
+attributes. This is an unusual task that makes use of Ant's internal processing mechanisms to reload
+a previously declared reference by means of the <var>id</var> attribute, then treats the
+declared <code>augment</code> element as though it were the original element. <em>Since Apache Ant
+1.8.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">id</td>
- <td valign="top">The id of the reference to augment. If no such reference has
- been declared a <code>BuildException</code> is generated.</td>
- <td valign="top" align="center">Yes</td>
+ <td>id</td>
+ <td>The <var>id</var> of the reference to augment. If no such reference has been declared
+ a <code>BuildException</code> is thrown.</td>
+ <td>Yes</td>
</tr>
</table>
-<p>
-Additional permissible attributes are dependent on the reference to be modified.
-</p>
+<p>Additional permissible attributes are dependent on the reference to be modified.</p>
<h3>Parameters specified as nested elements</h3>
-<p>
-Permissible nested elements are dependent on the reference to be modified.
-</p>
+<p>Permissible nested elements are dependent on the reference to be modified.</p>
<h3>Examples</h3>
-Given
-<pre>
- <fileset id="input-fs" dir="${basedir}" />
-</pre>
+<p>Given</p>
-<pre>
- <augment id="input-fs" excludes="foo" />
-</pre>
+<pre><fileset id="input-fs" dir="${basedir}"/></pre>
+
+<pre><augment id="input-fs" excludes="foo"/></pre>
-<p>Modifies the <code>excludes</code> attribute of <code>input-fs</code>.</p>
+<p>modifies the <var>excludes</var> attribute of <samp>input-fs</samp>.</p>
<pre>
- <augment id="input-fs">
- <filename name="bar" />
- </augment>
-</pre>
+<augment id="input-fs">
+ <filename name="bar"/>
+</augment></pre>
-<p>Adds a <code>filename</code> selector to <code>input-fs</code>.</p>
+<p>Adds a <code>filename</code> selector to <samp>input-fs</samp>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/available.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/available.html b/manual/Tasks/available.html
index 57ba9ce..12224c3 100644
--- a/manual/Tasks/available.html
+++ b/manual/Tasks/available.html
@@ -26,132 +26,123 @@
<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>
-<p>If the resource is present, the property value is set to true by
-default; otherwise, the property is not set. You can set the value to
-something other than the default by specifying the <code>value</code> attribute.</p>
-<p>Normally, this task is used to set properties that are useful to avoid target
-execution depending on system parameters.</p>
+<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>
+<p>If the resource is present, the property value is set to <q>true</q> by default; otherwise, the
+property is not set. You can set the value to something other than the default by specifying
+the <var>value</var> attribute.</p>
+<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>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">property</td>
- <td valign="top">The name of the property to set.</td>
- <td valign="top" align="center">Yes</td>
+ <td>property</td>
+ <td>The name of the property to set.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">The value to set the property to. Defaults to "true".</td>
- <td valign="top" align="center">No</td>
+ <td>value</td>
+ <td>The value to set the property to.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">classname</td>
- <td valign="top">The class to look for in the classpath.</td>
- <td valign="middle" align="center" rowspan="3">Yes</td>
+ <td>classname</td>
+ <td>The class to look for in the classpath.</td>
+ <td rowspan="3">Exactly one of the three</td>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">The file to look for.</td>
+ <td>file</td>
+ <td class="left">The file to look for.</td>
</tr>
<tr>
- <td valign="top">resource</td>
- <td valign="top">The resource to look for in the JVM.</td>
+ <td>resource</td>
+ <td class="left">The resource to look for in the JVM.</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">The classpath to use when looking up <code>classname</code> or <code>resource</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>classpath</td>
+ <td>The classpath to use when looking up <var>classname</var> or <var>resource</var>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">filepath</td>
- <td valign="top">The path to use when looking up <code>file</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>filepath</td>
+ <td>The path to use when looking up <var>file</var>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">The classpath to use, given as a <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, given as a <a href="../using.html#references">reference</a> to a path
+ defined elsewhere.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">type</td>
- <td valign="top">The type of <code>file</code> to look for, either a directory (<code>type="dir"</code>) or a file
- (<code>type="file"</code>). If not set, the property will be set if the name specified in the <code>file</code>
- attribute exists as either a file or a directory.</td>
- <td align="center" valign="top">No</td>
+ <td>type</td>
+ <td>The type of <var>file</var> to look for, either a directory (<var>type</var>=<q>dir</q>) or
+ a file (<var>type</var>=<q>file</q>). If not set, the property will be set if the name specified
+ in the <var>file</var> attribute exists as either a file or a directory.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">ignoresystemclasses</td>
- <td valign="top">Ignore Ant's runtime classes, using only the specified
- classpath. Only affects the "classname" attribute. Defaults to "false"</td>
- <td align="center" valign="top">No</td>
+ <td>ignoresystemclasses</td>
+ <td>Ignore Ant's runtime classes, using only the specified classpath. Only affects
+ the <var>classname</var> attribute.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">searchparents</td>
- <td valign="top">This contains the behaviour of the "file" type.
- If true, the available task will, when
- searching for a file, search not only the directories specified but
- will also search the parent directories of those
- specified.
- If false, only the directories specified will be searched.
- Defaults to "false".
- <em>Since Ant 1.7</em>
- </td>
- <td align="center" valign="top">No</td>
+ <td>searchparents</td>
+ <td>This contains the behaviour of the <q>file</q> <var>type</var>. If <q>true</q>, the task
+ will, when searching for a file, search not only the directories specified but will also search
+ the parent directories of those specified. If <q>false</q>, only the directories specified will
+ be searched. <em>Since Ant 1.7</em></td>
+ <td>No; defaults to <q>false</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>classpath</h4>
-<p><code>Available</code>'s <code>classpath</code> attribute is a <a
-href="../using.html#path">path-like structure</a> and can also be set via a nested
+<p><code>Available</code>'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><classpath></code> element.</p>
<h4>filepath</h4>
-<p><code>Available</code>'s <code>filepath</code> attribute is a <a
-href="../using.html#path">path-like structure</a> and can also be set via a nested
-<code><filepath></code> element.</p>
+<p><code>Available</code>'s <code>filepath</code> attribute is
+a <a href="../using.html#path">path-like structure</a> and can also be set via a
+nested <code><filepath></code> element.</p>
<h3>Examples</h3>
-<pre>
-<available classname="org.whatever.Myclass" property="Myclass.present"/>
-</pre>
-<p>sets the <code>Myclass.present</code> property to the value "true"
-if the class <code>org.whatever.Myclass</code> is found in Ant's classpath.</p>
+<pre><available classname="org.whatever.Myclass" property="Myclass.present"/></pre>
+<p>sets the <code>Myclass.present</code> property to the value <q>true</q> if the
+class <code>org.whatever.Myclass</code> is found in Ant's classpath.</p>
<pre>
<property name="jaxp.jar" value="./lib/jaxp11/jaxp.jar"/>
-<available file="${jaxp.jar}" property="jaxp.jar.present"/>
-</pre>
-<p>sets the <code>jaxp.jar.present</code> property to the value "true"
-if the file <code>./lib/jaxp11/jaxp.jar</code> is found.</p>
+<available file="${jaxp.jar}" property="jaxp.jar.present"/></pre>
+<p>sets the <code>jaxp.jar.present</code> property to the value <q>true</q> if the
+file <samp>./lib/jaxp11/jaxp.jar</samp> is found.</p>
<pre>
<available file="/usr/local/lib" type="dir"
- property="local.lib.present"/>
-</pre>
-<p>sets the <code>local.lib.present</code> property to the value "true"
-if the directory <code>/usr/local/lib</code> is found.</p>
+ property="local.lib.present"/></pre>
+<p>sets the <code>local.lib.present</code> property to the value <q>true</q> if the
+directory <samp>/usr/local/lib</samp> is found.</p>
<pre>
...in project ...
<property name="jaxp.jar" value="./lib/jaxp11/jaxp.jar"/>
<path id="jaxp" location="${jaxp.jar}"/>
...in target ...
<available classname="javax.xml.transform.Transformer"
- classpathref="jaxp" property="jaxp11.present"/>
-</pre>
-<p>sets the <code>jaxp11.present</code> property to the value "true"
-if the class <code>javax.xml.transform.Transformer</code> is found in the classpath referenced by <code>jaxp</code> (in this case, <code>./lib/jaxp11/jaxp.jar</code>).
+ classpathref="jaxp" property="jaxp11.present"/></pre>
+<p>sets the <code>jaxp11.present</code> property to the value <q>true</q> if the
+class <code>javax.xml.transform.Transformer</code> is found in the classpath referenced
+by <samp>jaxp</samp> (in this case, <samp>./lib/jaxp11/jaxp.jar</samp>).
</p>
<pre>
<available property="have.extras" resource="extratasks.properties">
<classpath>
- <pathelement location="/usr/local/ant/extra.jar" />
+ <pathelement location="/usr/local/ant/extra.jar"/>
</classpath>
-</available>
-</pre>
-<p>sets the <code>have.extras</code> property to the value "true"
-if the resource-file <code>extratasks.properties</code> is found.
+</available></pre>
+<p>sets the <code>have.extras</code> property to the value <q>true</q> if the resource
+file <samp>extratasks.properties</samp> is found.
</p>
</body>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/basename.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/basename.html b/manual/Tasks/basename.html
index bc55c6e..c52e2bd 100644
--- a/manual/Tasks/basename.html
+++ b/manual/Tasks/basename.html
@@ -25,64 +25,54 @@
<body>
<h2 id="echo">Basename</h2>
+
<h3>Description</h3>
-<p>
-Task to determine the basename of a specified file, optionally minus a
-specified suffix.
-</p>
-<p>
-When this task executes, it will set the specified property to the
-value of the last path element of the specified file. If <code>file</code> is a
-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>Task to determine the basename of a specified file, optionally minus a specified suffix.</p>
+<p>When this task executes, it will set the specified property to the value of the last path element
+of the specified file. If <var>file</var> is a directory, the basename will be the last directory
+element. If <var>file</var> is a full-path, relative-path, or simple filename, the basename will be
+the simple file name, without any directory 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">file</td>
- <td valign="top">The path to take the basename of.</td>
- <td valign="top" align="center">Yes</td>
+ <td>file</td>
+ <td>The path to take the basename of.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">property</td>
- <td valign="top">The name of the property to set.</td>
- <td valign="top" align="center">Yes</td>
+ <td>property</td>
+ <td>The name of the property to set.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">suffix</td>
- <td valign="top">The suffix to remove from the resulting basename
- (specified either with or without the "<code>.</code>").</td>
- <td valign="top" align="center">No</td>
+ <td>suffix</td>
+ <td>The suffix to remove from the resulting basename (specified either with or without
+ the <q>.</q>).</td>
+ <td>No</td>
</tr>
</table>
<h3>Examples</h3>
-<pre>
-<basename property="jar.filename" file="${lib.jarfile}"/>
-</pre>
-will set <code>jar.filename</code> to
-<code>myjar.jar</code>, if <code>lib.jarfile</code> is defined as either a
-full-path filename (eg., <code>/usr/local/lib/myjar.jar</code>),
-a relative-path filename (eg., <code>lib/myjar.jar</code>),
-or a simple filename (eg., <code>myjar.jar</code>).
+<pre><basename property="jar.filename" file="${lib.jarfile}"/></pre>
+<p>will set <code>jar.filename</code> to <samp>myjar.jar</samp>, if <code>lib.jarfile</code> is
+defined as either a full-path filename (eg., <samp>/usr/local/lib/myjar.jar</samp>), a relative-path
+filename (eg., <samp>lib/myjar.jar</samp>), or a simple filename (eg., <samp>myjar.jar</samp>).</p>
<pre>
<basename property="cmdname" file="D:/usr/local/foo.exe"
- suffix=".exe"/>
-</pre>
-will set <code>cmdname</code> to <code>foo</code>.
+ suffix=".exe"/></pre>
+<p>will set <code>cmdname</code> to <samp>foo</samp>.</p>
<pre>
<property environment="env"/>
<basename property="temp.dirname" file="${env.TEMP}"/>
</pre>
-will set <code>temp.dirname</code> to the last directory element of
-the path defined for the <code>TEMP</code> environment variable.
+<p>will set <code>temp.dirname</code> to the last directory element of the path defined for
+the <code>TEMP</code> environment variable.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/bindtargets.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/bindtargets.html b/manual/Tasks/bindtargets.html
index 538d538..74b90b5 100644
--- a/manual/Tasks/bindtargets.html
+++ b/manual/Tasks/bindtargets.html
@@ -27,64 +27,57 @@
<h2 id="ant">Bindtargets</h2>
<h3>Description</h3>
-<p>Make some target the extension of some defined
-<a href="../targets.html#extension-points">extension point</a>. It will make the
-list of targets dependencies of the extension point.</p>
+<p>Make some target the extension of some
+defined <a href="../targets.html#extension-points">extension point</a>. It will make the list of
+targets dependencies of the extension point.</p>
-<p>This target is useful when you want to have a target participate to another
-build workflow, build workflow which explicitly expose an extension point for
-that kind of insertion. But the target to bind and the extension point to
-bind to are both declared in some imported build files. Modifying directly the
-target dependency graph of these external build files may have a side effect
-on some other project which import them. This task helps then to modify the
-target dependencies but only in your context.
-</p>
+<p>This target is useful when you want to have a target to participate in another build workflow
+which explicitly exposes an extension point for that kind of insertion. Thus the target to bind and
+the extension point to bind to are both declared in some imported build files. But directly
+modifying the target dependency graph of these external build files may have a side effect on some
+other project which imports them. This task helps to modify the target dependencies but only in your
+context.</p>
-<p><strong>Note</strong>: this task is quite equivalent to the definition of an intermediate
-target which will be the bridge between the target to bind and the extension
-point. For instance:
-</p>
-<pre><bindtargets targets="jar,javadoc" extensionPoint="dist" /></pre>
-is quite equivalent to:
-<pre><target name="bind-to-dist" depends="jar,javadoc" extensionOf="dist" /></pre>
-<p>This task basically avoid the creation of a target.</p>
+<p><strong>Note</strong>: this task is quite equivalent to the definition of an intermediate target
+which will be the bridge between the target to bind and the extension point. For instance:</p>
+<pre><bindtargets targets="jar,javadoc" extensionPoint="dist"/></pre>
+<p>is quite equivalent to:</p>
+<pre><target name="bind-to-dist" depends="jar,javadoc" extensionOf="dist"/></pre>
+<p>This task basically avoids the creation of a target.</p>
-<p>The bindtargets task may only be used as a top-level task. This means that
-it may not be used in a target. This is making the target dependency graph static
-and predictable as soon as every build file is loaded.</p>
+<p>The <code>bindtargets</code> task may only be used as a top-level task. This means that it may
+not be used in a target. This is making the target dependency graph static and predictable as soon
+as every build file is loaded.</p>
<p><em>Since Apache Ant 1.8.2</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">targets</td>
- <td valign="top">a comma separated list of target names to bind.</td>
- <td valign="top" align="center">Yes</td>
+ <td>targets</td>
+ <td>a comma separated list of target names to bind.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">extensionPoint</td>
- <td valign="top">the name of the extension point to bind the targets to.</td>
- <td valign="top" align="center">Yes</td>
+ <td>extensionPoint</td>
+ <td>the name of the extension point to bind the targets to.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">onMissingExtensionPoint</td>
- <td valign="top">What to do if this target tries to extend a missing
- <a href="../targets.html#extension-points">extension-point</a>. ("fail",
- "warn", "ignore").</td>
- <td valign="top" align="center">No. Defaults to <code>fail</code></td>
+ <td>onMissingExtensionPoint</td>
+ <td>What to do if this target tries to extend a
+ missing <a href="../targets.html#extension-points">extension-point</a>: <q>fail</q>, <q>warn</q>, <q>ignore</q>.</td>
+ <td>No; defaults to <q>fail</q></td>
</tr>
</table>
<h3>Examples</h3>
-<pre>
-<bindtargets targets="build-jar,build-src-jar" extensionPoint="dist"/>
-</pre>
+<pre><bindtargets targets="build-jar,build-src-jar" extensionPoint="dist"/></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/buildnumber.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/buildnumber.html b/manual/Tasks/buildnumber.html
index 474a925..f2eab08 100644
--- a/manual/Tasks/buildnumber.html
+++ b/manual/Tasks/buildnumber.html
@@ -27,45 +27,34 @@
<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,
-<code>build.number</code> in the current directory), then
-set the property <code>build.number</code> to the value that was read in
-(or to <code>0</code>, if no such value). It will then increment the
-number by one and write it back out to the file.
-(See the
-<a href="../Tasks/propertyfile.html">PropertyFile</a> task
-if you need finer control over things such as the property name or
-the number format.)
-</p>
+<p>It will first attempt to read a build number from a file (by default, <samp>build.number</samp>
+in the current directory), then set the property <code>build.number</code> to the value that was
+read in (or to <q>0</q>, if no such value). It will then increment the number by one and write it
+back out to the file. (See the <a href="../Tasks/propertyfile.html">PropertyFile</a> task if you
+need finer control over things such as the property name or the number format.)</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">The file to read and write the build number from/to.</td>
- <td align="center" valign="top">No; defaults to "build.number"</td>
+ <td>file</td>
+ <td>The file to read and write the build number from/to.</td>
+ <td>No; defaults to <q>build.number</q></td>
</tr>
</table>
<h3>Examples</h3>
-<pre>
-<buildnumber/>
-</pre>
+<pre><buildnumber/></pre>
-<p>Read, increment, and write a build number to the default file,
-<code>build.number</code>.</p>
+<p>Read, increment, and write a build number to the default file, <samp>build.number</samp>.</p>
-<pre>
-<buildnumber file="mybuild.number"/>
-</pre>
+<pre><buildnumber file="mybuild.number"/></pre>
-<p>Read, increment, and write a build number to the file
-<code>mybuild.number</code>.</p>
+<p>Read, increment, and write a build number to the file <samp>mybuild.number</samp>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/cab.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/cab.html b/manual/Tasks/cab.html
index 115d739..01ddf83 100644
--- a/manual/Tasks/cab.html
+++ b/manual/Tasks/cab.html
@@ -26,124 +26,107 @@
<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.
-This task will work on Windows using the external cabarc tool (provided by Microsoft)
-which must be located in your executable path.</p>
-<p>To use this task on other platforms you need to download and compile libcabinet from
-<a href="http://trill.cis.fordham.edu/~barbacha/cabinet_library/">
-http://trill.cis.fordham.edu/~barbacha/cabinet_library/</a>.</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.</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>basedir</code>) as well as the nested
-<code><include></code>, <code><exclude></code> and
-<code><patternset></code> elements.</p>
+<p>The cab task creates Microsoft cabinet archive files. It is invoked similar to
+the <a href="../Tasks/jar.html">jar</a> or <a href="../Tasks/zip.html">zip</a> tasks. This task
+will work on Windows using the external <code>cabarc</code> tool (provided by Microsoft) which must
+be located in your executable path.</p>
+<p>To use this task on other platforms you need to download and compile <code>libcabinet</code>
+from <a href="https://www.freshports.org/archivers/libcabinet/">https://www.freshports.org/archivers/libcabinet/</a>.</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.</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>basedir</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">cabfile</td>
- <td valign="top">the name of the cab file to create.</td>
- <td valign="top" align="center">Yes</td>
+ <td>cabfile</td>
+ <td>the name of the cab file to create.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">basedir</td>
- <td valign="top">the directory to start archiving files from.</td>
- <td valign="top" align="center">No</td>
+ <td>basedir</td>
+ <td>the directory to start archiving files from.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">set to "yes" if you want to see the output from
- the cabarc tool. defaults to "no".</td>
- <td valign="top" align="center">No</td>
+ <td>verbose</td>
+ <td>set to <q>yes</q> if you want to see the output from the <code>cabarc</code> tool.</td>
+ <td>No; defaults to <q>no</q></td>
</tr>
<tr>
- <td valign="top">compress</td>
- <td valign="top">set to "no" to store files without compressing.
- defaults to "yes".</td>
- <td valign="top" align="center">No</td>
+ <td>compress</td>
+ <td>set to <q>no</q> to store files without compressing.</td>
+ <td>No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">options</td>
- <td valign="top">use to set additional command-line options for
- the cabarc tool. should not normally be necessary.</td>
- <td valign="top" align="center">No</td>
+ <td>options</td>
+ <td>use to set additional command-line options for the <code>cabarc</code> tool. Should not
+ normally be necessary.</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>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>fileset</h4>
-<p>The cab task supports one nested <a
-href="../Types/fileset.html"><code><fileset></code></a>
-element to specify the files to be included in the archive.
- If this is specified, the "basedir" attribute cannot be used.
-</p>
+<p>The cab task supports one nested <a href="../Types/fileset.html"><code><fileset></code></a>
+element to specify the files to be included in the archive. If this is specified,
+the <var>basedir</var> attribute cannot be used.</p>
<h3>Examples</h3>
<pre>
<cab cabfile="${dist}/manual.cab"
- basedir="htdocs/manual"/>
-</pre>
-<p>cabs all files in the htdocs/manual directory into a file called
-manual.cab in the ${dist} directory.</p>
+ basedir="htdocs/manual"/></pre>
+<p>cabs all files in the <samp>htdocs/manual</samp> directory into a file
+called <samp>manual.cab</samp> in the <samp>${dist}</samp> directory.</p>
<pre>
<cab cabfile="${dist}/manual.cab"
basedir="htdocs/manual"
- excludes="mydocs/**, **/todo.html"/>
-</pre>
-<p>cabs all files in the htdocs/manual directory into a file called
-manual.cab in the ${dist} directory. Files in the directory mydocs,
-or files with the name todo.html are excluded.</p>
+ excludes="mydocs/**, **/todo.html"/></pre>
+<p>cabs all files in the <samp>htdocs/manual</samp> directory into a file
+called <samp>manual.cab</samp> in the <samp>${dist}</samp> directory. Files in the
+directory <samp>mydocs</samp>, or files with the name <samp>todo.html</samp> are excluded.</p>
<pre>
<cab cabfile="${dist}/manual.cab"
basedir="htdocs/manual"
includes="api/**/*.html"
excludes="**/todo.html"
- verbose="yes"/>
-</pre>
-<p>Cab all files in the htdocs/manual directory into a file called
-manual.cab in the ${dist} directory. Only html files under the
-directory api are archived, and files with the name todo.html are
-excluded. Output from the cabarc tool is displayed in the build
-output.</p>
+ verbose="yes"/></pre>
+<p>Cab all files in the <samp>htdocs/manual</samp> directory into a file
+called <samp>manual.cab</samp> in the <samp>${dist}</samp> directory. Only <samp>.html</samp> files
+under the directory <samp>api</samp> are archived, and files with the name <samp>todo.html</samp>
+are excluded. Output from the <code>cabarc</code> tool is displayed in the build output.</p>
<pre>
<cab cabfile="${dist}/manual.cab"
@@ -152,8 +135,7 @@ output.</p>
dir="htdocs/manual"
includes="api/**/*.html"
excludes="**/todo.html"/>
-</cab>
-</pre>
+</cab></pre>
<p>is equivalent to the example above.</p>
</body>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/ccm.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/ccm.html b/manual/Tasks/ccm.html
index 39ca671..2b546b1 100644
--- a/manual/Tasks/ccm.html
+++ b/manual/Tasks/ccm.html
@@ -34,13 +34,16 @@
</ul>
<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>
+against versions 5.1/6.2 on Windows 2000, but should work on other platforms with <code>ccm</code>
+installed.</p>
+
<hr/>
+
<h2 id="ccmcheckin">CCMCheckin</h2>
<h3>Description</h3>
-Task to checkin a file
+<p>Task to checkin a file</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -53,35 +56,37 @@ Task to checkin a file
</tr>
<tr>
<td>comment</td>
- <td>Specify a comment. Default is "Checkin" plus the date</td>
- <td>No</td>
+ <td>Specify a comment.</td>
+ <td>No; default is <q>Checkin</q> plus the date</td>
</tr>
<tr>
<td>task</td>
- <td>Specify the task number used to check in the file (may use 'default')</td>
+ <td>Specify the task number used to check in the file (may use <q>default</q>)</td>
<td>No</td>
</tr>
<tr>
<td>ccmdir</td>
- <td>path to the ccm executable file, required if it is not on the PATH</td>
+ <td>path to the <code>ccm</code> executable file, required if it is not on
+ the <code>PATH</code></td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
- <pre><ccmcheckin file="c:/wa/com/foo/MyFile.java"
- comment="mycomment"/>
-</pre>
+<pre>
+<ccmcheckin file="c:/wa/com/foo/MyFile.java"
+ comment="mycomment"/></pre>
+
+<p>Checks in the file <samp>c:/wa/com/foo/MyFile.java</samp>. Text <samp>mycomment</samp> is added
+as a comment. The task used is the one set as the default.</p>
-<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 id="ccmcheckout">CCMCheckout</h2>
<h3>Description</h3>
-Task to perform a Checkout command to Continuus
+<p>Task to perform a checkout command to Continuus</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -90,53 +95,57 @@ 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">Exactly one of the two</td>
</tr>
<tr>
<td>fileset</td>
- <td>fileset containing the file to be checked out</td>
+ <td class="left">fileset containing the file to be checked out</td>
</tr>
<tr>
<td>comment</td>
- <td>Specify a comment.</td>
+ <td>Specify a comment</td>
<td>No</td>
</tr>
<tr>
<td>task</td>
- <td>Specify the task number used to checkin the file (may use
- 'default')</td>
+ <td>Specify the task number used to checkin the file (may use <q>default</q>)</td>
<td>No</td>
</tr>
<tr>
<td>ccmdir</td>
- <td>path to the ccm executable file, required if it is not on the PATH</td>
+ <td>path to the <code>ccm</code> executable file, required if it is not on
+ the <code>PATH</code></td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
-<pre><ccmcheckout file="c:/wa/com/foo/MyFile.java"
- comment="mycomment"/></pre>
+<pre>
+<ccmcheckout file="c:/wa/com/foo/MyFile.java"
+ comment="mycomment"/></pre>
-<p>Check out the file <i>c:/wa/com/foo/MyFile.java</i>.
- Comment attribute <i>mycomment</i> is added as a task comment
- The used task is the one set as the default.</p>
+<p>Check out the file <samp>c:/wa/com/foo/MyFile.java</samp>. Comment
+attribute <samp>mycomment</samp> is added as a task comment The used task is the one set as the
+default.</p>
-<pre><ccmcheckout comment="mycomment">
+<pre>
+<ccmcheckout comment="mycomment">
<fileset dir="lib" >
<include name="**/*.jar"/>
</fileset>
</ccmcheckout ></pre>
-<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>
+<p>Check out all the files in the <samp>lib</samp> directory having the <samp>.jar</samp> extension.
+Comment attribute <samp>mycomment</samp> is added as a task comment The used task is the one set as
+the default.</p>
+
<hr/>
+
<h2 id="ccmcheckintask">CCMCheckinTask</h2>
<h3>Description</h3>
-Task to perform a check in default task command to Continuus
+<p>Task to perform a checkin default task command to Continuus</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -149,12 +158,13 @@ Task to perform a check in default task command to Continuus
</tr>
<tr>
<td>task</td>
- <td>Specify the task number used to check in the file (may use 'default')</td>
+ <td>Specify the task number used to check in the file (may use <q>default</q>)</td>
<td>No</td>
</tr>
<tr>
<td>ccmdir</td>
- <td >path to the ccm executable file, required if it is not on the PATH</td>
+ <td>path to the <code>ccm</code> executable file, required if it is not on
+ the <code>PATH</code></td>
<td>No</td>
</tr>
</table>
@@ -163,12 +173,14 @@ Task to perform a check in default task command to Continuus
<pre><ccmcheckintask comment="blahblah/></pre>
<p>Does a Checkin default task on all the checked out files in the current task.</p>
+
<hr/>
+
<h2 id="ccmreconfigure">CCMReconfigure</h2>
<h3>Description</h3>
-Task to perform an reconfigure command to Continuus.
+<p>Task to perform an reconfigure command to Continuus.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -176,13 +188,13 @@ Task to perform an reconfigure command to Continuus.
</tr>
<tr>
<td>recurse</td>
- <td>recurse on subproject (default false)</td>
- <td>No</td>
+ <td>recurse on subproject</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
<td>verbose</td>
- <td>do a verbose reconfigure operation (default false)</td>
- <td>No</td>
+ <td>do a verbose reconfigure operation</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
<td>ccmproject</td>
@@ -191,24 +203,26 @@ Task to perform an reconfigure command to Continuus.
</tr>
<tr>
<td>ccmdir</td>
- <td >path to the ccm executable file, required if it is not on the PATH</td>
+ <td>path to the <code>ccm</code> executable file, required if it is not on
+ the <code>PATH</code></td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
-<pre><ccmreconfigure ccmproject="ANTCCM_TEST#BMO_1"
- verbose="true"/>
-</pre>
+<pre>
+<ccmreconfigure ccmproject="ANTCCM_TEST#BMO_1"
+ verbose="true"/></pre>
+
+<p>Does a Continuus <code>reconfigure</code> on the project <samp>ANTCCM_TEST#BMO_1</samp>.</p>
-<p>Does a Continuus <i>reconfigure</i> on the project <i>ANTCCM_TEST#BMO_1</i>.
-</p>
<hr/>
+
<h2 id="ccmcreatetask">CCMCreateTask</h2>
<h3>Description</h3>
-Create a Continuus task.
+<p>Create a Continuus task.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -216,7 +230,7 @@ Create a Continuus task.
</tr>
<tr>
<td>comment</td>
- <td>Specify a comment.</td>
+ <td>Specify a comment</td>
<td>No</td>
</tr>
<tr>
@@ -226,7 +240,8 @@ Create a Continuus task.
</tr>
<tr>
<td>ccmdir</td>
- <td >path to the ccm executable file, required if it is not on the PATH</td>
+ <td>path to the <code>ccm</code> executable file, required if it is not on
+ the <code>PATH</code></td>
<td>No</td>
</tr>
<tr>
@@ -246,18 +261,18 @@ Create a Continuus task.
</tr>
<tr>
<td>task</td>
- <td>Specify the task number used to checkin the file (may use 'default')</td>
+ <td>Specify the task number used to checkin the file (may use <q>default</q>)</td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
-<pre><ccmcreatetask resolver="${user.name}"
- release="ANTCCM_TEST" comment="blahblah"/>
-</pre>
+<pre>
+<ccmcreatetask resolver="${user.name}"
+ release="ANTCCM_TEST" comment="blahblah"/></pre>
-<p>Creates a task for the release <i>ANTCCM_TEST</i> with the
- current user as the resolver for this task.</p>
+<p>Creates a task for the release <samp>ANTCCM_TEST</samp> with the current user as the resolver for
+this task.</p>
</body>
</html>