blob: 18c18b9c5d7b301c0dbec8b887d32acff1e4a87b [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Ant User Manual</title>
</head>
<body>
<h2><a name="Splash">Splash</a></h2>
<p>by Les Hughes (leslie.hughes@rubus.com)
<h3>Description</h3>
<p>This task creates a splash screen. The splash screen is displayed
for the duration of the build and includes a handy progress bar as
well. Use in conjunction with the sound task to provide interest
whilst waiting for your builds to complete...</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>
<td align="center" valign="top"><b>Default</b></td>
</tr>
<tr>
<td valign="top">imageurl</td>
<td valign="top">A URL pointing to an image to display.</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">antlogo.gif from the classpath</td>
</tr>
<tr>
<td valign="top">useproxy</td>
<td valign="top">Use a proxy to access imgurl. Note: Only tested
on JDK 1.2.2 and above</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">proxy</td>
<td valign="top">IP or hostname of the proxy server</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">port</td>
<td valign="top">Proxy portnumber</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">user</td>
<td valign="top">User to authenticate to the proxy as.</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">password</td>
<td valign="top">Proxy password</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">None</td>
</tr>
<tr>
<td valign="top">showduration</td>
<td valign="top">Initial period to pause the build to show the
splash in milliseconds.</td>
<td valign="top" align="center">No</td>
<td valign="top" align="center">5000 ms</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote><pre>
&lt;splash/&gt;
</pre></blockquote>
<p>Splash <code>images/ant_logo_large.gif</code> from the classpath.</p>
<blockquote><pre>
&lt;splash imageurl=&quot;http://jakarta.apache.org/images/jakarta-logo.gif&quot;
useproxy=&quot;true&quot;
showduration=&quot;5000&quot;
proxy=&quot;proxy.mydomain.com&quot;
port=&quot;8080&quot;
user=&quot;BuildEng&quot;
password=&quot;LetMePass&quot;/>
</pre></blockquote>
<p>Splashes the jakarta logo, via a connection through the proxy at
proxy.mydomain.com on port 8080 (as user BuildEng/LetMePass) for
an initial period of 5 seconds.</p>
<hr>
<p align="center">Copyright &copy; 2002 Apache Software Foundation. All rights
Reserved.</p>
</body>
</html>