2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
2007-05-02 06:15:35 +00:00
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
|
|
|
|
<title>Apply Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<h2 id="apply">Apply</h2>
|
|
|
|
|
<p><em>The name <code>execon</code> is <u>deprecated</u> and only kept for backwards
|
|
|
|
|
compatibility.</em></p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Description</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2005-09-28 18:48:41 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-10-13 13:08:52 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-10-13 13:08:52 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<h4 id="background">Running Ant as a background process on Unix(-like) systems</h4>
|
2008-07-18 13:09:30 +00:00
|
|
|
|
2018-03-10 20:42:33 +01:00
|
|
|
<p>If you run Ant as a background process (like <kbd>ant &</kbd>) and use
|
2018-02-28 07:58:59 +01:00
|
|
|
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>
|
2008-07-18 13:09:30 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>executable</td>
|
|
|
|
|
<td>the command to execute without any command line arguments.</td>
|
|
|
|
|
<td>Yes</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2003-09-19 08:44:22 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>spawn</td>
|
2018-03-02 08:23:45 +01:00
|
|
|
<td>whether or not you want the commands to be spawned.<br/> If you spawn a command, its output
|
2018-02-28 07:58:59 +01:00
|
|
|
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>
|
2003-09-19 08:44:22 +00:00
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2001-11-21 17:20:29 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2001-11-21 17:20:29 +00:00
|
|
|
</tr>
|
2003-03-27 13:14:31 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-03-27 13:14:31 +00:00
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>os</td>
|
|
|
|
|
<td>list of Operating Systems on which the command may be executed.</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2005-04-19 22:28:22 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>osfamily</td>
|
|
|
|
|
<td>OS family as used in the <code><os></code> condition.
|
2005-04-19 22:28:22 +00:00
|
|
|
<em>since Ant 1.7</em></td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No</td>
|
2005-04-19 22:28:22 +00:00
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-09-19 08:44:22 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-09-19 08:44:22 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2002-09-26 13:55:28 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2002-09-26 13:55:28 +00:00
|
|
|
</tr>
|
2001-07-27 09:57:35 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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
|
2003-09-19 08:44:22 +00:00
|
|
|
output.</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No</td>
|
2003-09-19 08:44:22 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-09-19 08:44:22 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-09-19 08:44:22 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2001-07-27 09:57:35 +00:00
|
|
|
</tr>
|
2002-09-26 13:55:28 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2002-09-26 13:55:28 +00:00
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>timeout</td>
|
|
|
|
|
<td>Stop the command if it doesn't finish within the specified time (given in
|
|
|
|
|
milliseconds).</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>failonerror</td>
|
2018-03-02 08:23:45 +01:00
|
|
|
<td>Stop the build process if the command exits with a return code other than <q>0</q>.</td>
|
|
|
|
|
<td>No; defaults to <q>false</q></td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2002-09-26 13:55:28 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>failifexecutionfails</td>
|
|
|
|
|
<td>Stop the build if we can't start the program.</td>
|
|
|
|
|
<td>No; defaults to <q>true</q></td>
|
2002-09-26 13:55:28 +00:00
|
|
|
</tr>
|
2001-05-22 09:56:10 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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
|
2003-05-19 12:18:08 +00:00
|
|
|
well.</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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
|
2018-03-02 08:23:45 +01:00
|
|
|
are considered.<br/>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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
|
2018-03-10 20:17:33 +01:00
|
|
|
underlying OS's shell, either directly or through the <kbd>antRun</kbd> scripts, will be
|
2018-02-28 07:58:59 +01:00
|
|
|
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>.
|
2018-02-08 22:56:19 +01:00
|
|
|
<em>since Ant 1.6</em></td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No; default is <q>false</q></td>
|
2005-11-27 11:22:42 +00:00
|
|
|
</tr>
|
2003-05-19 12:18:08 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-05-19 12:18:08 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-05-19 12:18:08 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2003-05-19 12:18:08 +00:00
|
|
|
</tr>
|
2004-06-16 16:41:38 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2004-06-16 16:41:38 +00:00
|
|
|
</tr>
|
2004-11-16 20:58:22 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2004-11-16 20:58:22 +00:00
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
</table>
|
|
|
|
|
<h3>Parameters specified as nested elements</h3>
|
|
|
|
|
<h4>fileset</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2018-03-05 17:35:30 +01:00
|
|
|
|
2003-05-19 12:18:08 +00:00
|
|
|
<h4>filelist</h4>
|
2018-02-08 22:56:19 +01:00
|
|
|
<p><em>Since Ant 1.6</em></p>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2018-03-05 17:35:30 +01:00
|
|
|
|
2003-06-24 09:16:10 +00:00
|
|
|
<h4>dirset</h4>
|
2018-02-08 22:56:19 +01:00
|
|
|
<p><em>Since Ant 1.6</em></p>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2005-09-28 18:48:41 +00:00
|
|
|
|
2018-03-05 17:35:30 +01:00
|
|
|
<h4>Any other <a href="../Types/resources.html#collection">resource collection</a></h4>
|
2018-03-04 15:17:41 +01:00
|
|
|
<p><em>Since Ant 1.7</em></p>
|
2005-09-28 18:48:41 +00:00
|
|
|
<p>You can use any number of nested resource collections.</p>
|
|
|
|
|
|
2004-01-22 18:41:28 +00:00
|
|
|
<h4>mapper</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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
|
2005-01-25 22:13:47 +00:00
|
|
|
<code><fileset></code> or <code><filelist></code> is required.</p>
|
2018-03-05 17:35:30 +01:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h4>arg</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Command line arguments should be specified as nested <code><arg></code>
|
|
|
|
|
elements. See <a href="../using.html#arg">Command line arguments</a>.</p>
|
2018-03-05 17:35:30 +01:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h4>srcfile</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>By default the file names of the source files will be added to the end of the command line
|
2018-03-05 17:35:30 +01:00
|
|
|
(unless you set <var>addsourcefile</var> 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>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2009-06-29 09:41:37 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2009-06-29 09:41:37 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2009-06-29 09:41:37 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2009-06-29 09:41:37 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h4>targetfile</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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">
|
2009-06-29 09:41:37 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2009-06-29 09:41:37 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2009-06-29 09:41:37 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2009-06-29 09:41:37 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h4>env</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2004-03-27 21:22:59 +00:00
|
|
|
<h4>redirector</h4>
|
2018-02-08 22:56:19 +01:00
|
|
|
<em>Since Ant 1.6.2</em>
|
2018-02-28 07:58:59 +01:00
|
|
|
<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>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Examples</h3>
|
2018-05-15 09:51:58 +02:00
|
|
|
<p>Invoke <kbd>ls -l</kbd>, 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>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2002-09-04 11:05:19 +00:00
|
|
|
<apply executable="ls">
|
2001-07-12 12:06:45 +00:00
|
|
|
<arg value="-l"/>
|
|
|
|
|
<fileset dir="/tmp">
|
|
|
|
|
<patternset>
|
|
|
|
|
<exclude name="**/*.txt"/>
|
|
|
|
|
</patternset>
|
|
|
|
|
</fileset>
|
|
|
|
|
<fileset refid="other.files"/>
|
2018-02-28 07:58:59 +01:00
|
|
|
</apply></pre>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
|
<p>Invoke <kbd>somecommand arg1 SOURCEFILENAME arg2</kbd> 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 <q>true</q>, <code>SOURCEFILENAME</code> would be
|
|
|
|
|
replaced with the absolute filenames of all files separated by spaces.</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2002-09-04 11:05:19 +00:00
|
|
|
<apply executable="somecommand" parallel="false">
|
2001-07-12 12:06:45 +00:00
|
|
|
<arg value="arg1"/>
|
2001-09-30 13:21:54 +00:00
|
|
|
<srcfile/>
|
2001-07-12 12:06:45 +00:00
|
|
|
<arg value="arg2"/>
|
|
|
|
|
<fileset dir="/tmp"/>
|
|
|
|
|
</apply>
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
|
<p>Invoke <kbd>cc -c -o TARGETFILE SOURCEFILE</kbd> 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>
|
2018-02-09 06:54:03 +01:00
|
|
|
<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"/>
|
2018-02-28 07:58:59 +01:00
|
|
|
</apply></pre>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
|
<p>Apply the fictitious <kbd>processfile</kbd> 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 <code><apply></code> 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>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2004-03-27 21:22:59 +00:00
|
|
|
<mapper id="out" type="glob"
|
|
|
|
|
from="src${file.separator}*.file"
|
2004-11-19 09:07:12 +00:00
|
|
|
to="dest${file.separator}*.out"/>
|
2004-03-27 21:22:59 +00:00
|
|
|
|
|
|
|
|
<apply executable="processfile" dest="dest">
|
|
|
|
|
<fileset dir="src" includes="*.file"/>
|
2004-11-19 09:07:12 +00:00
|
|
|
<mapper refid="out"/>
|
2004-03-27 21:22:59 +00:00
|
|
|
<redirector>
|
2004-11-19 09:07:12 +00:00
|
|
|
<outputmapper refid="out"/>
|
2004-03-27 21:22:59 +00:00
|
|
|
</redirector>
|
2018-02-28 07:58:59 +01:00
|
|
|
</apply></pre>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
|
<p>Apply the <kbd>ls</kbd> executable to all directories in the <code>PATH</code>, effectively
|
|
|
|
|
listing all executables that are available on the <code>PATH</code>.</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2005-09-28 18:48:41 +00:00
|
|
|
<apply executable="ls" parallel="true"
|
|
|
|
|
force="true" dest="${basedir}" append="true" type="both">
|
|
|
|
|
<path>
|
|
|
|
|
<pathelement path="${env.PATH}"/>
|
|
|
|
|
</path>
|
|
|
|
|
<identitymapper/>
|
2018-02-28 07:58:59 +01:00
|
|
|
</apply></pre>
|
2004-03-27 21:22:59 +00:00
|
|
|
|
2018-05-15 09:51:58 +02:00
|
|
|
<p>Convert all JavaScript files in the <samp>src</samp> directory using the command <kbd>jsmin <
|
|
|
|
|
src/a.js > dest/a.js</kbd>. 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>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2005-11-27 11:22:42 +00:00
|
|
|
<apply executable="jsmin" addsourcefile="false">
|
|
|
|
|
<!-- Collect the JS-files -->
|
|
|
|
|
<fileset dir="src" includes="*.js"/>
|
|
|
|
|
<redirector>
|
|
|
|
|
<!-- redirect STDIN; fileset collects relative to its dir, but we need -->
|
|
|
|
|
<!-- relative to basedir -->
|
|
|
|
|
<inputmapper type="glob" from="*" to="src/*"/>
|
|
|
|
|
<!-- redirect STDOUT to file in dest-dir -->
|
|
|
|
|
<outputmapper id="out" type="glob" from="*.js" to="dest/*.js"/>
|
|
|
|
|
</redirector>
|
2018-02-28 07:58:59 +01:00
|
|
|
</apply></pre>
|
2005-11-27 11:22:42 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
</body>
|
2005-12-19 06:04:29 +00:00
|
|
|
</html>
|
