2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
|
|
|
<title>Ant User Manual</title>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2001-07-12 12:06:45 +00:00
|
|
|
<h2><a name="apply">Apply/<i>ExecOn</i></a></h2>
|
|
|
|
|
<p><i>The name execon is deprecated and only kept for backwards
|
|
|
|
|
compatibilty.</i></p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<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 and/or directories of a number of <a
|
2001-07-12 12:06:45 +00:00
|
|
|
href="../CoreTypes/fileset.html">FileSet</a>s are passed as arguments
|
|
|
|
|
to the system command.</p>
|
|
|
|
|
<p>If you specify a nested <a
|
|
|
|
|
href="../CoreTypes/mapper.html">mapper</a> and the destdir attribute,
|
|
|
|
|
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 destdir.</p>
|
|
|
|
|
<p>At least one fileset is required, you must not specify more than
|
|
|
|
|
one mapper.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<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.</td>
|
|
|
|
|
<td align="center" valign="top">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">dest</td>
|
2001-07-07 14:57:44 +00:00
|
|
|
<td valign="top">the directory where the <apply> expects the target files will be placed by the
|
|
|
|
|
command, when it is executed.
|
|
|
|
|
</td>
|
2001-07-12 12:06:45 +00:00
|
|
|
<td align="center" valign="top">Yes, if you specify a nested mapper</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</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>
|
2001-07-27 09:57:35 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">outputproperty</td>
|
|
|
|
|
<td valign="top">the name of a property in which the output of the
|
|
|
|
|
command should be stored.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
<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>
|
2001-05-22 09:56:10 +00:00
|
|
|
<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.</td>
|
|
|
|
|
<td align="center" valign="top">No, default is <i>false</i></td>
|
|
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
<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.
|
|
|
|
|
Defaults to false. </td>
|
|
|
|
|
<td align="center" valign="top">No</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.</td>
|
|
|
|
|
<td align="center" valign="top">No, default is <i>file</i></td>
|
|
|
|
|
</tr>
|
2001-07-12 12:06:45 +00:00
|
|
|
<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.</td>
|
|
|
|
|
<td align="center" valign="top">No, default is <i>true</i></td>
|
|
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
</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>
|
|
|
|
|
<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>
|
|
|
|
|
<h4>srcfile</h4>
|
|
|
|
|
<p>By default the file names of the source files will be added to the
|
|
|
|
|
end of the command line. 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>
|
|
|
|
|
<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
|
2001-07-12 12:06:45 +00:00
|
|
|
not be added to the command line at all. This element can only be
|
|
|
|
|
specified, if you also define a nested mapper and the destdir
|
|
|
|
|
attribute.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<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>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>
|
2001-07-12 12:06:45 +00:00
|
|
|
<apply executable="ls" >
|
|
|
|
|
<arg value="-l"/>
|
|
|
|
|
<fileset dir="/tmp">
|
|
|
|
|
<patternset>
|
|
|
|
|
<exclude name="**/*.txt"/>
|
|
|
|
|
</patternset>
|
|
|
|
|
</fileset>
|
|
|
|
|
<fileset refid="other.files"/>
|
|
|
|
|
</apply>
|
|
|
|
|
</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>
|
|
|
|
|
<blockquote><pre>
|
|
|
|
|
<apply executable="somecommand" parallel="false" >
|
|
|
|
|
<arg value="arg1"/>
|
|
|
|
|
<srfile/>
|
|
|
|
|
<arg value="arg2"/>
|
|
|
|
|
<fileset dir="/tmp"/>
|
|
|
|
|
</apply>
|
|
|
|
|
</pre></blockquote>
|
|
|
|
|
<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>
|
|
|
|
|
<blockquote><pre>
|
2001-02-13 12:32:01 +00:00
|
|
|
<apply executable="cc" dest="src/C" parallel="false">
|
|
|
|
|
<arg value="-c"/>
|
|
|
|
|
<arg value="-o"/>
|
|
|
|
|
<targetfile/>
|
|
|
|
|
<srcfile/>
|
|
|
|
|
<fileset dir="src/C" includes="*.c"/>
|
|
|
|
|
<mapper type="glob" from="*.c" to="*.o"/>
|
|
|
|
|
</apply>
|
|
|
|
|
</pre></blockquote>
|
|
|
|
|
<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>
|
|
|
|
|
<hr><p align="center">Copyright © 2000,2001 Apache Software Foundation. All rights
|
|
|
|
|
Reserved.</p>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
