youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
Browse Source

Uniform style in manual pages

master
Gintas Grigelionis 7 years ago
parent
e0affbaa7c
commit
20537a88ed
5 changed files with 500 additions and 1025 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +1
    -1
      manual/Tasks/jspc.html
  2. +82
    -193
      manual/Tasks/makeurl.html
  3. +109
    -189
      manual/Tasks/setproxy.html
  4. +216
    -455
      manual/Tasks/subant.html
  5. +92
    -187
      manual/Tasks/tempfile.html

+ 1
- 1
manual/Tasks/jspc.html View File

@@ -24,7 +24,7 @@

<body>

<h2><a name="jspc">jspc (deprecated)</a></h2>
<h2 id="jspc">jspc</h2>
<h3><i>Deprecated</i></h3>
<p>
<i>If you use this task with Tomcat's Jasper JSP compiler, you should seriously


+ 82
- 193
manual/Tasks/makeurl.html View File

@@ -14,55 +14,21 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Makeurl Task</title>
</head>

<body bgcolor="#ffffff" text="#000000" link="#525D76"
alink="#525D76" vlink="#525D76">

<table border="0" width="100%" cellspacing="4">

<!-- PAGE HEADER -->
<tr>
<td>
<table border="0" width="100%"><tr>
<td valign="bottom">
<font size="+3" face="arial,helvetica,sanserif"><strong>Makeurl Task</strong></font>
</td>
<td>
<!-- PROJECT LOGO -->
<a href="http://ant.apache.org/">
<img src="../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0"/>
</a>
</td>
</tr></table>
</td>
</tr>

<!-- START RIGHT SIDE MAIN BODY -->
<tr>
<td valign="top" align="left">
<body>

<!-- Applying task/long-description -->
<!-- Start Description -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="description">
<strong>Description</strong></a></font>
</td></tr>

<tr><td><blockquote>
<h2>Makeurl Task</h2>
<h3 id="description">Description</h3>
This task takes one or more filenames and turns them into URLs, which it then assigns to a property.
Useful when setting up RMI or JNLP codebases, for example.
Nested filesets are supported; if present, these are turned into the URLs with the supplied separator between them (default: space).
<p/>
<p>Examples:</p>
<pre>
&lt;makeurl file="${user.home}/.m2/repository" property="m2.repository.url"/&gt;
@@ -72,163 +38,86 @@ Sets the property <code>m2.repository.url</code> to the file: URL of the local M
&lt;makeurl property="codebase"&gt;&lt;fileset dir="lib includes="*.jar"/&gt;&lt;/makeurl&gt;
</pre>
Set the property <code>codebase</code> to the three URLs of the files provided as nested elements.
</blockquote></td></tr>

</table>
<!-- End Description -->

<!-- Ignore -->



<!-- Start Attributes -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="attributes">
<strong>Parameters</strong></a></font>
</td></tr>
<tr><td><blockquote>
<table>
<tr>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font>
</td>
</tr>
<!-- Attribute Group -->
<!-- Attribute Group -->
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">file</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">name of a file to be converted into a URL</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">optional, if a nested fileset or path is supplied</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">property</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">name of a property to set to the URL</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">required</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">separator</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">separator for the multi-URL option</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">optional</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">validate</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">validate that every named file exists</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">optional; default: true</font>
</td>
</tr>


</table>
</blockquote></td></tr>

</table>
<!-- End Attributes -->

<!-- Start Elements -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="elements">
<strong>Parameters as nested elements</strong></a></font>
</td></tr>

<tr><td><blockquote>
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>fileset</strong> (org.apache.tools.ant.types.FileSet)</font>
</td></tr>
<tr><td><blockquote>
A fileset of JAR files to include in the URL list, each separated by the separator.
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>path</strong> (org.apache.tools.ant.types.Path)</font>
</td></tr>
<tr><td><blockquote>
Add a path to the URL. All elements in the path will be converted to individual URL entries.
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->

</blockquote></td></tr>

</table>
<!-- End Elements -->


<h3 id="attributes">Parameters</h3>
<table>
<tr>
<td valign="top" align="left">
<b>Attribute</b>
</td>
<td valign="top" align="left">
<b>Description</b>
</td>
<td valign="top" align="left">
<b>Type</b>
</td>
<td valign="top" align="left">
<b>Requirement</b>
</td>
</tr>
<tr>
<td valign="top" align="left">
file
</td>
<td valign="top" align="left">
name of a file to be converted into a URL
</td>
<td valign="top" align="left">
File
</td>
<td valign="top" align="left">
optional, if a nested fileset or path is supplied
</td>
</tr>
<tr>
<td valign="top" align="left">
property
</td>
<td valign="top" align="left">
name of a property to set to the URL
</td>
<td valign="top" align="left">
String
</td>
<td valign="top" align="left">
required
</td>
</tr>
<tr>
<td valign="top" align="left">
separator
</td>
<td valign="top" align="left">
separator for the multi-URL option
</td>
<td valign="top" align="left">
String
</td>
<td valign="top" align="left">
optional
</td>
</tr>
<tr>
<td valign="top" align="left">
validate
</td>
<td valign="top" align="left">
validate that every named file exists
</td>
<td valign="top" align="left">
boolean
</td>
<td valign="top" align="left">
optional; default: true
</td>
</tr>
<!-- END RIGHT SIDE MAIN BODY -->

</table>
<h3 id="elements">Parameters as nested elements</h3>
<h4><strong>fileset</strong> (org.apache.tools.ant.types.FileSet)</h4>

A fileset of JAR files to include in the URL list, each separated by the separator.

<h4><strong>path</strong> (org.apache.tools.ant.types.Path)</h4>

Add a path to the URL. All elements in the path will be converted to individual URL entries.
</body>
</html>

+ 109
- 189
manual/Tasks/setproxy.html View File

@@ -14,207 +14,127 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Setproxy Task</title>
</head>

<body bgcolor="#ffffff" text="#000000" link="#525D76"
alink="#525D76" vlink="#525D76">

<table border="0" width="100%" cellspacing="4">

<!-- PAGE HEADER -->
<body>
<h2>Setproxy Task</h2>

<h3 id="description">Description</h3>
Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites. You can nominate an http and ftp proxy, or a socks server, reset the server settings, or do nothing at all.

<h3>Examples</h3>
<pre>&lt;setproxy/&gt;</pre> do nothing
<pre>&lt;setproxy proxyhost="firewall"/&gt;</pre> set the proxy to firewall:80
<pre>&lt;setproxy proxyhost="firewall" proxyport="81"/&gt;</pre> set the proxy to firewall:81
<pre>&lt;setproxy proxyhost=""/&gt;</pre> stop using the http proxy; don't change the socks settings
<pre>&lt;setproxy socksproxyhost="socksy"/&gt;</pre> use socks via socksy:1080
<pre>&lt;setproxy socksproxyhost=""/&gt;</pre> stop using the socks server.
<p>
You can set a username and password for http with the <tt>proxyHost</tt> and <tt>proxyPassword</tt> attributes. On Java1.4 and above these can also be used against SOCKS5 servers.
</p>

<h3 id="attributes">Parameters</h3>
<table>
<tr>
<td>
<table border="0" width="100%"><tr>
<td valign="bottom">
<font size="+3" face="arial,helvetica,sanserif"><strong>Setproxy Task</strong></font>
<br><font face="arial,helvetica,sanserif">Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites.</font>
</td>
<td>
<!-- PROJECT LOGO -->
<a href="http://ant.apache.org/">
<img src="../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0">
</a>
</td>
</tr></table>
<td valign="top" align="left">
<b>Attribute</b>
</td>
<td valign="top" align="left">
<b>Description</b>
</td>
<td valign="top" align="left">
<b>Type</b>
</td>
<td valign="top" align="left">
<b>Requirement</b>
</td>
</tr>

<!-- START RIGHT SIDE MAIN BODY -->
<tr>
<td valign="top" align="left">

<!-- Applying task/long-description -->
<!-- Start Description -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="description">
<strong>Description</strong></a></font>
</td></tr>

<tr><td><blockquote>
Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites. You can nominate an http and ftp proxy, or a socks server, reset the server settings, or do nothing at all. <p> Examples <pre>&lt;setproxy/&gt;</pre> do nothing <pre>&lt;setproxy proxyhost="firewall"/&gt;</pre> set the proxy to firewall:80 <pre>&lt;setproxy proxyhost="firewall" proxyport="81"/&gt;</pre> set the proxy to firewall:81 <pre>&lt;setproxy proxyhost=""/&gt;</pre> stop using the http proxy; don't change the socks settings <pre>&lt;setproxy socksproxyhost="socksy"/&gt;</pre> use socks via socksy:1080 <pre>&lt;setproxy socksproxyhost=""/&gt;</pre> stop using the socks server. <p> You can set a username and password for http with the <tt>proxyHost</tt> and <tt>proxyPassword</tt> attributes. On Java1.4 and above these can also be used against SOCKS5 servers. </p>
</blockquote></td></tr>

</table>
<!-- End Description -->

<!-- Ignore -->



<!-- Start Attributes -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="attributes">
<strong>Parameters</strong></a></font>
</td></tr>
<tr><td><blockquote>
<table>
<tr>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font>
</td>
</tr>
<!-- Attribute Group -->
<!-- Attribute Group -->
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">nonproxyhosts</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">A list of hosts to bypass the proxy on. These should be separated with the vertical bar character '|'. Only in Java 1.4 does ftp use this list. e.g. fozbot.corp.sun.com|*.eng.sun.com</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left" rowspan="7">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Optional</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">proxyhost</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">the HTTP/ftp proxy host. Set this to "" for the http proxy option to be disabled</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">proxypassword</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the password for the proxy. Used only if the proxyUser is set.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">proxyport</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">the HTTP/ftp proxy port number; default is 80</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">int</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">proxyuser</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">set the proxy user. Probably requires a password to accompany this setting. Default=""</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">socksproxyhost</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">The name of a Socks server. Set to "" to turn socks proxying off.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">socksproxyport</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the ProxyPort for socks connections. The default value is 1080</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">int</font>
</td>
</tr>


</table>
</blockquote></td></tr>

</table>
<!-- End Attributes -->

<!-- Start Elements -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="elements">
<strong>Parameters as nested elements</strong></a></font>
</td></tr>

<tr><td><blockquote>

</blockquote></td></tr>

</table>
<!-- End Elements -->


<td valign="top" align="left">
nonproxyhosts
</td>
<td valign="top" align="left">
A list of hosts to bypass the proxy on. These should be separated with the vertical bar character '|'. Only in Java 1.4 does ftp use this list. e.g. fozbot.corp.sun.com|*.eng.sun.com
</td>
<td valign="top" align="left">
String
</td>
<td valign="top" align="left" rowspan="7">
Optional
</td>
</tr>
<tr>
<td valign="top" align="left">
proxyhost
</td>
<td valign="top" align="left">
the HTTP/ftp proxy host. Set this to "" for the http proxy option to be disabled
</td>
<td valign="top" align="left">
String
</td>
</tr>
<tr>
<td valign="top" align="left">
proxypassword
</td>
<td valign="top" align="left">
Set the password for the proxy. Used only if the proxyUser is set.
</td>
<td valign="top" align="left">
String
</td>
</tr>
<tr>
<td valign="top" align="left">
proxyport
</td>
<td valign="top" align="left">
the HTTP/ftp proxy port number; default is 80
</td>
<td valign="top" align="left">
int
</td>
</tr>
<tr>
<td valign="top" align="left">
proxyuser
</td>
<td valign="top" align="left">
set the proxy user. Probably requires a password to accompany this setting. Default=""
</td>
<td valign="top" align="left">
String
</td>
</tr>
<tr>
<td valign="top" align="left">
socksproxyhost
</td>
<td valign="top" align="left">
The name of a Socks server. Set to "" to turn socks proxying off.
</td>
<td valign="top" align="left">
String
</td>
</tr>
<tr>
<td valign="top" align="left">
socksproxyport
</td>
<td valign="top" align="left">
Set the ProxyPort for socks connections. The default value is 1080
</td>
<td valign="top" align="left">
int
</td>
</tr>
<!-- END RIGHT SIDE MAIN BODY -->

</table>

</body>
</html>

+ 216
- 455
manual/Tasks/subant.html View File

@@ -18,48 +18,13 @@
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Subant Task</title>
</head>

<body bgcolor="#ffffff" text="#000000" link="#525D76"
alink="#525D76" vlink="#525D76">

<table border="0" width="100%" cellspacing="4">

<!-- PAGE HEADER -->
<tr>
<td>
<table border="0" width="100%"><tr>
<td valign="bottom">
<font size="+3" face="arial,helvetica,sanserif"><strong>Subant Task</strong></font>
<br><font face="arial,helvetica,sanserif">Calls a given target for all defined sub-builds.</font>
</td>
<td>
<!-- PROJECT LOGO -->
<a href="http://ant.apache.org/">
<img src="../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0">
</a>
</td>
</tr></table>
</td>
</tr>

<!-- START RIGHT SIDE MAIN BODY -->
<tr>
<td valign="top" align="left">

<!-- Applying task/description -->
<!-- Start Description -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="description">
<strong>Description</strong></a></font>
</td></tr>

<tr><td><blockquote>
<body>
<h2>Subant Task</h2>
<h3 id="description">Description</h3>
<p>
Calls a given target for all defined sub-builds.
This is an extension
@@ -68,26 +33,20 @@
<strong>This task must not be used outside of a
<code>target</code> if it invokes the same build file it is
part of.</strong>
</p>
<p><em>Since Apache Ant 1.6</em></p>
</p>
<p><em>Since Apache Ant 1.6</em></p>

<p><code>subant</code> uses <code>ant</code> internally so many things
<p>
<code>subant</code> uses <code>ant</code> internally so many things
said in <a href="ant.html"><code>ant</code>'s manual page</a> apply
here as well.</p>
here as well.
</p>

<table border="0" cellspacing="0" cellpadding="2" width="100%">
<!-- Subsection heading -->
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="Use with directories">
<strong>Use with directories</strong></a></font>
</td></tr>
<!-- Subsection body -->
<tr><td>
<p>
<h3 id="Use with directories">Use with directories</h3>
<p>
subant can be used with directory sets to execute a build from different directories.
2 different options are offered :
</p>
</p>
<ul>
<li>
to run the same build file <code>/somepath/otherpath/mybuild.xml</code>
@@ -96,381 +55,196 @@
<li>if you want to run <code>directory1/mybuild.xml</code>, <code>directory2/mybuild.xml</code>, <code>....</code>,
use the antfile attribute. The subant task does not set the base directory for you in this case, because you can specify it in each build file.
</li>
</ul>

</td></tr>
</table>

</blockquote></td></tr>

</table>
<!-- End Description -->

<!-- Ignore -->

</ul>


<!-- Start Attributes -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="attributes">
<strong>Parameters</strong></a></font>
</td></tr>
<tr><td><blockquote>
<table>
<tr>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font>
</td>
</tr>
<!-- Attribute Group -->

<!-- Attribute Group -->
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">antfile</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Build file name, to use in conjunction with directories.<br> Defaults to "build.xml".<br> If <code>genericantfile</code> is set, this attribute is ignored.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left" rowspan="10">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Optional</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">buildpath</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Set the buildpath to be used to find sub-projects.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Path</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">buildpathref</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Buildpath to use, by reference.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Reference</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">failonerror</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets whether to fail with a build exception on error, or go on.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">genericantfile</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Build file path, to use in conjunction with directories.<br> Use <code>genericantfile</code>, in order to run the same build file with different basedirs.<br> If this attribute is set, <code>antfile</code> is ignored.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">inheritall</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1"
face="arial,helvetica,sanserif">Corresponds to
<code>&lt;ant&gt;</code>'s
<code>inheritall</code> attribute but defaults
to false in this task..</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">inheritrefs</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Corresponds to <code>&lt;ant&gt;</code>'s <code>inheritrefs</code> attribute.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">output</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Corresponds to <code>&lt;ant&gt;</code>'s <code>output</code> attribute.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">target</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"></font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
</tr>

<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">verbose</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
Enable/ disable log messages showing when each sub-build path is entered/ exited.
The default value is false.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
</td>
</tr>


</table>
</blockquote></td></tr>

</table>
<!-- End Attributes -->

<!-- Start Elements -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="elements">
<strong>Parameters as nested elements</strong></a></font>
</td></tr>

<tr><td><blockquote>
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>any filesystem based <a href="../Types/resources.html#collection">resource collection</a></strong></font>
</td></tr>
<tr><td><blockquote>
<h3 id="attributes">Parameters</h3>
<table>
<tr>
<td valign="top" align="left">
<b>Attribute</b>
</td>
<td valign="top" align="left">
<b>Description</b>
</td>
<td valign="top" align="left">
<b>Type</b>
</td>
<td valign="top" align="left">
<b>Requirement</b>
</td>
</tr>
<tr>
<td valign="top" align="left">
antfile
</td>
<td valign="top" align="left">
Build file name, to use in conjunction with directories.<br> Defaults to "build.xml".<br> If <code>genericantfile</code> is set, this attribute is ignored.
</td>
<td valign="top" align="left">
String
</td>
<td valign="top" align="left" rowspan="10">
Optional
</td>
</tr>
<tr>
<td valign="top" align="left">
buildpath
</td>
<td valign="top" align="left">
Set the buildpath to be used to find sub-projects.
</td>
<td valign="top" align="left">
Path
</td>
</tr>
<tr>
<td valign="top" align="left">
buildpathref
</td>
<td valign="top" align="left">
Buildpath to use, by reference.
</td>
<td valign="top" align="left">
Reference
</td>
</tr>
<tr>
<td valign="top" align="left">
failonerror
</td>
<td valign="top" align="left">
Sets whether to fail with a build exception on error, or go on.
</td>
<td valign="top" align="left">
boolean
</td>
</tr>
<tr>
<td valign="top" align="left">
genericantfile
</td>
<td valign="top" align="left">
Build file path, to use in conjunction with directories.<br> Use <code>genericantfile</code>, in order to run the same build file with different basedirs.<br> If this attribute is set, <code>antfile</code> is ignored.
</td>
<td valign="top" align="left">
File
</td>
</tr>
<tr>
<td valign="top" align="left">
inheritall
</td>
<td valign="top" align="left">
Corresponds to
<code>&lt;ant&gt;</code>'s
<code>inheritall</code> attribute but defaults
to false in this task..
</td>
<td valign="top" align="left">
boolean
</td>
</tr>
<tr>
<td valign="top" align="left">
inheritrefs
</td>
<td valign="top" align="left">
Corresponds to <code>&lt;ant&gt;</code>'s <code>inheritrefs</code> attribute.
</td>
<td valign="top" align="left">
boolean
</td>
</tr>
<tr>
<td valign="top" align="left">
output
</td>
<td valign="top" align="left">
Corresponds to <code>&lt;ant&gt;</code>'s <code>output</code> attribute.
</td>
<td valign="top" align="left">
String
</td>
</tr>
<tr>
<td valign="top" align="left">
target
</td>
<td valign="top" align="left">&nbsp;</td>
<td valign="top" align="left">
String
</td>
</tr>
<tr>
<td valign="top" align="left">
verbose
</td>
<td valign="top" align="left">
Enable/ disable log messages showing when each sub-build path is entered/ exited.
The default value is false.
</td>
<td valign="top" align="left">
boolean
</td>
</tr>
</table>
<h3 id="elements">Parameters as nested elements</h3>
<h4>any filesystem based <a href="../Types/resources.html#collection">resource collection</a></h4>
This includes <code>&lt;fileset&gt;</code>,
<code>&lt;dirset&gt;</code> and <code>&lt;filelist&gt;</code>
which are the nested resource collections supported prior
to Ant 1.7.
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>dirset</strong> (org.apache.tools.ant.types.DirSet)</font>
</td></tr>
<tr><td><blockquote>
Adds a directory set to the implicit build path. <p> <em>Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!</em>
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>filelist</strong> (org.apache.tools.ant.types.FileList)</font>
</td></tr>
<tr><td><blockquote>
Adds an ordered file list to the implicit build path. <p> <em>Note that contrary to file and directory sets, file lists can reference non-existent files or directories!</em>
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>fileset</strong> (org.apache.tools.ant.types.FileSet)</font>
</td></tr>
<tr><td><blockquote>
Adds a file set to the implicit build path. <p> <em>Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!</em>
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>property</strong> (org.apache.tools.ant.taskdefs.Property)</font>
</td></tr>
<tr><td><blockquote>
Corresponds to <code>&lt;ant&gt;</code>'s nested <code>&lt;property&gt;</code> element.

<p>When more than one nested <code>&lt;property&gt;</code> element
<h4><strong>dirset</strong> (org.apache.tools.ant.types.DirSet)</h4>
Adds a directory set to the implicit build path.
<p>
<em>Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!</em>
</p>
<h4><strong>filelist</strong> (org.apache.tools.ant.types.FileList)</h4>
Adds an ordered file list to the implicit build path.
<p>
<em>Note that contrary to file and directory sets, file lists can reference non-existent files or directories!</em>
</p>
<h4><strong>fileset</strong> (org.apache.tools.ant.types.FileSet)</h4>
Adds a file set to the implicit build path.
<p>
<em>Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead!</em>
</p>
<h4><strong>property</strong> (org.apache.tools.ant.taskdefs.Property)</h4>
Corresponds to <code>&lt;ant&gt;</code>'s nested <code>&lt;property&gt;</code> element.
<p>
When more than one nested <code>&lt;property&gt;</code> element
would set a property of the same name, the one declared last will
win. This is for backwards compatibility reasons even so it is
different from the way <code>&lt;property&gt;</code> tasks in build
files behave.</p>

<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>propertyset</strong> (org.apache.tools.ant.types.PropertySet)</font>
</td></tr>
<tr><td><blockquote>
files behave.
</p>
<h4><strong>propertyset</strong> (org.apache.tools.ant.types.PropertySet)</h4>
Corresponds to <code>&lt;ant&gt;</code>'s nested <code>&lt;propertyset&gt;</code> element.
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>buildpath</strong> (org.apache.tools.ant.types.Path)</font>
</td></tr>
<tr><td><blockquote>
<h4><strong>buildpath</strong> (org.apache.tools.ant.types.Path)</h4>
Creates a nested build path, and add it to the implicit build path.
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>buildpathelement</strong> (org.apache.tools.ant.types.Path.PathElement)</font>
</td></tr>
<tr><td><blockquote>
<h4><strong>buildpathelement</strong> (org.apache.tools.ant.types.Path.PathElement)</h4>
Creates a nested <code>&lt;buildpathelement&gt;</code>, and add it to the implicit build path.
<!-- Ignore -->
<!-- Ignore -->

</blockquote></td></tr>
</table>
<!-- End Element -->




<!-- manually written -->
<!-- Start Element -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica.sanserif" size="-1">
<strong>target</strong> (org.apache.tools.ant.taskdefs.Ant.TargetElement)</font>
</td></tr>
<tr><td><blockquote>
<h4><strong>target</strong> (org.apache.tools.ant.taskdefs.Ant.TargetElement)</h4>
You can specify multiple targets using nested <code>&lt;target&gt;</code> elements
instead of using the target attribute. These will be executed as if
Ant had been invoked with a single target whose dependencies are the
targets so specified, in the order specified.
<!-- Ignore -->
<!-- Ignore -->
<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">name</td>
<td valign="top">The name of the called target.</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<p><em>since Ant 1.7</em>.</p>
</blockquote></td></tr>
</table>
<!-- End Element -->
<!-- manually written end -->

</blockquote></td></tr>

</table>
<!-- End Elements -->



<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="examples">
<strong>Examples</strong></a></font>
</td></tr>

<tr><td><blockquote style="">
<pre>
<table>
<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">name</td>
<td valign="top">The name of the called target.</td>
<td valign="top" align="center">Yes</td>
</tr>
</table>
<p><em>since Ant 1.7</em>.</p>
<h3 id="examples">Examples</h3>
<pre>
&lt;project name="subant" default="subant1"&gt;
&lt;property name="build.dir" value="subant.build"/&gt;
&lt;target name="subant1"&gt;
@@ -481,12 +255,12 @@
&lt;/subant&gt;
&lt;/target&gt;
&lt;/project&gt;
</pre>
</pre>
<p>
this snippet build file will run ant in each subdirectory of the project directory,
where a file called build.xml can be found.
The property build.dir will have the value subant1.build in the ant projects called by subant.
</p>
</p>
<pre>
&lt;subant target=""&gt;
&lt;propertyset&gt;
@@ -495,27 +269,27 @@
&lt;/propertyset&gt;
&lt;fileset dir="." includes="*/build.xml"/&gt;
&lt;/subant&gt;
</pre>
</pre>
<p>
this snippet build file will run ant in each subdirectory of the project directory,
where a file called build.xml can be found.
All properties whose name starts with "foo" are passed, their names are changed to start with "bar" instead
</p>
</p>
<pre>
&lt;subant target="compile" genericantfile="/opt/project/build1.xml"&gt;
&lt;dirset dir="." includes="projects*"/&gt;
&lt;/subant&gt;
</pre>
</pre>
<p>
assuming the subdirs of the project dir are called projects1, projects2, projects3
this snippet will execute the compile target of /opt/project/build1.xml,
setting the basedir to projects1, projects2, projects3
</p>
<!-- manually written -->
<p>Now a little more complex - but useful - scenario. Assume that we have
a directory structure like this:</p>
<pre>
</p>
<p>
Now a little more complex - but useful - scenario. Assume that we have
a directory structure like this:
</p>
<pre>
root
| common.xml
| build.xml
@@ -542,7 +316,6 @@

<u><b>build.xml:</b></u><br>
&lt;project&gt;

&lt;macrodef name="iterate"&gt;
&lt;attribute name="target"/&gt;
&lt;sequential&gt;
@@ -564,45 +337,33 @@
&lt;project name="modA"&gt;
&lt;import file="../../common.xml"/&gt;
&lt;/project&gt;
</pre>
</pre>

<p>This results in very small buildfiles in the modules, maintainable
buildfile (common.xml) and a clear project structure. Additionally
the root buildfile is capable to run the whole build over all
modules.
</p>
<p>
This results in very small buildfiles in the modules, maintainable
buildfile (common.xml) and a clear project structure. Additionally
the root buildfile is capable to run the whole build over all
modules.
</p>

<pre>
<pre>
&lt;subant failonerror="false"&gt;
&lt;fileset dir="." includes="**/build.xml" excludes="build.xml"/&gt;
&lt;target name="clean"/&gt;
&lt;target name="build"/&gt;
&lt;/subant&gt;
</pre>
</pre>

<p>Does a &quot;clean build&quot; for each subproject.</p>
<p><b>Hint:</b> because buildfiles are plain xml, you could generate the
masterbuildfile from the common buildfile by using a XSLT transformation:
</p>
<p>Does a &quot;clean build&quot; for each subproject.</p>
<p>
<b>Hint:</b> because buildfiles are plain xml, you could generate the
masterbuildfile from the common buildfile by using a XSLT transformation:
</p>

<pre>
<pre>
&lt;xslt in=&quot;common.xml&quot;
out=&quot;master.xml&quot;
style=&quot;${ant.home}/etc/common2master.xsl&quot;
/&gt;
</pre>

<!-- manually written -->

</blockquote></td></tr>

</table>

</td>
</tr>
<!-- END RIGHT SIDE MAIN BODY -->

</table>

style=&quot;${ant.home}/etc/common2master.xsl&quot;/&gt;
</pre>
</body>
</html>

+ 92
- 187
manual/Tasks/tempfile.html View File

@@ -14,60 +14,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Tempfile Task</title>
</head>

<body bgcolor="#ffffff" text="#000000" link="#525D76"
alink="#525D76" vlink="#525D76">

<table border="0" width="100%" cellspacing="4">

<!-- PAGE HEADER -->
<tr>
<td>
<table border="0" width="100%"><tr>
<td valign="bottom">
<font size="+3" face="arial,helvetica,sanserif"><strong>Tempfile Task</strong></font>
<br><font face="arial,helvetica,sanserif">This task sets a property to the name of a temporary file.</font>
</td>
<td>
<!-- PROJECT LOGO -->
<a href="http://ant.apache.org/">
<img src="../images/ant_logo_large.gif" align="right" alt="Apache Ant" border="0">
</a>
</td>
</tr></table>
</td>
</tr>

<!-- START RIGHT SIDE MAIN BODY -->
<tr>
<td valign="top" align="left">

<!-- Applying task/long-description -->
<!-- Start Description -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="description">
<strong>Description</strong></a></font>
</td></tr>

<tr><td><blockquote>

<body>
<h2>Tempfile Task</h2>
<h3 id="description">Description</h3>
This task sets a property to the name of a temporary file.
Unlike <code>java.io.File.createTempFile</code>,
this task does not actually create the temporary file, but it does guarantee that the
file did not exist when the task was executed.

<p>Examples:

<h3>Examples:</h3>
<pre>&lt;tempfile property="temp.file"/&gt;</pre>

create a temporary file
@@ -79,151 +41,94 @@
<pre>&lt;tempfile property="temp.file" destDir="build"/&gt;</pre>

create a temporary file in the <code>build</code> subdirectory

</blockquote></td></tr>

</table>
<!-- End Description -->

<!-- Ignore -->



<!-- Start Attributes -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="attributes">
<strong>Parameters</strong></a></font>
</td></tr>
<tr><td><blockquote>
<table>
<tr>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Attribute</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Description</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Type</b></font>
</td>
<td bgcolor="#cccccc" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif"><b>Requirement</b></font>
</td>
</tr>
<!-- Attribute Group -->
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">property</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the property you wish to assign the temporary file to.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left" rowspan="1">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Required</font>
</td>
</tr>

<!-- Attribute Group -->
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">destdir</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the destination directory. If not set, the basedir directory is used instead.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">File</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left" rowspan="5">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Optional</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">prefix</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the optional prefix string for the temp file.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">suffix</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Sets the optional suffix string for the temp file.</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">String</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">deleteonexit</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default <em>false</em>. <strong>Since Apache Ant 1.7</strong></font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
</td>
</tr>
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">createfile</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">Whether the temp file should be created by this task; default <em>false</em>.<strong>Since Ant 1.8</strong></font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">boolean</font>
</td>
</tr>

</table>
</blockquote></td></tr>

</table>
<!-- End Attributes -->

<!-- Start Elements -->
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td>&nbsp;</td></tr>

<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica.sanserif">
<a name="elements">
<strong>Parameters as nested elements</strong></a></font>
</td></tr>

<tr><td><blockquote>

</blockquote></td></tr>

</table>
<!-- End Elements -->


<h3 id="attributes">Parameters</h3>
<table>
<tr>
<td valign="top" align="left">
<b>Attribute</b>
</td>
<td valign="top" align="left">
<b>Description</b>
</td>
<td valign="top" align="left">
<b>Type</b>
</td>
<td valign="top" align="left">
<b>Requirement</b>
</td>
</tr>
<tr>
<td valign="top" align="left">
property
</td>
<td valign="top" align="left">
Sets the property you wish to assign the temporary file to.
</td>
<td valign="top" align="left">
String
</td>
<td valign="top" align="left" rowspan="1">
Required
</td>
</tr>
<tr>
<td valign="top" align="left">
destdir
</td>
<td valign="top" align="left">
Sets the destination directory. If not set, the basedir directory is used instead.
</td>
<td valign="top" align="left">
File
</td>
<td valign="top" align="left" rowspan="5">
Optional
</td>
</tr>
<tr>
<td valign="top" align="left">
prefix
</td>
<td valign="top" align="left">
Sets the optional prefix string for the temp file.
</td>
<td valign="top" align="left">
String
</td>
</tr>
<tr>
<td valign="top" align="left">
suffix
</td>
<td valign="top" align="left">
Sets the optional suffix string for the temp file.
</td>
<td valign="top" align="left">
String
</td>
</tr>
<tr>
<td valign="top" align="left">
deleteonexit
</td>
<td valign="top" align="left">
Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default <em>false</em>. <strong>Since Apache Ant 1.7</strong>
</td>
<td valign="top" align="left">
boolean
</td>
</tr>
<tr>
<td valign="top" align="left">
createfile
</td>
<td valign="top" align="left">
Whether the temp file should be created by this task; default <em>false</em>.<strong>Since Ant 1.8</strong>
</td>
<td valign="top" align="left">
boolean
</td>
</tr>
<!-- END RIGHT SIDE MAIN BODY -->

</table>

</body>
</html>

Write Preview
Loading…
Cancel
Save