bodewig 00/08/10 08:58:05
Modified: docs index.html
Log:
documented the <execon> task.
Revision Changes Path
1.78 +98 -3 jakarta-ant/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/index.html,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -r1.77 -r1.78
--- index.html 2000/08/10 12:51:34 1.77
+++ index.html 2000/08/10 15:57:59 1.78
@@ -753,6 +753,7 @@
<li><a href="#deltree">Deltree</a></li>
<li><a href="#echo">Echo</a></li>
<li><a href="#exec">Exec</a></li>
+ <li><a href="#exec">ExecOn</a></li>
<li><a href="#filter">Filter</a></li>
<li><a href="#fixcrlf">FixCRLF</a></li>
<li><a href="#genkey">GenKey</a></li>
@@ -1453,6 +1454,99 @@
<p>adds <code>${basedir}/bin</code> to the <code>PATH</code> of the
system command.</p>
<hr>
+<h2><a name="exec">ExecOn</a></h2>
+<h3>Description</h3>
+<p>Executes a system command. When the <i>os</i> attribute is specified, then
+the command is only executed when Ant is run on one of the specified
operating
+systems.</p>
+<p>The files of a number of <a href="#fileset">FileSet</a>s are passed
+as arguments to the system command. At least one nested
+<code><fileset></code> or <code><filesetref></code> is
+required.</p>
+<h3>Parameters</h3>
+<table border="1" cellpadding="2" cellspacing="0">
+ <tr>
+ <td valign="top"><b>Attribute</b></td>
+ <td valign="top"><b>Description</b></td>
+ <td align="center" valign="top"><b>Required</b></td>
+ </tr>
+ <tr>
+ <td valign="top">executable</td>
+ <td valign="top">the command to execute without any command line
+ arguments.</b></td>
+ <td align="center" valign="top">Yes</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</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>
+ </tr>
+ <tr>
+ <td valign="top">output</td>
+ <td valign="top">the file to which the output of the command should be
+ redirected.</td>
+ <td align="center" valign="top">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>
+ </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>
+ </tr>
+ <tr>
+ <td valign="top">parallel</td>
+ <td valign="top">Run the command only once, appending all files as
+ arguments. Defaults to true. If false, command will be executed
+ once for every file.</td>
+ <td align="center" valign="top">No</td>
+ </tr>
+</table>
+<h3>Parameters specified as nested elements</h3>
+<h4>fileset and filesetref</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 via
+<code><filesetref></code> elements.</p>
+<h4>arg</h4>
+<p>Command line arguments should be specified as nested
+<code><arg></code> elements. See <a
+href="index.html#arg">Command line arguments</a>.</p>
+<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="#env">exec</a></p>
+<p>Please note that the environment of the current Ant process is
+<b>not</b> passed to the system command if you specify variables using
+<code><env></code>.</p>
+<h3>Examples</h3>
+<blockquote><pre>
+<execon executable="ls" >
+ <arg value="-l" />
+ <fileset dir="/tmp">
+ <patternset>
+ <exclude name="**/*.txt" />
+ </patternset>
+ </fileset>
+ <filesetref refid="other.files" />
+</execon>
+</pre></blockquote>
+<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>
+<hr>
<h2><a name="filter">Filter</a></h2>
<h3>Description</h3>
<p>Sets a token filter for this project. Token filters are used by all tasks
@@ -2008,7 +2102,7 @@
<td valign="top">jvmargs</td>
<td valign="top">the arguments to pass to the forked VM (ignored
if fork is disabled). <b>deprecated, use nested
- <code><arg></code> elements instead.</b></td>
+ <code><jvmarg></code> elements instead.</b></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
@@ -3399,6 +3493,7 @@
<h2><a name="untar">Untar</a></h2>
<h3>Description</h3>
<p>Untars a tarfile.</p>
+<p>File permissions will not be restored on extracted files.</a>
<p>For JDK 1.1 "last modified time" field is set to current time instead of
being
carried from tarfile.</p>
<h3>Parameters</h3>
@@ -3652,7 +3747,7 @@
<h2><a name="ftp">FTP</a></h2>
<h3><b>Description:</b></h3>
<p>Copies files from the local system to a remote ftp server.</p>
-<p>The <code>fileset</code> syntax must be used for specifying the local
+<p>The <a href="#fileset"><code>fileset</code></a> syntax must be used for
specifying the local
files to copy. All filesets will be copied into the single remote directory
specified by <i>remotedir</i>.</p>
<p>The ftp task makes no attempt to determine what file system syntax is
@@ -4148,7 +4243,7 @@
<h2><a name="script">Script</a></h2>
<h3><b>Description:</b></h3>
<p>Execute a script in a
- <a href="http://www.alphaworks.ibm.com/tech/bsf";>BSF</a> supported
language.
+ <a
href="http://oss.software.ibm.com/developerworks/opensource/bsf/";>BSF</a>
supported language.
<p>All items (tasks, targets, etc) of the running project are accessible
from the script.
<h3>Parameters:</h3>
