blob: 0a32304bfb1364dc818e74e732615fa50b8212bf [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
<HEAD>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
<title>Ant Runtime Preferences</title>
</HEAD>
<BODY>
<h1>Ant Runtime Preferences</h1>
<p>
The following preferences can be changed on the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ant.ui.AntRuntimePreferencePage)")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.png" alt="command link">
<strong>Ant &gt; Runtime</strong></a> preference page.
</p>
<h2>Classpath options</h2>
<p>
On the Classpath tab you can add additional classes defining tasks and types to the Ant classpath. New tasks and types
can be added to either the Ant Home or the Global Entries section(s). The Contributed Entries section cannot be modified.
</p>
<table border="1" cellspacing="0" width="80%">
<thead>
<tr>
<th width="25%">Option</th>
<th>Description</th>
<th width="8%">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>Add Jars...</td>
<td>Allows you to add a <code>jar</code> file from the current workspace to the Ant classpath for the Ant Home and / or Global sections.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Add External Jars...</td>
<td>Allows you to add a <code>jar</code> file from the local filesystem to the Ant classpath for the Ant Home and / or Global sections.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Add Folder...</td>
<td>Allows you to add a folder from the local filesystem to the Ant classpath for the Ant Home and / or Global sections.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Add Variable...</td>
<td>Allows you to add a new classpath variable to the Ant Home and / or Global sections.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Ant Home</td>
<td>Allows you to add a new folder to the Ant Home location.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Remove</td>
<td>Allows you to remove the selected entry element(s) from the Ant classpath for the Ant Home and / or Global sections.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Up</td>
<td>Allows you to move the selected entry element up one space in its listing.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Down</td>
<td>Allows you to move the selected entry element down one space in its listing.</td>
<td align="center">&nbsp;</td>
</tr>
</tbody>
</table>
<p>
Here is what the Classpath tab of the Ant Runtime preferences page looks like:
</p>
<p>
<img src="../images/ant_runtime_classpath.png" alt="Ant classpath preference tab" border="0">
</p>
<h2>Tasks options</h2>
<p>
On the Tasks tab you can add tasks defined in one of the classes on the Ant classpath.
</p>
<table border="1" cellspacing="0" width="80%">
<thead>
<tr>
<th width="25%">Option</th>
<th>Description</th>
<th width="8%">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>Add Task...</td>
<td>Allows you to add a new Ant task definition to the runtime.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Edit Task...</td>
<td>Allows you to edit an existing Ant task. <br><br>
Note: you can only edit tasks that are not contributed (i.e. yellow decorated tasks are contributed
and cannot be edited).</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Remove</td>
<td>Allows you to remove an existing Ant task from the runtime. <br><br>
Note: you can only remove tasks that are not contributed (i.e. yellow decorated tasks are contributed
and cannot be removed).</td>
<td align="center">&nbsp;</td>
</tr>
</tbody>
</table>
<p>
Here is what the Tasks tab of the Ant Runtime preferences page looks like:
</p>
<p>
<img src="../images/ant_runtime_tasks.png" alt="Ant tasks preference page" border="0">
</p>
<h2>Types options</h2>
<p>
On the Types tab you can add types defined in one of the classes on the classpath.
</p>
<table border="1" cellspacing="0" width="80%">
<thead>
<tr>
<th width="25%">Option</th>
<th>Description</th>
<th width="8%">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>Add Type...</td>
<td>Allows you to add a new type defined in one of the classes on the Ant classpath.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Edit Type...</td>
<td>Allows you to edit an existing type.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Remove</td>
<td>Allows you to remove an existing type.</td>
<td align="center">&nbsp;</td>
</tr>
</tbody>
</table>
<p>
Here is what the Types tab of the Ant Runtime preferences page looks like:
</p>
<p>
<img src="../images/ant_runtime_types.png" alt="Ant types preference page" border="0" >
</p>
<h2>Properties options</h2>
<p>
On the Properties tab you can add properties and property files that will be passed into Ant.
</p>
<table border="1" cellspacing="0" width="80%">
<thead>
<tr>
<th width="25%">Option</th>
<th>Description</th>
<th width="8%">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>Add Property...</td>
<td>Allows you to add a new Ant property to the runtime.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Edit Property...</td>
<td>Allows you to edit an existing Ant property. <br><br>
Note: you can only edit properties that are not contributed (i.e. yellow decorated properties are contributed
and cannot be edited).</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Remove</td>
<td>Allows you to remove an existing Ant property from the runtime. <br><br>
Note: you can only remove properties that are not contributed (i.e. yellow decorated properties are contributed
and cannot be removed).</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Add Files...</td>
<td>Allows you to add a <code>*.properties</code> file from the workspace to be used in the runtime.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Add External...</td>
<td>Allows you to add a <code>*.properties</code> file from the local filesystem to be used in the runtime.</td>
<td align="center">&nbsp;</td>
</tr>
<tr>
<td>Remove</td>
<td>Allows you to remove an existing <code>*.properties</code> file from the runtime.</td>
<td align="center">&nbsp;</td>
</tr>
</tbody>
</table>
<p>
Here is what the Properties tab of the Ant Runtime preferences page looks like:
</p>
<p>
<img src="../images/ant_runtime_properties.png" alt="Ant properties preference page" border="0">
</p>
<p>
<img border="0" src="../images/ngrelc.png" alt="Related concepts" ><br>
<a href="../concepts/concepts-antsupport.htm">Ant support</a>
</p>
<p>
<img border="0" src="../images/ngrelr.png" alt="Related reference" ><br>
<a href="../reference/ref-antprefs.htm">General Ant preferences</a><br>
<a href="../reference/ref-anteditorprefs.htm">Ant editor preferences</a><br>
<a href="../reference/ref-antformatter.htm">Ant formatter preferences</a><br>
<a href="../reference/ref-anttemplates.htm">Ant templates preferences</a>
</p>
</BODY>
</HTML>