mirror of
https://github.com/apache/ant.git
synced 2025-05-18 14:04:48 +00:00
b6a3e9df36
(1) Make sure there is a Copyright notice on all visible files. (2) Make sure all years in which the file has been modified are listed. (3) Make sure the format is consistent, i.e. separate consecutive years with a dash, not a comma. When Stephane changed starteam.html it has been 2001 in France but 2002 in Australia - does that mean we add 2002 to the Copyright line or not? ;-) git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@270652 13f79535-47bb-0310-9956-ffa450edef68
90 lines
3.6 KiB
HTML
90 lines
3.6 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
<title>Ant User Manual</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h2><a name="input">Input</a></h2>
|
|
<h3>Description</h3>
|
|
<p>Allows user interaction during the build process by displaying a message and
|
|
reading a line of input from the console (System.in). The user will need to press
|
|
the Return key.
|
|
</p>
|
|
<p>The message displayed can be set via the message attribute
|
|
or as character data nested into the element.</p>
|
|
<p>Optinonally a set of valid imput arguments can be defined via the validargs
|
|
attribute. Input task will require the user to reenter values until the entered
|
|
value matches one of the predefined.</p>
|
|
<p>Optionally a property can be created from the value entered by the user. This
|
|
property can then be used during the following build run. Input behaves according
|
|
to <a href="property.html">property task</a> which means that existing properties
|
|
cannot be overriden.</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">message</td>
|
|
<td valign="top">the Message which gets displayed to the user during the build run.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">validargs</td>
|
|
<td valign="top">comma separated String containing valid input arguments. If set,
|
|
input task will reject any input not defined here and input task will
|
|
require the user to reenter arguments until the entered one matches one of the
|
|
predefined. Validargs are compared case sensitive. If you want 'a' and 'A' to
|
|
be accepted you will need to define both arguments within validargs.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">addproperty</td>
|
|
<td valign="top">the name of a property to be created from input. Behaviour is equal
|
|
to <a href="property.html">property task</a> which means that existing properties
|
|
cannot be overriden.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
</table>
|
|
<h3>Examples</h3>
|
|
<pre> <input/></pre>
|
|
<p>Will pause the build run until return key is pressed.</p>
|
|
<pre> <input>Press Return key to continue...</input></pre>
|
|
<p>Will display the message "Press Return key to continue..." and pause
|
|
the build run until return key is pressed.</p>
|
|
<pre> <input
|
|
message="Press Return key to continue..."
|
|
/></pre>
|
|
<p>Will display the message "Press Return key to continue..." and pause
|
|
the build run until return key is pressed.</p>
|
|
<pre>
|
|
<input
|
|
message="All data is going to be deleted from DB continue (y/n)?"
|
|
validargs="y,n"
|
|
addproperty="do.delete"
|
|
/>
|
|
<condition propert="do.abort">
|
|
<equals arg1="n" arg2="${do.delete}" />
|
|
</condition>
|
|
<fail if="do.abort">Build abborted by user.</fail>
|
|
</pre>
|
|
<p>Will display the message "All data is going to be deleted from DB continue
|
|
(y/n)?" and require 'y+retrun key' to continue build or 'n+return key'
|
|
to exit build with following message "Build abborted by user.".</p>
|
|
<pre> <input
|
|
message="Please enter db-username:"
|
|
addproperty="db.user"
|
|
/></pre>
|
|
<p>Will display the message "Please enter db-username:" and set the
|
|
property <code>db.user</code> to the value entered by the user.</p>
|
|
|
|
<hr>
|
|
<p align="center">Copyright © 2001 Apache Software Foundation. All rights
|
|
Reserved.</p>
|
|
</body>
|
|
</html> |