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:54 UTC
[39/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/exec.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/exec.html b/manual/Tasks/exec.html
index 96dbdb1..1dde415 100644
--- a/manual/Tasks/exec.html
+++ b/manual/Tasks/exec.html
@@ -26,40 +26,33 @@
<h2 id="exec">Exec</h2>
<h3>Description</h3>
-<p>Executes a system command. When the <i>os</i> attribute is specified, then
-the command is only executed when Apache Ant is run on one of the specified operating
-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>Note that you cannot interact with the forked program, the only way
-to send input to it is via the input and inputstring attributes. Also note that
-<em>since Ant 1.6</em>, any attempt to read input in the forked program will receive an
-EOF (-1). This is a change from Ant 1.5, where such an attempt would block.</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. Also note that <em>since Ant 1.6</em>, any attempt to read
+input in the forked program will receive an EOF (<q>-1</q>). This is a change from Ant 1.5, where
+such an attempt would block.</p>
-<p>If you want to execute an executable using a path relative to the
- project's basedir, you may need to
- use <code>vmlauncher="false"</code> on some operating systems - but
- even this may fail (Solaris 8/9 has been reported as problematic).
- The <code>resolveexecutable</code> attribute should be more
- reliable, as would be something like</p>
+<p>If you want to execute an executable using a path relative to the project's <var>basedir</var>,
+you may need to use <var>vmlauncher</var>=<q>false</q> on some operating systems—but even this
+may fail (Solaris 8/9 has been reported as problematic). The <var>resolveexecutable</var> attribute
+should be more reliable, as would be something like</p>
<pre>
- <property name="executable-full-path"
- location="../relative/path/to/executable"/>
- <exec executable="${executable-full-path}" ...
-</pre>
+<property name="executable-full-path"
+ location="../relative/path/to/executable"/>
+<exec executable="${executable-full-path}" ...</pre>
<h4>Windows Users</h4>
<p>The <code><exec></code> task delegates to <code>Runtime.exec</code> which in turn
-apparently calls <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/createprocess.asp">
-<code>::CreateProcess</code></a>. It is the latter Win32 function that defines
-the exact semantics of the call. In particular, if you do not put a file extension
-on the executable, only ".EXE" files are looked for, not ".COM", ".CMD" or other file
-types listed in the environment variable PATHEXT. That is only used by the shell.
-</p>
- <p>
- Note that <em>.bat</em> files cannot in general by executed directly.
- One normally needs to execute the command shell executable <code>cmd</code>
- using the <code>/c</code> switch.
- </p>
+apparently
+calls <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms682425(v=vs.85).aspx"> <code>::CreateProcess</code></a>. It
+is the latter Win32 function that defines the exact semantics of the call. In particular, if you do
+not put a file extension on the executable, only <samp>.EXE</samp> files are looked for,
+not <samp>.COM</samp>, <samp>.CMD</samp> or other file types listed in the environment
+variable <code>PATHEXT</code>. That is only used by the shell.</p>
+<p>Note that <samp>.bat</samp> files cannot in general by executed directly. One normally needs to
+execute the command shell executable <code>cmd</code> using the <code>/c</code> switch.</p>
<pre>
<target name="help">
<exec executable="cmd">
@@ -67,245 +60,207 @@ types listed in the environment variable PATHEXT. That is only used by the shell
<arg value="ant.bat"/>
<arg value="-p"/>
</exec>
-</target>
-</pre>
+</target></pre>
<p>A common problem is not having the executable on the PATH. In case you get an error
-message <tt>Cannot run program "...":CreateProcess error=2. The system cannot find
-the path specified.</tt> have a look at your PATH variable. Just type the command directly on
-the command line and if Windows finds it, Ant should do it too. (Otherwise ask on the user mailinglist for help.) If Windows can not execute the program add the directory of the program
-to the PATH (<tt>set PATH=%PATH%;dirOfProgram</tt>) or specify the absolute path in the
-<tt>executable</tt> attribute in your buildfile.
-</p>
+message <code>Cannot run program "...":CreateProcess error=2. The system cannot find the path
+specified.</code> have a look at your <code>PATH</code> variable. Just type the command directly on
+the command line and if Windows finds it, Ant should do it too. (Otherwise ask on the user
+mailinglist for help.) If Windows can not execute the program add the directory of the program to
+the <code>PATH</code> (<code>set PATH=%PATH%;dirOfProgram</code>) or specify the absolute path in
+the <var>executable</var> attribute in your buildfile.</p>
<h4>Cygwin Users</h4>
-<p>The <code><exec></code> task will not understand paths such as /bin/sh
-for the executable parameter. This is because the Java VM in which Ant is
-running is a standard Windows executable and is not aware of the Cygwin
-environment (i.e., doesn't load <code>cygwin1.dll</code>). The only
-work-around for this is to compile a JVM under Cygwin (at your own risk).
-See for instance
-<a href="http://hg.openjdk.java.net/jdk7/build/raw-file/tip/README-builds.html#cygwin">
-OpenJDK build instructions for cygwin</a>.
-</p>
+<p>The <code><exec></code> task will not understand paths such as <code>/bin/sh</code> for the
+executable parameter. This is because JVM in which Ant is running is a standard Windows executable
+and is not aware of the Cygwin environment (i.e., doesn't load <samp>cygwin1.dll</samp>). The only
+work-around for this is to compile a JVM under Cygwin (at your own risk). See for
+instance <a href="https://cdn.rawgit.com/AdoptOpenJDK/openjdk-jdk9/dev/common/doc/building.html#cygwin">OpenJDK
+build instructions for cygwin</a>.</p>
<h4>OpenVMS Users</h4>
-<p>The command specified using <code>executable</code> and
-<code><arg></code> elements is executed exactly as specified
-inside a temporary DCL script. This has some implications:</p>
+<p>The command specified using <code>executable</code> and <code><arg></code> elements is
+executed exactly as specified inside a temporary DCL script. This has some implications:</p>
<ul>
-<li>paths have to be written in VMS style</li>
-<li>if your <code>executable</code> points to a DCL script remember to
-prefix it with an <code>@</code>-sign
-(e.g. <code>executable="@[FOO]BAR.COM"</code>), just as you would in a
-DCL script</li>
+ <li>paths have to be written in VMS style</li>
+ <li>if your <var>executable</var> points to a DCL script remember to prefix it with
+ an <q>@</q>-sign (e.g. <var>executable</var>=<q>@[FOO]BAR.COM</q>), just as you would in a DCL
+ script</li>
</ul>
-<p>For <code><exec></code> to work in an environment with a Java VM
-older than version 1.4.1-2 it is also <i>required</i> that the logical
-<code>JAVA$FORK_SUPPORT_CHDIR</code> is set to <code>TRUE</code> in
-the job table (see the <i>JDK Release Notes</i>).</p>
+<p>For <code><exec></code> to work in an environment with a JVM older than version 1.4.1-2 it
+is also <em>required</em> that the logical <code>JAVA$FORK_SUPPORT_CHDIR</code> is set
+to <code>TRUE</code> in the job table (see the <em>JDK Release Notes</em>).</p>
-<p>Please note that the Java VM provided by HP doesn't follow OpenVMS'
-conventions of exit codes. If you run a Java VM with this task, the
-task may falsely claim that an error occurred (or silently ignore an
-error). Don't use this task to run <code>JAVA.EXE</code>, use a
-<code><java></code> task with the <code>fork</code> attribute
-set to <code>true</code> instead as this task will follow the VM's
+<p>Please note that JVM provided by HP doesn't follow OpenVMS' conventions of exit codes. If you
+run a JVM with this task, the task may falsely claim that an error occurred (or silently ignore an
+error). Don't use this task to run <code>JAVA.EXE</code>, use a <code><java></code> task with
+the <var>fork</var> attribute set to <q>true</q> instead as this task will follow the JVM's
interpretation of exit codes.</p>
<h4>RedHat S/390 Users</h4>
-<p>It has been <a
-href="http://listserv.uark.edu/scripts/wa.exe?A1=ind0404&L=vmesa-l#33">reported
-on the VMESA-LISTSERV</a> that shell scripts invoked via the Ant Exec
-task must have their interpreter specified, i.e., the scripts must
-start with something like:</p>
+<p>It has been <a href="https://www.mail-archive.com/linux-390@vm.marist.edu/msg22223.html">reported
+on linux-390</a> that shell scripts invoked via the Ant Exec task must have their interpreter
+specified, i.e., the scripts must start with something like:</p>
-<pre>
-#!/bin/bash
-</pre>
+<pre>#!/bin/bash</pre>
<p>or the task will fail as follows:</p>
<pre>
[exec] Warning: UNIXProcess.forkAndExec native error: Exec format error
-[exec] Result: 255
-</pre>
+[exec] Result: 255</pre>
<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><exec></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><exec></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">command</td>
- <td valign="top">the command to execute with all command line
- arguments. <b>deprecated, use executable and nested
- <code><arg></code> elements instead</b>.</td>
- <td align="center" rowspan="2">Exactly one of the two</td>
+ <td>command</td>
+ <td>the command to execute with all command line arguments. <em><u>Deprecated</u>,
+ use <var>executable</var> and nested <code><arg></code> elements instead</em>.</td>
+ <td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
- <td valign="top">executable</td>
- <td valign="top">the command to execute without any command line
- arguments.</td>
+ <td>executable</td>
+ <td class="left">the command to execute without any command line arguments.</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">os</td>
- <td valign="top">list of Operating Systems on which the command may be
- executed. If the current OS's name is contained in this list, the command will
- be executed. The OS's name is determined by the Java Virtual machine and is set
- in the "os.name" system property.
+ <td>os</td>
+ <td>list of Operating Systems on which the command may be executed. If the current OS's name is
+ contained in this list, the command will be executed. The OS's name is determined by JVM and
+ is set in the <code>os.name</code> system property.
</td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">osfamily</td>
- <td valign="top">OS family as used in the <os> condition.
- <em>since Ant 1.7</em></td>
- <td align="center" valign="top">No</td>
+ <td>osfamily</td>
+ <td>OS family as used in the <code><os></code> condition. <em>since Ant 1.7</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">spawn</td>
- <td valign="top">whether or not you want the command to be spawned<br>
- Default is false.<br>
- If you spawn a command, its output will not be logged by Ant.<br>
- The input, output, error, and result property settings are not active when spawning a process.<br>
- <em>since Ant 1.6</em>
+ <td>spawn</td>
+ <td>whether or not you want the command to be spawned<br/>If you spawn a command, its output
+ will not be logged by Ant.<br/>The <var>input</var>, <var>output</var>, <var>error</var>,
+ and <var>result</var> property settings are not active when spawning a process.<br/><em>since
+ Ant 1.6</em>
</td>
- <td align="center" valign="top">No</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">output</td>
- <td valign="top">Name of a file to which to write the output. 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>Name of a file to which to write the output. 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 and error files should be appended to or overwritten.
- Defaults to false.</td>
- <td align="center" valign="top">No</td>
+ <td>append</td>
+ <td>Whether output and error files should be appended to or overwritten.</td>
+ <td>No; defaults to <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 output.</td>
- <td align="center" valign="top">No</td>
+ <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>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.</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>=<q>false</q>.</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
- return code signaling failure. Defaults to false.</td>
- <td align="center" valign="top">No</td>
+ <td>failonerror</td>
+ <td>Stop the build process if the command exits with a return code signaling failure.</td>
+ <td>No; defaults to <q>false</q></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">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>
+ <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 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>
+ <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 valign="top">resolveexecutable</td>
- <td valign="top">When this attribute is true, the name of the executable
- is 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. <em>since Ant 1.6</em></td>
- <td align="center" valign="top">No, default is <i>false</i></td>
+ <td>resolveexecutable</td>
+ <td>When this attribute is <q>true</q>, the name of the executable is 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>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">searchpath</td>
- <td valign="top">When this attribute is true, then
- system path environment variables will
- be searched when resolving the location
- of the executable. <em>since Ant 1.6.3</em></td>
- <td align="center" valign="top">No, default is <i>false</i></td>
+ <td>searchpath</td>
+ <td>When this attribute is <q>true</q>, then system path environment variables will be searched
+ when resolving the location of the executable. <em>since Ant 1.6.3</em></td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
<h3>Examples</h3>
@@ -316,76 +271,62 @@ start with something like:</p>
<h3>Parameters specified as nested elements</h3>
<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 id="env">env</h4>
-<p>It is possible to specify environment variables to pass to the
-system command via nested <code><env></code> elements.</p>
-<table>
+<p>It is possible to specify environment variables to pass to the system command via
+nested <code><env></code> elements.</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">key</td>
- <td valign="top">
- The name of the environment variable.
- <br/>
- <strong>Note</strong>: <em>since Ant 1.7</em>,
- for Windows, the name is case-insensitive.
- </td>
- <td align="center" valign="top">Yes</td>
+ <td>key</td>
+ <td>The name of the environment variable.<br/><strong>Note</strong>: <em>since Ant 1.7</em>, for
+ Windows, the name is case-insensitive.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">The literal value for the environment variable.</td>
- <td align="center" rowspan="3">Exactly one of these</td>
+ <td>value</td>
+ <td>The literal value for the environment variable.</td>
+ <td rowspan="3">Exactly one of these</td>
</tr>
<tr>
- <td valign="top">path</td>
- <td valign="top">The value for a PATH like environment
- variable. You can use ; or : as path separators and Ant will
- convert it to the platform's local conventions.</td>
+ <td>path</td>
+ <td class="left">The value for a <code>PATH</code>-like environment variable. You can
+ use <q>;</q> or <q>:</q> as path separators and Ant will convert it to the platform's local
+ conventions.</td>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">The value for the environment variable. Will be
- replaced by the absolute filename of the file by Ant.</td>
+ <td>file</td>
+ <td class="left">The value for the environment variable. Will be replaced by the absolute
+ filename of the file by Ant.</td>
</tr>
</table>
<h4 id="redirector">redirector</h4>
<em>Since Ant 1.6.2</em>
-<p>A nested <a href="../Types/redirector.html">I/O Redirector</a>
-can be specified. In general, the attributes of the redirector behave
-as the corresponding attributes available at the task level. The most
-notable peculiarity stems from the retention of the <exec>
-attributes for backwards compatibility. Any file mapping is done
-using a <code>null</code> sourcefile; therefore not all
-<a href="../Types/mapper.html">Mapper</a> types will return
-results. When no results are returned, redirection specifications
-will fall back to the task level attributes. In practice this means that
-defaults can be specified for input, output, and error output files.
-</p>
+<p>A nested <a href="../Types/redirector.html">I/O Redirector</a> can be specified. In general, the
+attributes of the redirector behave as the corresponding attributes available at the task level.
+The most notable peculiarity stems from the retention of the <code><exec></code> attributes
+for backwards compatibility. Any file mapping is done using a <code>null</code> sourcefile;
+therefore not all<a href="../Types/mapper.html">Mapper</a> types will return results. When no
+results are returned, redirection specifications will fall back to the task level attributes. In
+practice this means that defaults can be specified for input, output, and error output files.</p>
<h3>Errors and return codes</h3>
-By default the return code of a <code><exec></code> is ignored; when you set
-<code>failonerror="true"</code> then any return code signaling failure
-(OS specific) causes the build to fail. Alternatively, you can set
-<code>resultproperty</code> to the name of a property and have it assigned to
-the result code (barring immutability, of course).
-<p>
-If the attempt to start the program fails with an OS dependent error code,
-then <code><exec></code> halts the build unless <code>failifexecutionfails</code>
-is set to <code>false</code>. You can use that to run a program if it exists, but
-otherwise do nothing.
-<p>
-What do those error codes mean? Well, they are OS dependent. On Windows
-boxes you have to look at
-<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/system_error_codes__0-499_.asp">
-the documentation</a>; error code 2 means 'no such program', which usually means
-it is not on the path. Any time you see such an error from any Ant task, it is
-usually not an Ant bug, but some configuration problem on your machine.
+<p>By default the return code of a <code><exec></code> is ignored; when you
+set <var>failonerror</var> to <q>true</q> then any return code signaling failure (OS specific)
+causes the build to fail. Alternatively, you can set <var>resultproperty</var> to the name of a
+property and have it assigned to the result code (barring immutability, of course).</p>
+<p>If the attempt to start the program fails with an OS dependent error code,
+then <code><exec></code> halts the build unless <var>failifexecutionfails</var> is set
+to <q>false</q>. You can use that to run a program if it exists, but otherwise do nothing.</p>
+<p>What do those error codes mean? Well, they are OS dependent. On Windows boxes you have to look
+at <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms681382(v=vs.85).aspx"> the
+documentation</a>; <code>error=2</code> means 'no such program', which usually means it is not on
+the path. Any time you see such an error from any Ant task, it is usually not an Ant bug, but some
+configuration problem on your machine.</p>
<h3>Examples</h3>
<pre>
@@ -394,14 +335,15 @@ usually not an Ant bug, but some configuration problem on your machine.
</exec>
</pre>
<p>starts <code>emacs</code> on display 1 of the X Window System.</p>
+
<pre>
<property environment="env"/>
<exec ... >
<env key="PATH" path="${env.PATH}:${basedir}/bin"/>
</exec>
</pre>
-<p>adds <code>${basedir}/bin</code> to the <code>PATH</code> of the
-system command.</p>
+<p>adds <samp>${basedir}/bin</samp> to the <code>PATH</code> of the system command.</p>
+
<pre>
<property name="browser" location="C:/Program Files/Internet Explorer/iexplore.exe"/>
<property name="file" location="ant/docs/manual/index.html"/>
@@ -410,8 +352,9 @@ system command.</p>
<arg value="${file}"/>
</exec>
</pre>
-<p>Starts the <i>${browser}</i> with the specified <i>${file}</i> and end the
-Ant process. The browser will remain.</p>
+<p>Starts the <samp>${browser}</samp> with the specified <samp>${file}</samp> and end the Ant
+process. The browser will remain.</p>
+
<pre>
<exec executable="cat">
<redirector outputproperty="redirector.out"
@@ -426,21 +369,16 @@ Ant process. The browser will remain.</p>
</exec>
</pre>
-Sends the string "blah before blah" to the "cat" executable,
-using an <a href="../Types/filterchain.html"><inputfilterchain></a>
-to replace "before" with "after" on the way in.
-Output is sent to the file "redirector.out" and stored
-in a property of the same name. Similarly, error output is sent to
-a file and a property, both named "redirector.err".
+<p>Sends the string <q>blah before blah</q> to the <code>cat</code> executable, using
+an <a href="../Types/filterchain.html"><inputfilterchain></a> to replace <q>before</q>
+with <q>after</q> on the way in. Output is sent to the file <samp>redirector.out</samp> and stored
+in a property of the same name. Similarly, error output is sent to a file and a property, both
+named <samp>redirector.err</samp>.</p>
-<p><strong>Note</strong>: do not try to specify arguments using
-a simple arg-element and separate them by spaces. This results in
-only a single argument containing the entire string.</p>
-<p>
-<b>Timeouts:</b> If a timeout is specified, when it is reached the
-sub process is killed and a message printed to the log. The return
-value of the execution will be "-1", which will halt the build if
-<tt>failonerror=true</tt>, but be ignored otherwise.
-</p>
+<p><strong>Note</strong>: do not try to specify arguments using a simple arg-element and separate
+them by spaces. This results in only a single argument containing the entire string.</p>
+<p><strong>Timeouts</strong>: If a timeout is specified, when it is reached the sub process is
+killed and a message printed to the log. The return value of the execution will be <q>-1</q>, which
+will halt the build if <var>failonerror</var>=<q>true</q>, but be ignored otherwise.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/fail.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/fail.html b/manual/Tasks/fail.html
index f803783..1bc47cf 100644
--- a/manual/Tasks/fail.html
+++ b/manual/Tasks/fail.html
@@ -26,103 +26,95 @@
<h2 id="fail">Fail</h2>
<h3>Description</h3>
-<p>Exits the current build (just throwing a BuildException), optionally printing additional information.</p>
-<p>The message of the Exception can be set via the message attribute
-or character data nested into the element.</p>
+<p>Exits the current build (just throwing a BuildException), optionally printing additional
+information.</p>
+<p>The message of the Exception can be set via the message attribute or character data nested into
+the element.</p>
<h3>Parameters</h3>
-<table>
+<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">message</td>
- <td valign="top">A message giving further information on why the build exited</td>
- <td align="center" valign="top">No</td>
+ <td>message</td>
+ <td>A message giving further information on why the build exited</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">if</td>
- <td valign="top">Only fail <a href="../properties.html#if+unless">if a property of the given name exists</a>
+ <td>if</td>
+ <td>Only fail <a href="../properties.html#if+unless">if a property of the given name exists</a>
in the current project</td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">unless</td>
- <td valign="top">Only fail <a href="../properties.html#if+unless">if a property of the given name doesn't
+ <td>unless</td>
+ <td>Only fail <a href="../properties.html#if+unless">if a property of the given name doesn't
exist</a> in the current project</td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">status</td>
- <td valign="top">Exit using the specified status code;
- assuming the generated Exception is not caught, the
+ <td>status</td>
+ <td>Exit using the specified status code; assuming the generated Exception is not caught, the
JVM will exit with this status. <em>Since Apache Ant 1.6.2</em></td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
-<p>As an alternative to the <i>if</i>/<i>unless</i> attributes,
- conditional failure can be achieved using a single nested
- <code><condition></code> element, which should contain exactly one
- core or custom condition. For information about conditions, see
- <a href="conditions.html">here</a>.<br><em>Since Ant 1.6.2</em>
+<p>As an alternative to the <var>if</var>/<var>unless</var> attributes, conditional failure can be
+achieved using a single nested <code><condition></code> element, which should contain exactly
+one core or custom condition. For information about conditions,
+see <a href="conditions.html">here</a>.<br><em>Since Ant 1.6.2</em>
</p>
<h3>Examples</h3>
-<pre> <fail/></pre>
+<pre><fail/></pre>
<p>will exit the current build with no further information given.</p>
<pre>
BUILD FAILED
-build.xml:4: No message
-</pre>
+build.xml:4: No message</pre>
-<pre> <fail message="Something wrong here."/></pre>
-<p>will exit the current build and print something
- like the following to wherever your output goes:
-</p>
+<pre><fail message="Something wrong here."/></pre>
+<p>will exit the current build and print something like the following to wherever your output
+goes:</p>
<pre>
BUILD FAILED
-build.xml:4: Something wrong here.
-</pre>
+build.xml:4: Something wrong here.</pre>
-<pre> <fail>Something wrong here.</fail></pre>
+<pre><fail>Something wrong here.</fail></pre>
<p>will give the same result as above.</p>
-<pre> <fail unless="thisdoesnotexist"/></pre>
-<p>will exit the current build and print something
- like the following to wherever your output goes:
-</p>
+<pre><fail unless="thisdoesnotexist"/></pre>
+<p>will exit the current build and print something like the following to wherever your output
+goes:</p>
<pre>
BUILD FAILED
-build.xml:2: unless=thisdoesnotexist
-</pre>
+build.xml:2: unless=thisdoesnotexist</pre>
Using a condition to achieve the same effect:
<pre>
- <fail>
- <condition>
- <not>
- <isset property="thisdoesnotexist"/>
- </not>
- </condition>
- </fail>
-</pre>
+<fail>
+ <condition>
+ <not>
+ <isset property="thisdoesnotexist"/>
+ </not>
+ </condition>
+</fail></pre>
<p>Output:</p>
<pre>
BUILD FAILED
-build.xml:2: condition satisfied
-</pre>
+build.xml:2: condition satisfied</pre>
<pre>
<fail message="Files are missing.">
@@ -133,10 +125,9 @@ build.xml:2: condition satisfied
</resourcecount>
</not>
</condition>
-</fail>
-</pre>
-<p>Will check that both files <i>one.txt</i> and <i>two.txt</i> are present otherwise the build
-will fail.</p>
+</fail></pre>
+<p>Will check that both files <samp>one.txt</samp> and <samp>two.txt</samp> are present otherwise
+the build will fail.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/filter.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/filter.html b/manual/Tasks/filter.html
index 90e85a9..09c263b 100644
--- a/manual/Tasks/filter.html
+++ b/manual/Tasks/filter.html
@@ -26,51 +26,51 @@
<h2 id="filter">Filter</h2>
<h3>Description</h3>
-<p>Sets a token filter for this project or read multiple token filter from
-an input file and sets these as filters.
-Token filters are used by all tasks that perform file copying operations
-through the Project commodity methods. See the warning
-<a href="../using.html#filters"><em>here</em></a> before using.</p>
-<p>Note 1: the token string must not contain the separators chars (@).<br>
-Note 2: Either token and value attributes must be provided, or only the
-filtersfile attribute.</p>
+<p>Sets a token filter for this project or read multiple token filter from an input file and sets
+these as filters. Token filters are used by all tasks that perform file copying operations through
+the Project commodity methods. See the warning <a href="../using.html#filters"><em>here</em></a>
+before using.</p>
+<p>Note 1: the token string must not contain the separators chars (<q>@</q>).<br/>Note 2:
+Either <var>token</var> and <var>value</var> attributes must be provided, or only
+the <var>filtersfile</var> attribute.</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">token</td>
- <td valign="top">the token string without @</td>
- <td align="center" valign="top">Yes*</td>
+ <td>token</td>
+ <td>the token string without <q>@</q></td>
+ <td>Yes<sup>*</sup></td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">the string that should be put to replace the token when the
- file is copied</td>
- <td align="center" valign="top">Yes*</td>
+ <td>value</td>
+ <td>the string that should be put to replace the token when the file is copied</td>
+ <td>Yes<sup>*</sup></td>
</tr>
<tr>
- <td valign="top">filtersfile</td>
- <td valign="top">The file from which the filters must be read. This file must be a formatted as a property file.</td>
- <td align="center" valign="top">Yes*</td>
+ <td>filtersfile</td>
+ <td>The file from which the filters must be read. This file must be a formatted as a property
+ file.</td>
+ <td>Yes<sup>*</sup></td>
</tr>
</table>
-<p>* see notes 1 and 2 above parameters table.</p>
+<p>* see Note 1 and 2 above parameters table.</p>
<h3>Examples</h3>
-<pre> <filter token="year" value="2000"/>
- <copy todir="${dest.dir}" filtering="true">
- <fileset dir="${src.dir}"/>
- </copy></pre>
-<p>will copy recursively all the files from the <i>src.dir</i> directory into
-the <i>dest.dir</i> directory replacing all the occurrences of the string <i>@year@</i>
-with <i>2000.</i></p>
-<pre> <filter filtersfile="deploy_env.properties"/></pre>
-will read all property entries from the <i>deploy_env.properties</i> file
-and set these as filters.
+<pre>
+<filter token="year" value="2000"/>
+<copy todir="${dest.dir}" filtering="true">
+ <fileset dir="${src.dir}"/>
+</copy></pre>
+<p>will copy recursively all the files from the <samp>src.dir</samp> directory into
+the <samp>dest.dir</samp> directory replacing all the occurrences of the string <code>@year@</code>
+with <q>2000</q>.</p>
+<pre><filter filtersfile="deploy_env.properties"/></pre>
+<p>will read all property entries from the <samp>deploy_env.properties</samp> file and set these as
+filters.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/fixcrlf.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/fixcrlf.html b/manual/Tasks/fixcrlf.html
index e395ea4..c594290 100644
--- a/manual/Tasks/fixcrlf.html
+++ b/manual/Tasks/fixcrlf.html
@@ -26,301 +26,220 @@
<h2 id="fixcrlf">FixCRLF</h2>
<h3>Description</h3>
- <p>
- Adjusts a text file to local conventions.
- </p>
+ <p>Adjusts a text file to local conventions.</p>
- <p>
- The set of files to be adjusted can be refined with the
- <i>includes</i>, <i>includesfile</i>, <i>excludes</i>,
- <i>excludesfile</i> and <i>defaultexcludes</i>
- attributes. Patterns provided through the <i>includes</i> or
- <i>includesfile</i> attributes specify files to be
- included. Patterns provided through the <i>exclude</i> or
- <i>excludesfile</i> attribute specify files to be
- excluded. Additionally, default exclusions can be specified with
- the <i>defaultexcludes</i> attribute. See the section on <a
- href="../dirtasks.html#directorybasedtasks">directory-based
- tasks</a>, for details of file inclusion/exclusion patterns
- and their usage.
- </p>
+ <p>The set of files to be adjusted can be refined with
+ the <var>includes</var>, <var>includesfile</var>, <var>excludes</var>, <var>excludesfile</var>
+ and <var>defaultexcludes</var> attributes. Patterns provided through the <var>includes</var>
+ or <var>includesfile</var> attributes specify files to be included. Patterns provided through
+ the <var>exclude</var> or <var>excludesfile</var> attribute specify files to be
+ excluded. Additionally, default exclusions can be specified with the <var>defaultexcludes</var>
+ attribute. See the section on <a href="../dirtasks.html#directorybasedtasks">directory-based
+ tasks</a>, for details of file inclusion/exclusion patterns and their usage.</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>srcdir</code>) as well as the nested
- <code><include></code>, <code><exclude></code> and
- <code><patternset></code> elements.
- </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>srcdir</var>) as well as
+ the nested <code><include></code>, <code><exclude></code>
+ and <code><patternset></code> elements.</p>
- <p>
- The output file is only written if it is a new file, or 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 is a new file, or if it differs from the existing file.
+ This prevents spurious rebuilds based on unchanged files which have been regenerated by this
+ task.</p>
- <p>
- <em>Since Apache Ant 1.7</em>, this task can be used in a
- <a href="../Types/filterchain.html">filterchain</a>.
- </p>
+ <p><em>Since Apache Ant 1.7</em>, this task can be used in
+ a <a href="../Types/filterchain.html">filterchain</a>.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="center" rowspan="2"><b>Attribute</b></td>
- <td valign="center" rowspan="2"><b>Description</b></td>
- <td align="center" valign="top" colspan="2"><b>Required</b></td>
+ <th rowspan="2">Attribute</th>
+ <th rowspan="2">Description</th>
+ <th colspan="2">Required</th>
</tr>
<tr>
- <td valign="center"><b>As Task</b></td>
- <td valign="center"><b>As Filter</b></td>
+ <th>As Task</th>
+ <th>As Filter</th>
</tr>
<tr>
- <td valign="top">srcDir</td>
- <td valign="top">Where to find the files to be fixed up.</td>
- <td valign="top" align="center" rowspan="2">One of these</td>
- <td> </td>
+ <td>srcDir</td>
+ <td>Where to find the files to be fixed up.</td>
+ <td rowspan="2" class="center">One of these</td>
+ <td rowspan="11">N/A</td>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">Name of a single file to fix. <em>Since Ant 1.7</em></td>
- <td> </td>
+ <td>file</td>
+ <td class="left">Name of a single file to fix. <em>Since Ant 1.7</em></td>
</tr>
<tr>
- <td valign="top">destDir</td>
- <td valign="top">Where to place the corrected files. Defaults to
- srcDir (replacing the original file).</td>
- <td valign="top" align="center">No</td>
- <td> </td>
+ <td>destDir</td>
+ <td>Where to place the corrected files.</td>
+ <td class="center">No; defaults to <var>srcDir</var> (replace the original files)</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> </td>
+ <td>includes</td>
+ <td>comma- or space-separated list of patterns of files that must be included.</td>
+ <td class="center">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> </td>
+ <td>includesfile</td>
+ <td>name of a file. Each line of this file is taken to be an include pattern.</td>
+ <td class="center">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> </td>
+ <td>excludes</td>
+ <td>comma- or space-separated list of patterns of files that must be excluded.</td>
+ <td class="center">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> </td>
+ <td>excludesfile</td>
+ <td>name of a file. Each line of this file is taken to be an exclude pattern.</td>
+ <td class="center">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> </td>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
+ <td class="center">No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">The encoding of the files.</td>
- <td align="center">No; defaults to default JVM encoding.</td>
- <td> </td>
+ <td>encoding</td>
+ <td>The encoding of the files.</td>
+ <td class="center">No; defaults to default JVM character encoding</td>
</tr>
<tr>
- <td valign="top">outputencoding</td>
- <td valign="top">The encoding to use when writing the files.
- <em>Since Ant 1.7</em></td>
- <td align="center">No; defaults to the value of the encoding attribute.</td>
- <td> </td>
+ <td>outputencoding</td>
+ <td>The encoding to use when writing the files. <em>Since Ant 1.7</em></td>
+ <td class="center">No; defaults to <var>encoding</var> if set or default JVM character encoding
+ otherwise</td>
</tr>
<tr>
- <td valign="top">preservelastmodified</td>
- <td valign="top">Whether to preserve the last modified
- date of source files. <em>Since Ant 1.6.3</em></td>
- <td align="center">No; default is <i>false</i></td>
- <td> </td>
+ <td>preservelastmodified</td>
+ <td>Whether to preserve the last modified date of source files. <em>Since Ant 1.6.3</em></td>
+ <td class="center">No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">eol</td>
- <td valign="top">
- Specifies how end-of-line (EOL) characters are to be
- handled. The EOL characters are CR, LF and the pair CRLF.
- Valid values for this property are:
+ <td>eol</td>
+ <td>Specifies how end-of-line (EOL) characters are to be handled. The EOL characters are CR, LF
+ and the pair CRLF. Valid values for this property are:
<ul>
- <li>asis: leave EOL characters alone</li>
- <li>cr: convert all EOLs to a single CR</li>
- <li>lf: convert all EOLs to a single LF</li>
- <li>crlf: convert all EOLs to the pair CRLF</li>
- <li>mac: convert all EOLs to a single CR</li>
- <li>unix: convert all EOLs to a single LF</li>
- <li>dos: convert all EOLs to the pair CRLF</li>
+ <li><q>asis</q>: leave EOL characters alone</li>
+ <li><q>cr</q>: convert all EOLs to a single CR</li>
+ <li><q>lf</q>: convert all EOLs to a single LF</li>
+ <li><q>crlf</q>: convert all EOLs to the pair CRLF</li>
+ <li><q>mac</q>: convert all EOLs to a single CR</li>
+ <li><q>unix</q>: convert all EOLs to a single LF</li>
+ <li><q>dos</q>: convert all EOLs to the pair CRLF</li>
</ul>
- Default is based on the platform on which you are running this task.
- For Unix platforms (including Mac OS X), the default is "lf".
- For DOS-based systems (including Windows), the default is
- "crlf".
- For Mac environments other than OS X, the default is "cr".
- <p>
- This is the preferred method for specifying EOL. The
- "<i><b>cr</b></i>" attribute (see below) is
- now deprecated.
- </p>
- <p>
- <i>N.B.</i>: One special case is recognized. The three
- characters CR-CR-LF are regarded as a single EOL.
- Unless this property is specified as "asis",
- this sequence will be converted into the specified EOL
- type.
- </p>
+ <p>This is the preferred method for specifying EOL. The <var>cr</var> attribute (see below)
+ is now deprecated.</p>
+ <p><strong>Note</strong>: One special case is recognized. The three characters CR-CR-LF are
+ regarded as a single EOL. Unless this property is specified as <q>asis</q>, this sequence
+ will be converted into the specified EOL type.</p>
</td>
- <td valign="top" align="center" colspan="2">No</td>
+ <td colspan="2">No; default is platform-specific: <q>lf</q> for Unix platforms (including Mac OS
+ X/macOS), <q>crlf</q> for DOS-based systems (including Windows), <q>cr</q> for Mac environments
+ other than OS X</td>
</tr>
<tr>
- <td valign="top">cr</td>
- <td valign="top">
- <i><b>Deprecated.</b></i> Specifies how CR characters are
- to be handled at end-of-line (EOL). Valid values for this
- property are:
+ <td>cr</td>
+ <td><em><u>Deprecated</u></em>. Specifies how CR characters are to be handled at end-of-line
+ (EOL). Valid values for this property are:
<ul>
- <li>asis: leave EOL characters alone.</li>
- <li>
- add: add a CR before any single LF characters. The
- intent is to convert all EOLs to the pair CRLF.
- </li>
- <li>
- remove: remove all CRs from the file. The intent is
- to convert all EOLs to a single LF.
- </li>
+ <li><q>asis</q>: leave EOL characters alone.</li>
+ <li><q>add</q>: add a CR before any single LF characters. The intent is to convert all EOLs
+ to the pair CRLF.</li>
+ <li><q>remove</q>: remove all CRs from the file. The intent is to convert all EOLs to a
+ single LF.</li>
</ul>
- Default is based on the platform on which you are running
- this task. For Unix platforms, the default is "remove".
- For DOS based systems (including Windows), the default is
- "add".
- <p>
- <i>N.B.</i>: One special case is recognized. The three
- characters CR-CR-LF are regarded as a single EOL.
- Unless this property is specified as "asis",
- this sequence will be converted into the specified EOL
- type.
- </p>
+ <p><strong>Note</strong>: One special case is recognized. The three characters CR-CR-LF are
+ regarded as a single EOL. Unless this property is specified as <q>asis</q>, this sequence
+ will be converted into the specified EOL type.</p>
</td>
- <td valign="top" align="center" colspan="2">No</td>
+ <td colspan="2">No; default is platform-specific: <q>remove</q> for Unix platforms, <q>add</q>
+ for DOS based systems (including Windows)</td>
</tr>
<tr>
- <td valign="top">javafiles</td>
- <td valign="top">
- Used only in association with the
- "<i><b>tab</b></i>" attribute (see below), this
- boolean attribute indicates whether the fileset is a set
- of java source files
- ("yes"/"no"). Defaults to
- "no". See notes in section on "tab".
- </td>
- <td valign="top" align="center" colspan="2">No</td>
+ <td>javafiles</td>
+ <td>Used only in association with the <var>tab</var> attribute (see below), this boolean
+ attribute indicates whether the fileset is a set of Java source files (<q>yes|no</q>). See
+ notes in section on <var>tab</var>.</td>
+ <td colspan="2">No; defaults to <q>no</q></td>
</tr>
<tr>
- <td valign="top">tab</td>
- <td valign="top">Specifies how tab characters are to be handled. Valid
- values for this property are:
+ <td>tab</td>
+ <td>Specifies how tab characters are to be handled. Valid values for this property are:
<ul>
- <li>add: convert sequences of spaces which span a tab stop to tabs</li>
- <li>asis: leave tab and space characters alone</li>
- <li>remove: convert tabs to spaces</li>
+ <li><q>add</q>: convert sequences of spaces which span a tab stop to tabs</li>
+ <li><q>asis</q>: leave tab and space characters alone</li>
+ <li><q>remove</q>: convert tabs to spaces</li>
</ul>
- Default for this parameter is "asis".
- <p>
- <i>N.B.</i>: When the attribute
- "<i><b>javafiles</b></i>" (see above) is
- "true", literal TAB characters occurring
- within Java string or character constants are never
- modified. This functionality also requires the
- recognition of Java-style comments.
- </p>
- <p>
- <i>N.B.</i>: There is an incompatibility between this
- and the previous version in the handling of white
- space at the end of lines. This version does
- <i><b>not</b></i> remove trailing whitespace on lines.
- </p>
+ <p><strong>Note</strong>: When the attribute <var>javafiles</var> (see above) is <q>true</q>,
+ literal TAB characters occurring within Java string or character constants are never
+ modified. This functionality also requires the recognition of Java-style comments.</p>
+ <p><strong>Note</strong>: There is an incompatibility between this and the previous version in
+ the handling of white space at the end of lines. This version
+ does <em><strong>not</strong></em> remove trailing whitespace on lines.</p>
</td>
- <td valign="top" align="center" colspan="2">No</td>
+ <td colspan="2">No; default is <q>asis</q></td>
</tr>
<tr>
- <td valign="top">tablength</td>
- <td valign="top">TAB character interval. Valid values are between
- 2 and 80 inclusive. The default for this parameter is 8.</td>
- <td valign="top" align="center" colspan="2">No</td>
+ <td>tablength</td>
+ <td>TAB character interval. Valid values are between <q>2</q> and <q>80</q> inclusive.</td>
+ <td colspan="2">No; default is <q>8</q></td>
</tr>
<tr>
- <td valign="top">eof</td>
- <td valign="top">Specifies how DOS end of file (control-Z) characters are
- to be handled. Valid values for this property are:
+ <td>eof</td>
+ <td>Specifies how DOS end of file (control-Z) characters are to be handled. Valid values for
+ this property are:
<ul>
- <li>add: ensure that there is an EOF character at the end of the file</li>
- <li>asis: leave EOF characters alone</li>
- <li>remove: remove any EOF character found at the end</li>
+ <li><q>add</q>: ensure that there is an EOF character at the end of the file</li>
+ <li><q>asis</q>: leave EOF characters alone</li>
+ <li><q>remove</q>: remove any EOF character found at the end</li>
</ul>
- Default is based on the platform on which you are running this task.
- For Unix platforms, the default is remove. For DOS based systems
- (including Windows), the default is asis.
- </td>
- <td valign="top" align="center" colspan="2">No</td>
+ </td>
+ <td colspan="2">No; default is platform-specific: <q>remove</q> for Unix platforms, <q>asis</q>
+ for DOS based systems (including Windows)</td>
</tr>
<tr>
- <td valign="top">fixlast</td>
- <td valign="top">Whether to add a missing EOL to the last line
- of a processed file.<br/>Ignored if EOL is asis.<br/><em>Since Ant 1.6.1</em></td>
- <td align="center" colspan="2">No; default is <i>true</i></td>
+ <td>fixlast</td>
+ <td>Whether to add a missing EOL to the last line of a processed file.<br/>Ignored
+ if <var>eof</var> is <q>asis</q>.<br/><em>Since Ant 1.6.1</em></td>
+ <td colspan="2">No; default is <q>true</q></td>
</tr>
</table>
<h3>Examples</h3>
-<pre><fixcrlf srcdir="${src}" includes="**/*.sh"
- eol="lf" eof="remove" /></pre>
-<p>Replaces EOLs with LF characters and removes eof characters from
- the shell scripts. Tabs and spaces are left as is.</p>
-<pre><fixcrlf srcdir="${src}"
- includes="**/*.bat" eol="crlf" /></pre>
-<p>Replaces all EOLs with cr-lf pairs in the batch files.
- Tabs and spaces are left as is.
- EOF characters are left alone if run on
- DOS systems, and are removed if run on Unix systems.</p>
-<pre><fixcrlf srcdir="${src}"
- includes="**/Makefile" tab="add" /></pre>
-<p>Sets EOLs according to local OS conventions, and
- converts sequences of spaces and tabs to the minimal set of spaces and
- tabs which will maintain spacing within the line. Tabs are
- set at 8 character intervals. EOF characters are left alone if
- run on DOS systems, and are removed if run on Unix systems.
- Many versions of make require tabs prior to commands.</p>
- <pre><fixcrlf srcdir="${src}" includes="**/*.java"
+<pre>
+<fixcrlf srcdir="${src}" includes="**/*.sh"
+ eol="lf" eof="remove"/></pre>
+<p>Replaces EOLs with LF characters and removes eof characters from the shell scripts. Tabs and
+spaces are left as is.</p>
+<pre>
+<fixcrlf srcdir="${src}"
+ includes="**/*.bat" eol="crlf"/></pre>
+<p>Replaces all EOLs with cr-lf pairs in the batch files. Tabs and spaces are left as is. EOF
+characters are left alone if run on DOS systems, and are removed if run on Unix systems.</p>
+<pre>
+<fixcrlf srcdir="${src}"
+ includes="**/Makefile" tab="add"/></pre>
+<p>Sets EOLs according to local OS conventions, and converts sequences of spaces and tabs to the
+minimal set of spaces and tabs which will maintain spacing within the line. Tabs are set at 8
+character intervals. EOF characters are left alone if run on DOS systems, and are removed if run on
+Unix systems. Many versions of make require tabs prior to commands.</p>
+<pre>
+<fixcrlf srcdir="${src}" includes="**/*.java"
tab="remove" tablength="3"
- eol="lf" javafiles="yes" /></pre>
-<p>
- Converts all EOLs in the included java source files to a
- single LF. Replace all TAB characters except those in string
- or character constants with spaces, assuming a tab width of 3.
- If run on a unix system, any CTRL-Z EOF characters at the end
- of the file are removed. On DOS/Windows, any such EOF
- characters will be left untouched.
+ eol="lf" javafiles="yes"/></pre>
+<p>Converts all EOLs in the included Java source files to a single LF. Replace all TAB characters
+except those in string or character constants with spaces, assuming a tab width of 3. If run on a
+Unix system, any CTRL-Z EOF characters at the end of the file are removed. On DOS/Windows, any such
+EOF characters will be left untouched.
</p>
-<pre><fixcrlf srcdir="${src}"
- includes="**/README*" tab="remove" /></pre>
-<p>Sets EOLs according to local OS conventions, and
- converts all tabs to spaces, assuming a tab width of 8.
- EOF characters are left alone if run on
- DOS systems, and are removed if run on Unix systems.
- You never know what editor a user will use to browse READMEs.</p>
+<pre>
+<fixcrlf srcdir="${src}"
+ includes="**/README*" tab="remove"/></pre>
+<p>Sets EOLs according to local OS conventions, and converts all tabs to spaces, assuming a tab
+width of 8. EOF characters are left alone if run on DOS systems, and are removed if run on Unix
+systems. You never know what editor a user will use to browse READMEs.</p>
</body>
</html>