blob: 3a741d97af3b1b288df425b27cfb68d7815ae686 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2005, 2011 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
IBM Corporation - initial API and implementation
-->
<tasks>
<task name="ant" catgory="control" classname="org.apache.tools.ant.taskdefs.Ant">
<description>
Build a sub-project.
&lt;pre&gt;
&amp;lt;target name=&amp;quot;foo&amp;quot; depends=&amp;quot;init&amp;quot;&amp;gt;
&amp;lt;ant antfile=&amp;quot;build.xml&amp;quot; target=&amp;quot;bar&amp;quot; &amp;gt;
&amp;lt;property name=&amp;quot;property1&amp;quot; value=&amp;quot;aaaaa&amp;quot; /&amp;gt;
&amp;lt;property name=&amp;quot;foo&amp;quot; value=&amp;quot;baz&amp;quot; /&amp;gt;
&amp;lt;/ant&amp;gt;&lt;/SPAN&gt;
&amp;lt;/target&amp;gt;&lt;/SPAN&gt;
&amp;lt;target name=&amp;quot;bar&amp;quot; depends=&amp;quot;init&amp;quot;&amp;gt;
&amp;lt;echo message=&amp;quot;prop is ${property1} ${foo}&amp;quot; /&amp;gt;
&amp;lt;/target&amp;gt;
&lt;/pre&gt;
</description>
<structure>
<attributes>
<attribute name="antfile" required="no">
<description>
The buildfile to use.
Defaults to "build.xml". This file is expected to be a filename relative
to the dir attribute given.
</description>
</attribute>
<attribute name="dir" required="no">
<description>
The directory to use as a base directory for the new Ant project.
Defaults to the current project's basedir, unless inheritall
has been set to false, in which case it doesn't have a default
value. This will override the basedir setting of the called project.
</description>
</attribute>
<attribute name="inheritall" required="no">
<description>
If true, pass all properties to the new Ant project.
Defaults to true.
</description>
</attribute>
<attribute name="inheritrefs" required="no">
<description>
If true, pass all references to the new Ant project.
Defaults to false.
</description>
</attribute>
<attribute name="output" required="no">
<description>
Filename to write the output to.
This is relative to the value of the dir attribute
if it has been set or to the base directory of the
current project otherwise.
</description>
</attribute>
<attribute name="target" required="no">
<description>
The target of the new Ant project to execute.
Defaults to the new project's default target.
</description>
</attribute>
</attributes>
<elements>
<element name="reference" required="NOTDEFINED">
<description>
Reference element identifying a data type to carry
over to the new project.
</description>
</element>
<element name="property" required="NOTDEFINED">
<description>
Property to pass to the new project.
The property is passed as a 'user property'
</description>
</element>
</elements>
</structure>
</task>
<task name="antcall">
<description>
Call another target in the same project.
&lt;pre&gt;
&amp;lt;target name="foo"&amp;gt;
&amp;lt;antcall target="bar"&amp;gt;
&amp;lt;param name="property1" value="aaaaa" /&amp;gt;
&amp;lt;param name="foo" value="baz" /&amp;gt;
&amp;lt;/antcall&amp;gt;
&amp;lt;/target&amp;gt;
&amp;lt;target name="bar" depends="init"&amp;gt;
&amp;lt;echo message="prop is ${property1} ${foo}" /&amp;gt;
&amp;lt;/target&amp;gt;
&lt;/pre&gt;
&lt;p&gt;This only works as expected if neither property1 nor foo are
defined in the project itself.
</description>
<structure>
<attributes>
<attribute name="inheritall" required="no">
<description>
If true, pass all properties to the new Ant project.
Defaults to true.
</description>
</attribute>
<attribute name="inheritrefs" required="no">
<description>
If true, pass all references to the new Ant project.
Defaults to false
</description>
</attribute>
<attribute name="target" required="yes">
<description>
Target to execute, required.
</description>
</attribute>
</attributes>
<elements>
<element name="reference" required="NOTDEFINED">
<description>
Reference element identifying a data type to carry over to the invoked target.
</description>
</element>
<element name="param" required="NOTDEFINED">
<description>
Property to pass to the invoked target.
</description>
</element>
<element name="propertyset" required="NOTDEFINED">
<description>
You can specify a set of properties to be copied into the new project with propertysets.
</description>
</element>
<element name="target" required="NOTDEFINED">
<description>
You can specify multiple targets using nested &amp;lt;target&amp;gt; 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.
</description>
</element>
</elements>
</structure>
</task>
<task name="antlr">
<description>
Invokes the ANTLR Translator generator on a grammar file.
</description>
<structure>
<attributes>
<attribute name="debug" required="no">
<description>
Sets a flag to enable ParseView debugging
</description>
</attribute>
<attribute name="diagnostic" required="no">
<description>
Sets a flag to emit diagnostic text
</description>
</attribute>
<attribute name="dir" required="no">
<description>
The working directory of the process
</description>
</attribute>
<attribute name="glib" required="no">
<description>
Sets an optional super grammar file.
</description>
</attribute>
<attribute name="html" required="no">
<description>
If true, emit html
</description>
</attribute>
<attribute name="outputdirectory" required="no">
<description>
The directory to write the generated files to.
</description>
</attribute>
<attribute name="target" required="yes">
<description>
The grammar file to process.
</description>
</attribute>
<attribute name="trace" required="no">
<description>
If true, enables all tracing.
</description>
</attribute>
<attribute name="tracelexer" required="no">
<description>
If true, enables lexer tracing.
</description>
</attribute>
<attribute name="traceparser" required="no">
<description>
If true, enables parser tracing.
</description>
</attribute>
<attribute name="tracetreewalker" required="no">
<description>
Sets a flag to allow the user to enable tree walker tracing.
</description>
</attribute>
</attributes>
<elements>
<element name="classpath" required="NOTDEFINED">
<description>
Adds a classpath to be set
because a directory might be given for Antlr debug.
</description>
</element>
<element name="jvmarg" required="NOTDEFINED">
<description>
Adds a new JVM argument.
</description>
</element>
</elements>
</structure>
</task>
<task name="antstructure">
<description>
Creates a partial DTD for Ant from the currently known tasks.
</description>
<structure>
<attributes>
<attribute name="output" required="yes">
<description>
The output file.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="apply">
<description>
Executes a given command, supplying a set of files as arguments.
</description>
<structure>
<attributes>
<attribute name="append" required="NOTDEFINED">
<description>
Whether output should be appended to or overwrite an existing file.
Defaults to false.
</description>
</attribute>
<attribute name="dest" required="yes, if you specify a nested mapper">
<description>
The directory where target files are to be placed.
</description>
</attribute>
<attribute name="dir" required="no">
<description>
The working directory of the process.
</description>
</attribute>
<attribute name="executable" required="yes">
<description>
The command to execute.
</description>
</attribute>
<attribute name="failifexecutionfails" required="NOTDEFINED">
<description>
Stop the build if program cannot be started. Defaults to true.
</description>
</attribute>
<attribute name="failonerror" required="no">
<description>
Fail if the command exits with a non-zero return code.
</description>
</attribute>
<attribute name="newenvironment" required="no, default is false">
<description>
Do not propagate old environment when new environment variables are specified.
</description>
</attribute>
<attribute name="os" required="no">
<description>
List of operating systems on which the command may be executed.
</description>
</attribute>
<attribute name="output" required="no">
<description>
File the output of the process is redirected to.
</description>
</attribute>
<attribute name="outputproperty" required="no">
<description>
Property name whose value should be set to the output of
the process.
</description>
</attribute>
<attribute name="parallel" required="no">
<description>
If true, run the command only once, appending all files as arguments.
If false, command will be executed once for every file. Defaults to false.
</description>
</attribute>
<attribute name="relative" required="no, default is false">
<description>
Whether the filenames should be passed on the command line as
absolute or relative pathnames. Paths are relative to the base
directory of the corresponding fileset for source files or the
dest attribute for target files.
</description>
</attribute>
<attribute name="resultproperty" required="NOTDEFINED">
<description>
The name of a property in which the return code of the
command should be stored. Only of interest if failonerror=false.
</description>
</attribute>
<attribute name="skipemptyfilesets" required="no, default is false">
<description>
If no source files have been found or are newer than their
corresponding target files, do not run the command.
</description>
</attribute>
<attribute name="type" required="no, default is file">
<description>
Whether the command works only on files, directories or both?
</description>
</attribute>
<attribute name="vmlauncher" required="no, default is true">
<description>
If true, launch new process with VM, otherwise use the OS's shell.
</description>
</attribute>
</attributes>
<elements>
<element name="env" required="NOTDEFINED">
<description>
Add an environment variable to the launched process.
</description>
</element>
<element name="fileset" required="NOTDEFINED">
<description>
Source files to operate upon.
</description>
</element>
<element name="arg" required="NOTDEFINED">
<description>
Adds a command-line argument.
</description>
</element>
<element name="mapper" required="NOTDEFINED">
<description>
Mapper to use for mapping source files to target files.
</description>
</element>
<element name="srcfile" required="NOTDEFINED">
<description>
Marker that indicates where the name of the source file should
be put on the command line.
</description>
</element>
<element name="targetfile" required="NOTDEFINED">
<description>
Marker that indicates where the name of the target file should
be put on the command line.
</description>
</element>
</elements>
</structure>
</task>
<task name="available">
<description>
Will set the given property if the requested resource is available at
runtime. This task may also be used as a condition by the condition task.
</description>
<structure>
<attributes>
<attribute name="classname" required="yes">
<description>
Set a classname of a class which must be available to set the given
property.
</description>
</attribute>
<attribute name="classpath" required="no">
<description>
Set the classpath to be used when searching for classes and resources.
</description>
</attribute>
<attribute name="classpathref" required="no">
<description>
Set the classpath by reference.
</description>
</attribute>
<attribute name="file" required="">
<description>
Set the file which must be present in the file system to set the given
property.
</description>
</attribute>
<attribute name="filepath" required="no">
<description>
Set the path to use when looking for a file.
</description>
</attribute>
<attribute name="ignoresystemclasses" required="no">
<description>
Set whether the search for classes should ignore the runtime classes and
just use the given classpath.
</description>
</attribute>
<attribute name="property" required="yes">
<description>
Set the name of the property which will be set if the particular resource
is available.
</description>
</attribute>
<attribute name="resource" required="">
<description>
Set the name of a Java resource which is required to set the property.
</description>
</attribute>
<attribute name="type" required="no">
<description>
Set what type of file is required - either directory or file.
</description>
</attribute>
<attribute name="value" required="no">
<description>
Set the value to be given to the property if the desired resource is
available.
</description>
</attribute>
</attributes>
<elements>
<element name="classpath" required="NOTDEFINED">
<description>
Classpath to be used when searching for classes and resources.
</description>
</element>
<element name="filepath" required="NOTDEFINED">
<description>
Path to search for file resources.
</description>
</element>
</elements>
</structure>
</task>
<task name="basename">
<description>
Sets a property to the base name of a specified file, optionally minus a
suffix.
This task can accept the following attributes:
&lt;ul&gt;
&lt;li&gt;file
&lt;li&gt;property
&lt;li&gt;suffix
&lt;/ul&gt;
The &lt;b&gt;file&lt;/b&gt; and &lt;b&gt;property&lt;/b&gt; attributes are required. The
&lt;b&gt;suffix&lt;/b&gt; attribute can be specified either with or without
the &amp;quot;.&amp;quot;, and the result will be the same (ie., the
returned file name will be minus the .suffix).
&lt;p&gt;
When this task executes, it will set the specified property to the
value of the last element in the specified file. If file is a
directory, the basename will be the last directory element. If file
is a full-path filename, the basename will be the simple file name.
If a suffix is specified, and the specified file ends in that suffix,
the basename will be the simple file name without the suffix.
</description>
<structure>
<attributes>
<attribute name="file" required="yes">
<description>
File or directory to get base name from.
</description>
</attribute>
<attribute name="property" required="yes">
<description>
Property to set base name to.
</description>
</attribute>
<attribute name="suffix" required="no">
<description>
Optional suffix to remove from base name.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="blgenclient">
<description>
Generates a Borland Application Server 4.5 client JAR using as
input the EJB JAR file.
Two mode are available: java mode (default) and fork mode. With the fork mode,
it is impossible to add classpath to the commmand line.
</description>
<structure>
<attributes>
<attribute name="classpath" required="NOTDEFINED">
<description>
Path to use for classpath.
</description>
</attribute>
<attribute name="classpathref" required="NOTDEFINED">
<description>
Reference to existing path, to use as a classpath.
</description>
</attribute>
<attribute name="clientjar" required="NOTDEFINED">
<description>
Client JAR file name.
</description>
</attribute>
<attribute name="debug" required="NOTDEFINED">
<description>
If true, turn on the debug mode for each of the Borland tools launched.
</description>
</attribute>
<attribute name="ejbjar" required="NOTDEFINED">
<description>
EJB JAR file.
</description>
</attribute>
<attribute name="mode" required="NOTDEFINED">
<description>
Command launching mode: java or fork.
</description>
</attribute>
<attribute name="version" required="NOTDEFINED">
<description>
</description>
</attribute>
</attributes>
<elements>
<element name="classpath" required="NOTDEFINED">
<description>
Adds path to the classpath.
</description>
</element>
</elements>
</structure>
</task>
<task name="buildnumber">
<description>
Read, increment, and write a build number in a file
It will first
attempt to read a build number from a file, then set the property
"build.number" to the value that was read in (or 0 if no such value). Then
it will increment the build number by one and write it back out into the
file.
</description>
<structure>
<attributes>
<attribute name="file" required="no; defaults to &quot;build.number&quot;">
<description>
The file in which the build number is stored. Defaults to
"build.number" if not specified.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="bunzip2">
<description>
Expands a file that has been compressed with the BZIP2
algorithm. Normally used to compress non-compressed archives such
as TAR files.
</description>
<structure>
<attributes>
<attribute name="dest" required="NOTDEFINED">
<description>
The destination file or directory.
</description>
</attribute>
<attribute name="src" required="NOTDEFINED">
<description>
The file to expand; required.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="bzip2">
<description>
Compresses a file with the BZIP2 algorithm. Normally used to compress
non-compressed archives such as TAR files.
</description>
<structure>
<attributes>
<attribute name="src" required="NOTDEFINED">
<description>
the file to compress; required.
</description>
</attribute>
<attribute name="zipfile" required="NOTDEFINED">
<description>
the required destination file.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="cab">
<description>
Create a CAB archive.
</description>
<structure>
<attributes>
<attribute name="basedir" required="yes">
<description>
Base directory to look in for files to CAB.
</description>
</attribute>
<attribute name="cabfile" required="yes">
<description>
The name/location of where to create the .cab file.
</description>
</attribute>
<attribute name="compress" required="no">
<description>
If true, compress the files otherwise only store them.
</description>
</attribute>
<attribute name="options" required="no">
<description>
Sets additional cabarc options that are not supported directly.
</description>
</attribute>
<attribute name="verbose" required="no">
<description>
If true, display cabarc output.
</description>
</attribute>
</attributes>
<elements>
<element name="fileset" required="NOTDEFINED">
<description>
Adds a set of files to archive.
</description>
</element>
</elements>
</structure>
</task>
<task name="cccheckin">
<description>
Task to perform a &quot;cleartool checkin&quot; command to ClearCase.
</description>
<structure>
<attributes>
<attribute name="cleartooldir" required="NOTDEFINED">
<description>
Set the directory where the cleartool executable is located.
</description>
</attribute>
<attribute name="comment" required="NOTDEFINED">
<description>
Sets the comment string.
</description>
</attribute>
<attribute name="commentfile" required="NOTDEFINED">
<description>
Specifies a file containing a comment.
</description>
</attribute>
<attribute name="identical" required="NOTDEFINED">
<description>
If true, allows the file to be checked in even
if it is identical to the original.
</description>
</attribute>
<attribute name="keepcopy" required="NOTDEFINED">
<description>
If true, keeps a copy of the file with a .keep extension.
</description>
</attribute>
<attribute name="nowarn" required="NOTDEFINED">
<description>
If true, suppress warning messages.
</description>
</attribute>
<attribute name="preservetime" required="NOTDEFINED">
<description>
If true, preserve the modification time.
</description>
</attribute>
<attribute name="viewpath" required="NOTDEFINED">
<description>
Set the path to the item in a ClearCase view to operate on.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="cccheckout">
<description>
Task to perform a &quot;cleartool checkout&quot; command to ClearCase.
</description>
<structure>
<attributes>
<attribute name="branch" required="NOTDEFINED">
<description>
Specify a branch to check out the file to.
</description>
</attribute>
<attribute name="cleartooldir" required="NOTDEFINED">
<description>
Set the directory where the cleartool executable is located.
</description>
</attribute>
<attribute name="comment" required="NOTDEFINED">
<description>
Sets the comment string.
</description>
</attribute>
<attribute name="commentfile" required="NOTDEFINED">
<description>
Specifies a file containing a comment.
</description>
</attribute>
<attribute name="nodata" required="NOTDEFINED">
<description>
If true, checks out the file but does not create an
editable file containing its data.
</description>
</attribute>
<attribute name="nowarn" required="NOTDEFINED">
<description>
If true, warning messages are suppressed.
</description>
</attribute>
<attribute name="out" required="NOTDEFINED">
<description>
Creates a writable file under a different filename.
</description>
</attribute>
<attribute name="reserved" required="NOTDEFINED">
<description>
If true, checks out the file as reserved.
</description>
</attribute>
<attribute name="version" required="NOTDEFINED">
<description>
If true, allows checkout of a version other than main latest.
</description>
</attribute>
<attribute name="viewpath" required="NOTDEFINED">
<description>
Set the path to the item in a ClearCase view to operate on.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ccmcheckin">
<description>
Task to &quot;checkin&quot; a file
</description>
<structure>
<attributes>
<attribute name="ccmdir" required="NOTDEFINED">
<description>
Set the directory where the ccm executable is located.
</description>
</attribute>
<attribute name="comment" required="NOTDEFINED">
<description>
Specifies a comment.
</description>
</attribute>
<attribute name="file" required="NOTDEFINED">
<description>
Sets the path to the file that the command will operate on.
</description>
</attribute>
<attribute name="task" required="NOTDEFINED">
<description>
Specifies the task number used to check
in the file (may use 'default').
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ccmcheckintask">
<description>
Task to perform a &quot;checkin&quot; default task command to Continuus.
</description>
<structure>
<attributes>
<attribute name="ccmdir" required="NOTDEFINED">
<description>
Set the directory where the ccm executable is located.
</description>
</attribute>
<attribute name="comment" required="NOTDEFINED">
<description>
Specifies a comment.
</description>
</attribute>
<attribute name="file" required="NOTDEFINED">
<description>
Sets the path to the file that the command will operate on.
</description>
</attribute>
<attribute name="task" required="NOTDEFINED">
<description>
Specifies the task number used to check
in the file (may use 'default').
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ccmcheckout">
<description>
Task to perform a &quot;Checkout&quot; command to Continuus.
</description>
<structure>
<attributes>
<attribute name="ccmdir" required="NOTDEFINED">
<description>
Set the directory where the ccm executable is located.
</description>
</attribute>
<attribute name="comment" required="NOTDEFINED">
<description>
Specifies a comment.
</description>
</attribute>
<attribute name="file" required="NOTDEFINED">
<description>
Sets the path to the file that the command will operate on.
</description>
</attribute>
<attribute name="task" required="NOTDEFINED">
<description>
Specifies the task number used to check
in the file (may use 'default').
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ccmcreatetask">
<description>
Create a Continuus task.
</description>
<structure>
<attributes>
<attribute name="ccmdir" required="NOTDEFINED">
<description>
Set the directory where the ccm executable is located.
</description>
</attribute>
<attribute name="comment" required="NOTDEFINED">
<description>
Specifies a comment.
</description>
</attribute>
<attribute name="platform" required="NOTDEFINED">
<description>
Specifies the target platform.
</description>
</attribute>
<attribute name="release" required="NOTDEFINED">
<description>
Specify the CCM release.
</description>
</attribute>
<attribute name="resolver" required="NOTDEFINED">
<description>
Specifies the resolver.
</description>
</attribute>
<attribute name="subsystem" required="NOTDEFINED">
<description>
Specifies the subsystem.
</description>
</attribute>
<attribute name="task" required="NOTDEFINED">
<description>
Specifies the task number used to checkin
the file (may use 'default').
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ccmreconfigure">
<description>
Task to perform a reconfigure command to Continuus.
</description>
<structure>
<attributes>
<attribute name="ccmdir" required="NOTDEFINED">
<description>
Set the directory where the ccm executable is located.
</description>
</attribute>
<attribute name="ccmproject" required="NOTDEFINED">
<description>
Sets the ccm project on which the operation is applied.
</description>
</attribute>
<attribute name="recurse" required="NOTDEFINED">
<description>
If true, recurse on subproject (default false).
</description>
</attribute>
<attribute name="verbose" required="NOTDEFINED">
<description>
If true, do a verbose reconfigure operation (default false).
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ccuncheckout">
<description>
Task to perform a &quot;UnCheckout&quot; command to ClearCase.
</description>
<structure>
<attributes>
<attribute name="cleartooldir" required="NOTDEFINED">
<description>
Set the directory where the cleartool executable is located.
</description>
</attribute>
<attribute name="keepcopy" required="NOTDEFINED">
<description>
If true, keep a copy of the file with a .keep extension.
</description>
</attribute>
<attribute name="viewpath" required="NOTDEFINED">
<description>
Set the path to the item in a ClearCase view to operate on.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ccupdate">
<description>
Task to perform an &quot;cleartool update&quot; command to ClearCase.
</description>
<structure>
<attributes>
<attribute name="cleartooldir" required="NOTDEFINED">
<description>
Set the directory where the cleartool executable is located.
</description>
</attribute>
<attribute name="currenttime" required="NOTDEFINED">
<description>
If true, modification time should be written as the current time.
Either currenttime or preservetime can be specified.
</description>
</attribute>
<attribute name="graphical" required="NOTDEFINED">
<description>
If true, displays a graphical dialog during the update.
</description>
</attribute>
<attribute name="log" required="NOTDEFINED">
<description>
Sets the log file where cleartool records
the status of the command.
</description>
</attribute>
<attribute name="overwrite" required="NOTDEFINED">
<description>
If true, overwrite hijacked files.
</description>
</attribute>
<attribute name="preservetime" required="NOTDEFINED">
<description>
If true, modification time should be preserved from the VOB time.
Either currenttime or preservetime can be specified.
</description>
</attribute>
<attribute name="rename" required="NOTDEFINED">
<description>
If true, hijacked files are renamed with a .keep extension.
</description>
</attribute>
<attribute name="viewpath" required="NOTDEFINED">
<description>
Set the path to the item in a ClearCase view to operate on.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="checksum">
<description>
Used to create or verify file checksums.
</description>
<structure>
<attributes>
<attribute name="algorithm" required="no">
<description>
Specifies the algorithm to be used to compute the checksum.
Defaults to "MD5". Other popular algorithms like "SHA" may be used as well.
</description>
</attribute>
<attribute name="file" required="one of either file or at least one nested fileset element.">
<description>
Sets the file for which the checksum is to be calculated.
</description>
</attribute>
<attribute name="fileext" required="no">
<description>
Sets the file extension that is be to used to
create or identify destination file.
</description>
</attribute>
<attribute name="forceoverwrite" required="no">
whether it is newer than
<description>
Whether or not to overwrite existing file irrespective of
whether it is newer than
the source file. Defaults to false.
</description>
</attribute>
<attribute name="property" required="no">
<description>
Sets the property to hold the generated checksum.
</description>
</attribute>
<attribute name="provider" required="no">
<description>
Sets the MessageDigest algorithm provider to be used
to calculate the checksum.
</description>
</attribute>
<attribute name="readbuffersize" required="no">
<description>
The size of the read buffer to use.
</description>
</attribute>
<attribute name="verifyproperty" required="no">
<description>
Sets the verify property. This project property holds
the result of a checksum verification - "true" or "false"
</description>
</attribute>
</attributes>
<elements>
<element name="fileset" required="NOTDEFINED">
<description>
Files to generate checksums for.
</description>
</element>
</elements>
</structure>
</task>
<task name="chmod">
<description>
Chmod equivalent for unix-like environments.
</description>
<structure>
<attributes>
<attribute name="append" required="NOTDEFINED">
<description>
Whether output should be appended to or overwrite an existing file.
Defaults to false.
</description>
</attribute>
<attribute name="defaultexcludes" required="no">
<description>
Sets whether default exclusions should be used or not.
</description>
</attribute>
<attribute name="dest" required="NOTDEFINED">
<description>
The directory where target files are to be placed.
</description>
</attribute>
<attribute name="dir" required="">
<description>
The directory which holds the files whose permissions must be changed.
</description>
</attribute>
<attribute name="excludes" required="no">
<description>
Sets the set of exclude patterns. Patterns may be separated by a comma
or a space.
</description>
</attribute>
<attribute name="executable" required="NOTDEFINED">
<description>
The command to execute.
</description>
</attribute>
<attribute name="failifexecutionfails" required="NOTDEFINED">
<description>
Stop the build if program cannot be started. Defaults to true.
</description>
</attribute>
<attribute name="failonerror" required="NOTDEFINED">
<description>
Fail if the command exits with a non-zero return code.
</description>
</attribute>
<attribute name="file" required="exactly one of the two or nested &lt;fileset&gt; elements.">
<description>
The file or single directory of which the permissions must be changed.
</description>
</attribute>
<attribute name="includes" required="no">
<description>
Sets the set of include patterns. Patterns may be separated by a comma
or a space.
</description>
</attribute>
<attribute name="newenvironment" required="NOTDEFINED">
<description>
Do not propagate old environment when new environment variables are specified.
</description>
</attribute>
<attribute name="os" required="NOTDEFINED">
<description>
List of operating systems on which the command may be executed.
</description>
</attribute>
<attribute name="output" required="NOTDEFINED">
<description>
File the output of the process is redirected to.
</description>
</attribute>
<attribute name="outputproperty" required="NOTDEFINED">
<description>
Property name whose value should be set to the output of
the process.
</description>
</attribute>
<attribute name="parallel" required="no">
<description>
If true, run the command only once, appending all files as arguments.
If false, command will be executed once for every file. Defaults to false.
</description>
</attribute>
<attribute name="perm" required="yes">
<description>
The new permissions.
</description>
</attribute>
<attribute name="relative" required="NOTDEFINED">
<description>
Whether the filenames should be passed on the command line as
absolute or relative pathnames. Paths are relative to the base
directory of the corresponding fileset for source files or the
dest attribute for target files.
</description>
</attribute>
<attribute name="resultproperty" required="NOTDEFINED">
<description>
The name of a property in which the return code of the
command should be stored. Only of interest if failonerror=false.
</description>
</attribute>
<attribute name="skipemptyfilesets" required="NOTDEFINED">
<description>
If no source files have been found or are newer than their
corresponding target files, do not run the command.
</description>
</attribute>
<attribute name="type" required="no, default is file">
<description>
Whether the command works only on files, directories or both?
</description>
</attribute>
<attribute name="vmlauncher" required="NOTDEFINED">
<description>
If true, launch new process with VM, otherwise use the OS's shell.
</description>
</attribute>
</attributes>
<elements>
<element name="env" required="NOTDEFINED">
<description>
Add an environment variable to the launched process.
</description>
</element>
<element name="fileset" required="NOTDEFINED">
<description>
Source files to operate upon.
</description>
</element>
<element name="arg" required="NOTDEFINED">
<description>
Adds a command-line argument.
</description>
</element>
<element name="exclude" required="NOTDEFINED">
<description>
Add a name entry on the exclude list.
</description>
</element>
<element name="include" required="NOTDEFINED">
<description>
Add a name entry on the include list.
</description>
</element>
<element name="mapper" required="NOTDEFINED">
<description>
Mapper to use for mapping source files to target files.
</description>
</element>
<element name="patternset" required="NOTDEFINED">
<description>
Add a set of patterns.
</description>
</element>
<element name="srcfile" required="NOTDEFINED">
<description>
Marker that indicates where the name of the source file should
be put on the command line.
</description>
</element>
<element name="targetfile" required="NOTDEFINED">
<description>
Marker that indicates where the name of the target file should
be put on the command line.
</description>
</element>
</elements>
</structure>
</task>
<task name="concat">
<description>
This class contains the 'concat' task, used to concatenate a series
of files into a single stream. The destination of this stream may
be the system console, or a file. The following is a sample
invocation:
&lt;pre&gt;
&amp;lt;concat destfile=&amp;quot;${build.dir}/index.xml&amp;quot;
append=&amp;quot;false&amp;quot;&amp;gt;
&amp;lt;fileset dir=&amp;quot;${xml.root.dir}&amp;quot;
includes=&amp;quot;*.xml&amp;quot; /&amp;gt;
&amp;lt;/concat&amp;gt;
&lt;/pre&gt;
</description>
<structure>
<attributes>
<attribute name="append" required="no">
<description>
Sets the behavior when the destination file exists. If set to
&lt;code&gt;true&lt;/code&gt; the stream data will be appended to the
existing file, otherwise the existing file will be
overwritten. Defaults to &lt;code&gt;false&lt;/code&gt;.
</description>
</attribute>
<attribute name="destfile" required="no ">
<description>
Sets the destination file, or uses the console if not specified.
</description>
</attribute>
<attribute name="encoding" required="no">
<description>
Sets the encoding for the input files, used when displaying the
data via the console.
</description>
</attribute>
</attributes>
<elements>
<element name="filelist" required="NOTDEFINED">
<description>
List of files to concatenate.
</description>
</element>
<element name="fileset" required="NOTDEFINED">
<description>
Set of files to concatenate.
</description>
</element>
</elements>
<body>
<description>
This method adds text which appears in the 'concat' element.
</description>
</body>
</structure>
</task>
<task name="condition">
<description>
Task to set a property conditionally using &amp;lt;uptodate&amp;gt;, &amp;lt;available&amp;gt;,
and many other supported conditions.
&lt;p&gt;This task supports boolean logic as well as pluggable conditions
to decide, whether a property should be set.&lt;/p&gt;
&lt;p&gt;This task does not extend Task to take advantage of
ConditionBase.&lt;/p&gt;
</description>
<structure>
<attributes>
<attribute name="property" required="yes">
<description>
The name of the property to set. Required.
</description>
</attribute>
<attribute name="value" required="no">
<description>
The value for the property to set, if condition evaluates to true.
Defaults to "true".
</description>
</attribute>
<attribute name="else" required="no">
<description>
The value to set the property to if the condition evaluates to false. By default the property will remain unset. Since Ant 1.6.3.
</description>
</attribute>
</attributes>
<elements>
<element name="and" required="NOTDEFINED">
<description>
Add an &amp;lt;and&amp;gt; condition "container".
</description>
</element>
<element name="available" required="NOTDEFINED">
<description>
Add an &amp;lt;available&amp;gt; condition.
</description>
</element>
<element name="checksum" required="NOTDEFINED">
<description>
Add an &amp;lt;checksum&amp;gt; condition.
</description>
</element>
<element name="contains" required="NOTDEFINED">
<description>
Add a &amp;lt;contains&amp;gt; condition.
</description>
</element>
<element name="equals" required="NOTDEFINED">
<description>
Add an &amp;lt;equals&amp;gt; condition.
</description>
</element>
<element name="filesmatch" required="NOTDEFINED">
<description>
Add a &amp;lt;filesmatch&amp;gt; condition.
</description>
</element>
<element name="http" required="NOTDEFINED">
<description>
Add an &amp;lt;http&amp;gt; condition.
</description>
</element>
<element name="isfalse" required="NOTDEFINED">
<description>
Add a &amp;lt;isfalse&amp;gt; condition.
</description>
</element>
<element name="isset" required="NOTDEFINED">
<description>
Add an &amp;lt;isset&amp;gt; condition.
</description>
</element>
<element name="istrue" required="NOTDEFINED">
<description>
Add a &amp;lt;istrue&amp;gt; condition.
</description>
</element>
<element name="not" required="NOTDEFINED">
<description>
Add an &amp;lt;not&amp;gt; condition "container".
</description>
</element>
<element name="or" required="NOTDEFINED">
<description>
Add an &amp;lt;or&amp;gt; condition "container".
</description>
</element>
<element name="os" required="NOTDEFINED">
<description>
Add an &amp;lt;os&amp;gt; condition.
</description>
</element>
<element name="socket" required="NOTDEFINED">
<description>
Add a &amp;lt;socket&amp;gt; condition.
</description>
</element>
<element name="uptodate" required="NOTDEFINED">
<description>
Add an &amp;lt;uptodate&amp;gt; condition.
</description>
</element>
</elements>
</structure>
</task>
<task name="copy">
<description>
Copies a file or directory to a new file
or directory. Files are only copied if the source file is newer
than the destination file, or when the destination file does not
exist. It is possible to explicitly overwrite existing files.&lt;/p&gt;
&lt;p&gt;This implementation is based on Arnout Kuiper's initial design
document, the following mailing list discussions, and the
copyfile/copydir tasks.&lt;/p&gt;
</description>
<structure>
<attributes>
<attribute name="encoding" required="NOTDEFINED">
<description>
Sets the character encoding
</description>
</attribute>
<attribute name="failonerror" required="no; defaults to true.">
<description>
If false, note errors to the output but keep going.
</description>
</attribute>
<attribute name="file" required="yes, unless a nested &lt;fileset&gt; element is used.">
<description>
Sets a single source file to copy.
</description>
</attribute>
<attribute name="filtering" required="no; defaults to false.">
<description>
If true, enables filtering.
</description>
</attribute>
<attribute name="flatten" required="no; defaults to false.">
<description>
When copying directory trees, the files can be "flattened"
into a single directory. If there are multiple files with
the same name in the source directory tree, only the first
file will be copied into the "flattened" directory, unless
the forceoverwrite attribute is true.
</description>
</attribute>
<attribute name="includeemptydirs" required="no; defaults to true.">
<description>
Used to copy empty directories.
</description>
</attribute>
<attribute name="overwrite" required="no; defaults to false.">
<description>
Overwrite any existing destination file(s).
</description>
</attribute>
<attribute name="preservelastmodified" required="no; defaults to false.">
<description>
Give the copied files the same last modified time as the original files.
</description>
</attribute>
<attribute name="todir" required="">
<description>
Sets the destination directory.
</description>
</attribute>
<attribute name="tofile" required="with the file attribute, either tofile or todir can be used. with nested &lt;fileset&gt; elements, if the set of files is greater than 1, or if only the dir attribute is specified in the &lt;fileset&gt;, or if the file attribute is also specified, then only todir is allowed.">
<description>
Sets the destination file.
</description>
</attribute>
<attribute name="verbose" required="no; defaults to false.">
<description>
Used to force listing of all names of copied files.
</description>
</attribute>
</attributes>
<elements>
<element name="fileset" required="NOTDEFINED">
<description>
Adds a set of files to copy.
</description>
</element>
<element name="filterchain" required="NOTDEFINED">
<description>
Adds a FilterChain.
</description>
</element>
<element name="filterset" required="NOTDEFINED">
<description>
Adds a filterset.
</description>
</element>
<element name="mapper" required="NOTDEFINED">
<description>
Defines the mapper to map source to destination files.
</description>
</element>
</elements>
</structure>
</task>
<task name="copydir">
<description>
Copies a directory.
</description>
<structure>
<attributes>
<attribute name="dest" required="yes">
<description>
</description>
</attribute>
<attribute name="filtering" required="no">
<description>
</description>
</attribute>
<attribute name="flatten" required="no">
<description>
</description>
</attribute>
<attribute name="forceoverwrite" required="no">
<description>
</description>
</attribute>
<attribute name="src" required="yes">
<description>
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="copyfile">
<description>
Copies a file.
</description>
<structure>
<attributes>
<attribute name="dest" required="yes">
<description>
</description>
</attribute>
<attribute name="filtering" required="no">
<description>
</description>
</attribute>
<attribute name="forceoverwrite" required="no">
<description>
</description>
</attribute>
<attribute name="src" required="yes">
<description>
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="csc">
<description>
Compiles C# source into executables or modules.
The task will only work on win2K until other platforms support
csc.exe or an equivalent. CSC.exe must be on the execute path too. &lt;p&gt;
All parameters are optional: &amp;lt;csc/&amp;gt; should suffice to produce a debug
build of all *.cs files. References to external files do require explicit
enumeration, so are one of the first attributes to consider adding. &lt;p&gt;
The task is a directory based task, so attributes like &lt;b&gt;includes="*.cs"
&lt;/b&gt; and &lt;b&gt;excludes="broken.cs"&lt;/b&gt; can be used to control the files pulled
in. By default, all *.cs files from the project folder down are included in
the command. When this happens the output file -if not specified- is taken
as the first file in the list, which may be somewhat hard to control.
Specifying the output file with &lt;b&gt;'outfile'&lt;/b&gt; seems prudent. &lt;p&gt;
</description>
<structure>
<attributes>
<attribute name="additionalmodules" required="NOTDEFINED">
<description>
Semicolon separated list of modules to refer to.
</description>
</attribute>
<attribute name="debug" required="NOTDEFINED">
<description>
set the debug flag on or off.
</description>
</attribute>
<attribute name="definitions" required="NOTDEFINED">
<description>
Semicolon separated list of defined constants.
</description>
</attribute>
<attribute name="destdir" required="NOTDEFINED">
<description>
Set the destination directory of files to be compiled.
</description>
</attribute>
<attribute name="destfile" required="NOTDEFINED">
<description>
Set the name of exe/library to create.
</description>
</attribute>
<attribute name="docfile" required="NOTDEFINED">
<description>
file for generated XML documentation
</description>
</attribute>
<attribute name="extraoptions" required="NOTDEFINED">
<description>
Any extra options which are not explicitly supported
by this task.
</description>
</attribute>
<attribute name="failonerror" required="NOTDEFINED">
<description>
If true, fail on compilation errors.
</description>
</attribute>
<attribute name="filealign" required="NOTDEFINED">
<description>
Set the file alignment.
Valid values are 0,512, 1024, 2048, 4096, 8192,
and 16384, 0 means 'leave to the compiler'
</description>
</attribute>
<attribute name="fullpaths" required="NOTDEFINED">
<description>
If true, print the full path of files on errors.
</description>
</attribute>
<attribute name="includedefaultreferences" required="NOTDEFINED">
<description>
If true, automatically includes the common assemblies
in dotnet, and tells the compiler to link in mscore.dll.
set the automatic reference inclusion flag on or off this flag controls
the string of references and the /nostdlib option in CSC
</description>
</attribute>
<attribute name="incremental" required="NOTDEFINED">
<description>
set the incremental compilation flag on or off.
</description>
</attribute>
<attribute name="mainclass" required="NOTDEFINED">
<description>
Sets the name of main class for executables.
</description>
</attribute>
<attribute name="noconfig" required="NOTDEFINED">
<description>
A flag that tells the compiler not to read in the compiler
settings files 'csc.rsp' in its bin directory and its local directory
</description>
</attribute>
<attribute name="optimize" required="NOTDEFINED">
<description>
If true, enables optimization flag.
</description>
</attribute>
<attribute name="outputfile" required="NOTDEFINED">
<description>
Set the output file
</description>
</attribute>
<attribute name="referencefiles" required="NOTDEFINED">
<description>
Path of references to include.
Wildcards should work.
</description>
</attribute>
<attribute name="references" required="NOTDEFINED">
<description>
Semicolon separated list of DLLs to refer to.
</description>
</attribute>
<attribute name="srcdir" required="NOTDEFINED">
<description>
Set the source directory of the files to be compiled.
</description>
</attribute>
<attribute name="targettype" required="NOTDEFINED">
<description>
Set the type of target.
</description>
</attribute>
<attribute name="unsafe" required="NOTDEFINED">
<description>
If true, enables the unsafe keyword.
</description>
</attribute>
<attribute name="utf8output" required="NOTDEFINED">
<description>
If true, require all compiler output to be in UTF8 format.
</description>
</attribute>
<attribute name="warnlevel" required="NOTDEFINED">
<description>
Level of warning currently between 1 and 4
with 4 being the strictest.
</description>
</attribute>
<attribute name="win32icon" required="NOTDEFINED">
<description>
Set the filename of icon to include.
</description>
</attribute>
<attribute name="win32res" required="NOTDEFINED">
<description>
Sets the filename of a win32 resource (.RES) file to include.
This is not a .NET resource, but what Windows is used to.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="cvs">
<description>
Performs operations on a CVS repository.
original 1.20
NOTE: This implementation has been moved to AbstractCvsTask with
the addition of some accessors for extensibility.
</description>
<structure>
<attributes>
<attribute name="append" required="no, default to &quot;false&quot;.">
<description>
Whether to append output/error when redirecting to a file.
</description>
</attribute>
<attribute name="command" required="no, default &quot;checkout&quot;.">
<description>
The CVS command to execute.
</description>
</attribute>
<attribute name="compression" required="no. defaults to false.">
<description>
If true, this is the same as compressionlevel="3".
</description>
</attribute>
<attribute name="compressionlevel" required="no. defaults to no compression.">
<description>
If set to a value 1-9 it adds -zN to the cvs command line, else
it disables compression.
</description>
</attribute>
<attribute name="cvsroot" required="no">
<description>
The CVSROOT variable.
</description>
</attribute>
<attribute name="cvsrsh" required="no">
<description>
The CVS_RSH variable.
</description>
</attribute>
<attribute name="date" required="no">
<description>
Use the most recent revision no later than the given date.
</description>
</attribute>
<attribute name="dest" required="no, default is project&apos;s basedir.">
<description>
The directory where the checked out files should be placed.
</description>
</attribute>
<attribute name="error" required="no, default error to ant log as msg_warn.">
<description>
The file to direct standard error from the command.
</description>
</attribute>
<attribute name="failonerror" required="no">
<description>
Stop the build process if the command exits with
a return code other than 0.
Defaults to false.
</description>
</attribute>
<attribute name="noexec" required="no, default to &quot;false&quot;">
<description>
If true, report only and don't change any files.
</description>
</attribute>
<attribute name="output" required="no, default output to ant log as msg_info.">
<description>
The file to direct standard output from the command.
</description>
</attribute>
<attribute name="package" required="no">
<description>
The package/module to operate upon.
</description>
</attribute>
<attribute name="passfile" required="no, default file ~/.cvspass.">
<description>
Password file to read passwords from.
</description>
</attribute>
<attribute name="port" required="no, default port 2401.">
<description>
Port used by CVS to communicate with the server.
</description>
</attribute>
<attribute name="quiet" required="no, default &quot;false&quot;">
<description>
If true, suppress informational messages.
</description>
</attribute>
<attribute name="tag" required="no">
<description>
The tag of the package/module to operate upon.
</description>
</attribute>
</attributes>
<elements>
<element name="commandline" required="NOTDEFINED">
<description>
Adds direct command-line to execute.
</description>
</element>
</elements>
</structure>
</task>
<task name="cvschangelog">
<description>
Generates an XML-formatted report file of the change logs recorded in a CVS repository.
Important: This task needs &quot;cvs&quot; on the path. If it isn't, you will get an error (such as error 2 on windows). If the cvs task does not work, try to execute cvs.exe from the command line in the target directory in which you are working.
</description>
<structure>
<attributes>
<attribute name="daysinpast" required="NOTDEFINED">
<description>
Sets the number of days into the past for which the change log information should be retrieved.
</description>
</attribute>
<attribute name="destfile" required="NOTDEFINED">
<description>
Set the output file for the log.
</description>
</attribute>
<attribute name="dir" required="NOTDEFINED">
<description>
Set the base dir for cvs.
</description>
</attribute>
<attribute name="end" required="NOTDEFINED">
<description>
The latest date to which change logs are to be included in the report.
</description>
</attribute>
<attribute name="start" required="NOTDEFINED">
<description>
The earliest date from which change logs are to be included in the report.
</description>
</attribute>
<attribute name="usersfile" required="NOTDEFINED">
<description>
Set a lookup list of user names &amp; addresses
</description>
</attribute>
</attributes>
<elements>
<element name="fileset" required="NOTDEFINED">
<description>
Adds a set of files about which cvs logs will be generated.
</description>
</element>
<element name="user" required="NOTDEFINED">
<description>
Add a user to list changelog knows about.
</description>
</element>
</elements>
</structure>
</task>
<task name="cvspass">
<description>
Adds an new entry to a CVS password file.
</description>
<structure>
<attributes>
<attribute name="cvsroot" required="yes">
<description>
The CVS repository to add an entry for.
</description>
</attribute>
<attribute name="passfile" required="no, default is ~/.cvspass.">
<description>
Password file to add the entry to.
</description>
</attribute>
<attribute name="password" required="yes">
<description>
Password to be added to the password file.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="cvstagdiff">
<description>
Generates an XML-formatted report file of the changes between two tags or dates recorded in a CVS repository.
Important: This task needs &quot;cvs&quot; on the path. If it isn't, you will get an error (such as error 2 on windows). If the cvs task does not work, try to execute cvs.exe from the command line in the target directory in which you are working.
</description>
<structure>
<attributes>
<attribute name="compression" required="NOTDEFINED">
<description>
If true, this is the same as compressionlevel="3".
</description>
</attribute>
<attribute name="compressionlevel" required="NOTDEFINED">
<description>
If set to a value 1-9 it adds -zN to the cvs command line, else
it disables compression.
</description>
</attribute>
<attribute name="cvsroot" required="NOTDEFINED">
<description>
The CVSROOT variable.
</description>
</attribute>
<attribute name="cvsrsh" required="NOTDEFINED">
<description>
The CVS_RSH variable.
</description>
</attribute>
<attribute name="destfile" required="yes">
<description>
The file in which to write the diff report.
</description>
</attribute>
<attribute name="enddate" required="">
<description>
The latest date from which diffs are to be included in the report.
accepts all formats accepted by the cvs command for -D date_spec arguments
</description>
</attribute>
<attribute name="endtag" required="exactly one of the two.">
<description>
The latest tag from which diffs are to be included in the report.
</description>
</attribute>
<attribute name="failonerror" required="NOTDEFINED">
<description>
Stop the build process if the command exits with
a return code other than 0.
Defaults to false.
</description>
</attribute>
<attribute name="package" required="NOTDEFINED">
<description>
The package/module to analyze.
</description>
</attribute>
<attribute name="passfile" required="NOTDEFINED">
<description>
Password file to read passwords from.
</description>
</attribute>
<attribute name="port" required="NOTDEFINED">
<description>
Port used by CVS to communicate with the server.
</description>
</attribute>
<attribute name="quiet" required="NOTDEFINED">
<description>
If true, suppress informational messages.
</description>
</attribute>
<attribute name="startdate" required="">
<description>
The earliest date from which diffs are to be included in the report.
accepts all formats accepted by the cvs command for -D date_spec arguments
</description>
</attribute>
<attribute name="starttag" required="exactly one of the two.">
<description>
The earliest tag from which diffs are to be included in the report.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ddcreator">
<description>
Builds a serialized deployment descriptor given a text file description of the
descriptor in the format supported by WebLogic.
This ant task is a front end for the weblogic DDCreator tool.
</description>
<structure>
<attributes>
<attribute name="classpath" required="NOTDEFINED">
<description>
Set the classpath to be used for this compilation.
</description>
</attribute>
<attribute name="descriptors" required="NOTDEFINED">
<description>
Set the directory from where the text descriptions of the deployment descriptors are
to be read.
</description>
</attribute>
<attribute name="dest" required="NOTDEFINED">
<description>
Set the directory into which the serialized deployment descriptors are to
be written.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="delete">
<description>
Deletes a file or directory, or set of files defined by a fileset.
The original delete task would delete a file, or a set of files
using the include/exclude syntax. The deltree task would delete a
directory tree. This task combines the functionality of these two
originally distinct tasks.
&lt;p&gt;Currently Delete extends MatchingTask. This is intend &lt;i&gt;only&lt;/i&gt;
to provide backwards compatibility for a release. The future position
is to use nested filesets exclusively.&lt;/p&gt;
</description>
<structure>
<attributes>
<attribute name="defaultexcludes" required="no">
<description>
Sets whether default exclusions should be used or not.
</description>
</attribute>
<attribute name="dir" required="">
<description>
Set the directory from which files are to be deleted
</description>
</attribute>
<attribute name="excludes" required="no">
<description>
Sets the set of exclude patterns. Patterns may be separated by a comma
or a space.
</description>
</attribute>
<attribute name="excludesfile" required="no">
<description>
Sets the name of the file containing the includes patterns.
</description>
</attribute>
<attribute name="failonerror" required="no">
<description>
If false, note errors but continue.
</description>
</attribute>
<attribute name="file" required="at least one of the two, unless a &lt;fileset&gt; is specified.">
<description>
Set the name of a single file to be removed.
</description>
</attribute>
<attribute name="includeemptydirs" required="no">
<description>
If true, delete empty directories.
</description>
</attribute>
<attribute name="includes" required="no">
<description>
Sets the set of include patterns. Patterns may be separated by a comma
or a space.
</description>
</attribute>
<attribute name="includesfile" required="no">
<description>
Sets the name of the file containing the includes patterns.
</description>
</attribute>
<attribute name="quiet" required="no">
<description>
If true and the file does not exist, do not display a diagnostic
message or modify the exit status to reflect an error.
This means that if a file or directory cannot be deleted,
then no error is reported. This setting emulates the
-f option to the Unix &amp;quot;rm&amp;quot; command.
Default is false meaning things are &amp;quot;noisy&amp;quot;
</description>
</attribute>
<attribute name="verbose" required="no">
<description>
If true, list all names of deleted files.
</description>
</attribute>
</attributes>
<elements>
<element name="fileset" required="NOTDEFINED">
<description>
Adds a set of files to be deleted.
</description>
</element>
<element name="exclude" required="NOTDEFINED">
<description>
add a name entry on the exclude list
</description>
</element>
<element name="excludesfile" required="NOTDEFINED">
<description>
add a name entry on the include files list
</description>
</element>
<element name="include" required="NOTDEFINED">
<description>
add a name entry on the include list
</description>
</element>
<element name="includesfile" required="NOTDEFINED">
<description>
add a name entry on the include files list
</description>
</element>
<element name="patternset" required="NOTDEFINED">
<description>
add a set of patterns
</description>
</element>
</elements>
</structure>
</task>
<task name="deltree">
<description>
</description>
<structure>
<attributes>
<attribute name="dir" required="yes">
<description>
Set the directory to be deleted
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="depend">
<description>
Generates a dependency file for a given set of classes.
</description>
<structure>
<attributes>
<attribute name="cache" required="no">
<description>
Sets the dependency cache file.
</description>
</attribute>
<attribute name="classpath" required="no">
<description>
Set the classpath to be used for this dependency check.
</description>
</attribute>
<attribute name="classpathref" required="NOTDEFINED">
<description>
Adds a reference to a classpath defined elsewhere.
</description>
</attribute>
<attribute name="closure" required="no">
<description>
If true, transitive dependencies are followed until the
closure of the dependency set if reached.
When not set, the depend task will only follow
direct dependencies between classes.
</description>
</attribute>
<attribute name="destdir" required="no">
<description>
Set the destination directory where the compiled Java files exist.
</description>
</attribute>
<attribute name="dump" required="no">
<description>
If true, the dependency information will be written
to the debug level log.
</description>
</attribute>
<attribute name="srcdir" required="yes">
<description>
Set the directories path to find the Java source files.
</description>
</attribute>
</attributes>
<elements>
<element name="classpath" required="NOTDEFINED">
<description>
Adds a classpath to be used for this dependency check.
</description>
</element>
</elements>
</structure>
</task>
<task name="dependset">
<description>
Examines and removes out of date target files. If any of the target files
are out of date with respect to any of the source files, all target
files are removed. This is useful where dependencies cannot be
computed (for example, dynamically interpreted parameters or files
that need to stay in synch but are not directly linked) or where
the ant task in question could compute them but does not (for
example, the linked DTD for an XML file using the style task).
</description>
<structure>
<attributes>
</attributes>
<elements>
<element name="srcfilelist" required="NOTDEFINED">
<description>
Add a list of source files.
</description>
</element>
<element name="srcfileset" required="NOTDEFINED">
<description>
Add a set of source files.
</description>
</element>
<element name="targetfilelist" required="NOTDEFINED">
<description>
Add a list of target files.
</description>
</element>
<element name="targetfileset" required="NOTDEFINED">
<description>
Add a set of target files.
</description>
</element>
</elements>
</structure>
</task>
<task name="dirname">
<description>
Determines the directory name of the specified file.
This task can accept the following attributes:
&lt;ul&gt;
&lt;li&gt;file
&lt;li&gt;property
&lt;/ul&gt;
Both &lt;b&gt;file&lt;/b&gt; and &lt;b&gt;property&lt;/b&gt; are required.
&lt;p&gt;
When this task executes, it will set the specified property to the
value of the specified file up to, but not including, the last path
element. If file is a file, the directory will be the current
directory.
</description>
<structure>
<attributes>
<attribute name="file" required="yes">
<description>
Path to take the dirname of.
</description>
</attribute>
<attribute name="property" required="yes">
<description>
The name of the property to set.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ear">
<description>
Creates a EAR archive. Based on WAR task
</description>
<structure>
<attributes>
<attribute name="appxml" required="yes, unless update is set to true">
<description>
File to incorporate as application.xml.
</description>
</attribute>
<attribute name="basedir" required="no">
<description>
Directory from which to archive files.
</description>
</attribute>
<attribute name="compress" required="no">
<description>
Whether we want to compress the files or only store them; default=true;
</description>
</attribute>
<attribute name="destfile" required="yes">
<description>
The file to create.
</description>
</attribute>
<attribute name="duplicate" required="no">
<description>
Sets behavior for when a duplicate file is about to be added -
one of &lt;code&gt;keep&lt;/code&gt;, &lt;code&gt;skip&lt;/code&gt; or &lt;code&gt;overwrite&lt;/code&gt;.
Possible values are: &lt;code&gt;keep&lt;/code&gt; (keep both
of the files); &lt;code&gt;skip&lt;/code&gt; (keep the first version
of the file found); &lt;code&gt;overwrite&lt;/code&gt; overwrite the file
with the new file
Default for zip tasks is &lt;code&gt;keep&lt;/code&gt;
</description>
</attribute>
<attribute name="encoding" required="no">
<description>
Encoding to use for filenames, defaults to the platform's
default encoding.
&lt;p&gt;For a list of possible values see &lt;a
href="http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.html"&gt;http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.html&lt;/a&gt;.&lt;/p&gt;
</description>
</attribute>
<attribute name="filesonly" required="no">
<description>
If true, emulate Sun's jar utility by not adding parent directories; defaults to false.
</description>
</attribute>
<attribute name="index" required="NOTDEFINED">
<description>
Set whether or not to create an index list for classes.
This may speed up classloading in some cases.
</description>
</attribute>
<attribute name="manifest" required="no">
<description>
The manifest file to use. This can be either the location of a manifest,
or the name of a jar added through a fileset. If its the name of an added
jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MF.
</description>
</attribute>
<attribute name="update" required="no">
<description>
If true, updates an existing file, otherwise overwrite
any existing one; defaults to false.
</description>
</attribute>
<attribute name="whenempty" required="NOTDEFINED">
<description>
Sets behavior of the task when no files match.
Possible values are: &lt;code&gt;fail&lt;/code&gt; (throw an exception
and halt the build); &lt;code&gt;skip&lt;/code&gt; (do not create
any archive, but issue a warning); &lt;code&gt;create&lt;/code&gt;
(make an archive with no entries).
Default for zip tasks is &lt;code&gt;skip&lt;/code&gt;;
for jar tasks, &lt;code&gt;create&lt;/code&gt;.
</description>
</attribute>
</attributes>
<elements>
<element name="archives" required="NOTDEFINED">
<description>
Adds zipfileset.
</description>
</element>
<element name="manifest" required="NOTDEFINED">
<description>
Allows the manifest for the archive file to be provided inline
in the buildfile rather than in an external file.
</description>
</element>
<element name="fileset" required="NOTDEFINED">
<description>
Adds a set of files.
</description>
</element>
<element name="metainf" required="NOTDEFINED">
<description>
Adds a zipfileset to include in the META-INF directory.
</description>
</element>
<element name="zipgroupfileset" required="NOTDEFINED">
<description>
Adds a group of zip files.
</description>
</element>
<element name="zipfileset" required="NOTDEFINED">
<description>
Adds a set of files that can be read from an archive and be given a prefix/fullpath.
</description>
</element>
</elements>
</structure>
</task>
<task name="echo">
<description>
Writes a message to the Ant logging facilities.
</description>
<structure>
<attributes>
<attribute name="append" required="no - default is false.">
<description>
If true, append to existing file.
</description>
</attribute>
<attribute name="file" required="no">
<description>
File to write to.
</description>
</attribute>
<attribute name="level" required="no - default is &quot;warning&quot;.">
<description>
Set the logging level. Level should be one of
&lt;ul&gt;
&lt;li&gt;error&lt;/li&gt;
&lt;li&gt;warning&lt;/li&gt;
&lt;li&gt;info&lt;/li&gt;
&lt;li&gt;verbose&lt;/li&gt;
&lt;li&gt;debug&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;The default is &amp;quot;warning&amp;quot; to ensure that messages are
displayed by default when using the -quiet command line option.&lt;/p&gt;
</description>
</attribute>
<attribute name="message" required="yes, unless data is included in a character section within this element.">
<description>
Message to write.
</description>
</attribute>
</attributes>
<elements>
</elements>
<body>
<description>
Set a multiline message.
</description>
</body>
</structure>
</task>
<task name="echoproperties">
<description>
Displays all the current properties in the build. The output can be sent to
a file if desired. &lt;P&gt;
Attribute "destfile" defines a file to send the properties to. This can be
processed as a standard property file later. &lt;P&gt;
Attribute "prefix" defines a prefix which is used to filter the properties
only those properties starting with this prefix will be echoed. &lt;P&gt;
By default, the "failonerror" attribute is enabled. If an error occurs while
writing the properties to a file, and this attribute is enabled, then a
BuildException will be thrown. If disabled, then IO errors will be reported
as a log statement, but no error will be thrown. &lt;P&gt;
Examples: &lt;pre&gt;
&amp;lt;echoproperties /&amp;gt;
&lt;/pre&gt; Report the current properties to the log. &lt;P&gt;
&lt;pre&gt;
&amp;lt;echoproperties destfile="my.properties" /&amp;gt;
&lt;/pre&gt; Report the current properties to the file "my.properties", and will
fail the build if the file could not be created or written to. &lt;P&gt;
&lt;pre&gt;
&amp;lt;echoproperties destfile="my.properties" failonerror="false"
prefix="ant" /&amp;gt;
&lt;/pre&gt; Report all properties beginning with 'ant' to the file
"my.properties", and will log a message if the file could not be created or
written to, but will still allow the build to continue.
</description>
<structure>
<attributes>
<attribute name="destfile" required="no">
<description>
Set a file to store the property output. If this is never specified,
then the output will be sent to the Ant log.
</description>
</attribute>
<attribute name="failonerror" required="no">
<description>
If true, the task will fail if an error occurs writing the properties
file, otherwise errors are just logged.
</description>
</attribute>
<attribute name="prefix" required="no">
<description>
If the prefix is set, then only properties which start with this
prefix string will be recorded. If this is never set, or it is set
to an empty string or &lt;tt&gt;null&lt;/tt&gt;, then all properties will be
recorded. &lt;P&gt;
For example, if the property is set as:
&lt;PRE&gt;&amp;lt;echoproperties prefix="ant." /&amp;gt;&lt;/PRE&gt;
then the property "ant.home" will be recorded, but "ant-example"
will not.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ejbc">
<description>
Builds EJB support classes using WebLogic's ejbc tool from a directory containing
a set of deployment descriptors.
</description>
<structure>
<attributes>
<attribute name="classpath" required="NOTDEFINED">
<description>
Set the classpath to be used for this compilation.
</description>
</attribute>
<attribute name="descriptors" required="NOTDEFINED">
<description>
Set the directory from where the serialized deployment descriptors are to be read.
</description>
</attribute>
<attribute name="dest" required="NOTDEFINED">
<description>
Set the directory into which the support classes, RMI stubs, etc are to be written.
</description>
</attribute>
<attribute name="keepgenerated" required="NOTDEFINED">
<description>
If true, ejbc will keep the
intermediate Java files used to build the class files.
This can be useful when debugging.
</description>
</attribute>
<attribute name="manifest" required="NOTDEFINED">
<description>
Set the name of the generated manifest file.
For each EJB that is processed an entry is created in this file. This can then be used
to create a jar file for dploying the beans.
</description>
</attribute>
<attribute name="src" required="NOTDEFINED">
<description>
Set the directory containing the source code for the home interface, remote interface
and public key class definitions.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ejbjar">
<description>
Provides automated EJB JAR file creation.
&lt;p&gt;
Extends the
MatchingTask class provided in the default ant distribution to provide a
directory scanning EJB jarfile generator.
&lt;/p&gt;
&lt;p&gt;
The task works by taking the deployment descriptors one at a time and
parsing them to locate the names of the classes which should be placed in
the jar. The classnames are translated to java.io.Files by replacing
periods with File.separatorChar and resolving the generated filename as a
relative path under the srcDir attribute. All necessary files are then
assembled into a jarfile. One jarfile is constructed for each deployment
descriptor found.
&lt;/p&gt;
</description>
<structure>
<attributes>
<attribute name="basejarname" required="NOTDEFINED">
<description>
Set the base name of the EJB JAR that is to be created if it is not
to be determined from the name of the deployment descriptor files.
</description>
</attribute>
<attribute name="basenameterminator" required="NOTDEFINED">
<description>
The string which terminates the bean name.
The convention used by this task is
that bean descriptors are named as the BeanName with some suffix. The
baseNameTerminator string separates the bean name and the suffix and
is used to determine the bean name.
</description>
</attribute>
<attribute name="classpath" required="NOTDEFINED">
<description>
Set the classpath to use when resolving classes for inclusion in the jar.
</description>
</attribute>
<attribute name="dependency" required="NOTDEFINED">
<description>
Set the analyzer to use when adding in dependencies to the JAR.
</description>
</attribute>
<attribute name="descriptordir" required="NOTDEFINED">
<description>
Set the descriptor directory. The descriptor directory contains the
EJB deployment descriptors. These are XML files that declare the
properties of a bean in a particular deployment scenario. Such
properties include, for example, the transactional nature of the bean
and the security access control to the bean's methods.
</description>
</attribute>
<attribute name="destdir" required="NOTDEFINED">
<description>
Set the destination directory. The EJB jar files will be written into
this directory. The jar files that exist in this directory are also
used when determining if the contents of the jar file have changed.
Note that this parameter is only used if no deployment tools are
specified. Typically each deployment tool will specify its own
destination directory.
</description>
</attribute>
<attribute name="flatdestdir" required="NOTDEFINED">
<description>
Controls whether the destination JARs are written out in the destination directory with
the same hierarchical structure from which the deployment descriptors
have been read. If this is set to true the generated EJB jars are
written into the root of the destination directory, otherwise they
are written out in the same relative position as the deployment
descriptors in the descriptor directory.
</description>
</attribute>
<attribute name="genericjarsuffix" required="NOTDEFINED">
<description>
Set the suffix for the generated jar file. When generic jars are
generated, they have a suffix which is appended to the the bean name
to create the name of the jar file. Note that this suffix includes
the extension fo te jar file and should therefore end with an
appropriate extension such as .jar or .ear
</description>
</attribute>
<attribute name="manifest" required="NOTDEFINED">
<description>
Set the Manifest file to use when jarring. As of EJB 1.1, manifest
files are no longer used to configure the EJB. However, they still
have a vital importance if the EJB is intended to be packaged in an
EAR file. By adding "Class-Path" settings to a Manifest file, the EJB
can look for classes inside the EAR file itself, allowing for easier
deployment. This is outlined in the J2EE specification, and all J2EE
components are meant to support it.
</description>
</attribute>
<attribute name="naming" required="NOTDEFINED">
<description>
Set the naming scheme used to determine the name of the generated jars
from the deployment descriptor
</description>
</attribute>
<attribute name="srcdir" required="NOTDEFINED">
<description>
Sets the source directory, which is the directory that
contains the classes that will be added to the EJB jar. Typically
this will include the home and remote interfaces and the bean class.
</description>
</attribute>
</attributes>
<elements>
<element name="borland" required="NOTDEFINED">
<description>
Adds a deployment tool for Borland server.
</description>
</element>
<element name="classpath" required="NOTDEFINED">
<description>
Adds to the classpath used to locate the super classes and
interfaces of the classes that will make up the EJB JAR.
</description>
</element>
<element name="dtd" required="NOTDEFINED">
<description>
Create a DTD location record. This stores the location of a DTD. The
DTD is identified by its public Id. The location may either be a file
location or a resource location.
</description>
</element>
<element name="iplanet" required="NOTDEFINED">
<description>
Adds a deployment tool for iPlanet Application Server.
</description>
</element>
<element name="jboss" required="NOTDEFINED">
<description>
Adds a deployment tool for JBoss server.
</description>
</element>
<element name="jonas" required="NOTDEFINED">
<description>
Adds a deployment tool for JOnAS server.
</description>
</element>
<element name="support" required="NOTDEFINED">
<description>
Adds a fileset for support elements.
</description>
</element>
<element name="weblogic" required="NOTDEFINED">
<description>
Adds a deployment tool for Weblogic server.
</description>
</element>
<element name="weblogictoplink" required="NOTDEFINED">
<description>
Adds a deployment tool for Weblogic when using the Toplink
Object-Relational mapping.
</description>
</element>
<element name="websphere" required="NOTDEFINED">
<description>
Adds a deployment tool for Websphere 4.0 server.
</description>
</element>
</elements>
</structure>
</task>
<task name="exec">
<description>
Executes a given command if the os platform is appropriate.
</description>
<structure>
<attributes>
<attribute name="append" required="no">
<description>
Whether output should be appended to or overwrite an existing file.
Defaults to false.
</description>
</attribute>
<attribute name="dir" required="no">
<description>
The working directory of the process.
</description>
</attribute>
<attribute name="executable" required="">
<description>
The command to execute.
</description>
</attribute>
<attribute name="failifexecutionfails" required="no">
<description>
Stop the build if program cannot be started. Defaults to true.
</description>
</attribute>
<attribute name="failonerror" required="no">
<description>
Fail if the command exits with a non-zero return code.
</description>
</attribute>
<attribute name="newenvironment" required="no, default is false">
<description>
Do not propagate old environment when new environment variables are specified.
</description>
</attribute>
<attribute name="os" required="no">
<description>
List of operating systems on which the command may be executed.
</description>
</attribute>
<attribute name="output" required="no">
<description>
File the output of the process is redirected to.
</description>
</attribute>
<attribute name="outputproperty" required="no">
<description>
Property name whose value should be set to the output of
the process.
</description>
</attribute>
<attribute name="resultproperty" required="no">
<description>
The name of a property in which the return code of the
command should be stored. Only of interest if failonerror=false.
</description>
</attribute>
<attribute name="vmlauncher" required="no, default is true">
<description>
If true, launch new process with VM, otherwise use the OS's shell.
</description>
</attribute>
</attributes>
<elements>
<element name="env" required="NOTDEFINED">
<description>
Add an environment variable to the launched process.
</description>
</element>
<element name="arg" required="NOTDEFINED">
<description>
Adds a command-line argument.
</description>
</element>
</elements>
</structure>
</task>
<task name="fail">
<description>
Exits the active build, giving an additional message
if available.
</description>
<structure>
<attributes>
<attribute name="if" required="no">
<description>
Only fail if a property of the given name exists in the current project.
</description>
</attribute>
<attribute name="message" required="no">
<description>
A message giving further information on why the build exited.
</description>
</attribute>
<attribute name="unless" required="no">
<description>
Only fail if a property of the given name does not
exist in the current project.
</description>
</attribute>
</attributes>
<elements>
</elements>
<body>
<description>
Set a multiline message.
</description>
</body>
</structure>
</task>
<task name="filter">
<description>
Sets a token filter that is used by the file copy tasks
to do token substitution. Sets mutiple tokens by
reading these from a file.
</description>
<structure>
<attributes>
<attribute name="filtersfile" required="yes*">
<description>
The file from which the filters must be read.
This file must be a formatted as a property file.
</description>
</attribute>
<attribute name="token" required="yes*">
<description>
The token string without @ delimiters.
</description>
</attribute>
<attribute name="value" required="yes*">
<description>
The string that should replace the token during filtered copies.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="fixcrlf">
<description>
Converts text source files to local OS formatting conventions, as
well as repair text files damaged by misconfigured or misguided editors or
file transfer programs.
</description>
<structure>
<attributes>
<attribute name="destdir" required="no">
<description>
Set the destination where the fixed files should be placed.
Default is to replace the original file.
</description>
</attribute>
<attribute name="encoding" required="no - defaults to default jvm encoding">
<description>
Specifies the encoding Ant expects the files to be in -
defaults to the platforms default encoding.
</description>
</attribute>
<attribute name="eof" required="no">
<description>
Specify how DOS EOF (control-z) characters are to be handled.
</description>
</attribute>
<attribute name="eol" required="no">
<description>
Specify how EndOfLine characters are to be handled.
</description>
</attribute>
<attribute name="javafiles" required="no">
<description>
Set to true if modifying Java source files.
</description>
</attribute>
<attribute name="srcdir" required="yes">
<description>
Set the source dir to find the source text files.
</description>
</attribute>
<attribute name="tab" required="no">
<description>
Specify how tab characters are to be handled.
</description>
</attribute>
<attribute name="tablength" required="no">
<description>
Specify tab length in characters.
</description>
</attribute>
</attributes>
<elements>
</elements>
</structure>
</task>
<task name="ftp">
<description>
Basic FTP client. Performs the following actions:
&lt;ul&gt;
&lt;li&gt; &lt;strong&gt;send&lt;/strong&gt; - send files to a remote server. This is the
default action.&lt;/li&gt;
&lt;li&gt; &lt;strong&gt;get&lt;/strong&gt; - retrive files from a remote server.&lt;/li&gt;
&lt;li&gt; &lt;strong&gt;del&lt;/strong&gt; - delete files from a remote server.&lt;/li&gt;
&lt;li&gt; &lt;strong&gt;list&lt;/strong&gt; - create a file listing.&lt;/li&gt;
&lt;li&gt; &lt;strong&gt;chmod&lt;/strong&gt; - change unix file permissions.&lt;/li&gt;
&lt;/ul&gt;
&lt;strong&gt;Note:&lt;/strong&gt; Some FTP servers - notably the Solaris server - seem
to hold data ports open after a "retr" operation, allowing them to timeout
instead of shutting them down cleanly. This happens in active or passive
mode, and the ports will remain open even after ending the FTP session. FTP
"send" operations seem to close ports immediately. This behavior may cause
problems on some systems when downloading large sets of files.
</description>
<structure>
<attributes>
<attribute name="action" required="no">
<description>
Sets the FTP action to be taken. Currently accepts "put", "get", "del",
"mkdir", "chmod" and "list".
</description>
</attribute>
<attribute name="binary" required="no">
<description>
If true, uses binary mode, otherwise text mode (default is binary).
</description>
</attribute>
<attribute name="chmod" required="no">
<description>
Sets the file permission mode (Unix only) for files sent to the server.
</description>
</attribute>
<attribute name="depends" required="no">
<description>
Set to true to transmit only files that are new or changed from their
remote counterparts. The default is to transmit all files.
</description>
</attribute>
<attribute name="ignorenoncriticalerrors" required="no">
<description>
Aet the flag to skip errors on directory creation.
(and maybe later other server specific errors)
</description>
</attribute>
<attribute name="listing" required="no">
<description>
The output file for the "list" action. This attribute is ignored for
any other actions.
</description>
</attribute>
<attribute name="newer" required="no">
<description>
A synonym for &lt;tt&gt;depends&lt;/tt&gt;. Set to true to transmit only new or changed
files.
</description>
</attribute>
<attribute name="passive" required="no">
<description>
Specifies whether to use passive mode. Set to true if you are behind a
firewall and cannot connect without it. Passive mode is disabled by
default.
</description>
</attribute>
<attribute name="password" required="yes">
<description>
Sets the login password for the given user id.
</description>
</attribute>
<attribute name="port" required="no">
<description>
Sets the FTP port used by the remote server.
</description>
</attribute>
<attribute name="remotedir" required="no">
<description>
Sets the remote directory where files will be placed. This may be a
relative or absolute path, and must be in the path syntax expected by
the remote server. No correction of path syntax will be performed.
</description>
</attribute>
<attribute name="separator" required="no">
<description>
Sets the remote file separator character. This normally defaults to the
Unix standard forward slash, but can be manually overridden using this
call if the remote server requires some other separator. Only the first
character of the string is used.
</description>
</attribute>
<attribute name="server" required="yes">
<description>
Sets the FTP server to send files to.
</description>
</attribute>
<attribute name="skipfailedtransfers" required="no">
<description>
If true, enables unsuccessful file put, delete and get
operations to be skipped with a warning and the remainder