If you do not have a JAXP compliant XML parse installed, you may use the reference implementation available from Sun. It is available from http://java.sun.com/xml. - Once installed make sure the "jaxp.jar" and "parser.jar" files are in your classpath. + Once installed make sure the "jaxp.jar" and "parser.jar" files are in your classpath.
You will also need the JDK installed on your system, version 1.1 or later. @@ -155,12 +155,13 @@ needed for your chosen JAXP compliant XML parser.
When you need JDK functionality (like a javac task, or a
rmic task), then for JDK 1.1, the classes.zip
-file of the JDK must be added to the classpath; for JDK 1.2, tools.jar
+file of the JDK must be added to the classpath; for JDK 1.2 or JDK 1.3, tools.jar
must be added. The scripts supplied with ant, in the bin directory, will add
tools.jar automatically if the JAVA_HOME environment variable is set.
When you are executing platform specific applications (like the exec task, or the cvs task), the property ant.home
-must be set to the directory containing a bin directory, which contains the antRun shell script necessary to run execs on Unix.
antRun
+shell script necessary to run execs on Unix.
Running Ant is simple, when you installed it as described in the previous @@ -173,7 +174,10 @@ buildfile (see the property task). This can be done with the -D<property>=<value> option, where <property> is the name of the property and <value> -the value.
+the value. This can also be used (and is the only way since Java can not access them) +to have access to your environment variables, just pass -DMYVAR=%MYVAR% (Windows) or +-DMYVAR=$MYVAR (Unix) do Ant, you can access these variables inside your build-file +as ${MYVAR}.Two more options are -quiet which instructs Ant to print less information on the console when running. The option -verbose on the other hand makes Ant print more information on the console.
@@ -303,7 +307,7 @@ href="#tstamp">tstamp tasks in a so called initialization target, on which all other targets depend. Make sure that target is always the first one in the depends list of the other targets. In this manual, most initialization targets -have the name "init". +have the name "init".The optional description attribute can be used to provide a one line description of this target that is printed by the -projecthelp commandline option.
A target has the following attributes:
| antfile | -the buildfile to use. | +the buildfile to use. Defaults to "build.xml". | No |
| dir | -the directory to use as a basedir for the new Ant project - Defaults to the current directory. | +the directory to use as a basedir for the new Ant project. + Defaults to the current directory. | No |
| value | -the value to set the property to. Defaults to "true". | +the value to set the property to. Defaults to "true". | No |
| verbose | -Show name of each deleted file ("true"/"false"). Default is "false" when omitted. | +Show name of each deleted file ("true"/"false"). + Default is "false" when omitted. | No |
<exec dir="${src}" executable="dir" os="windows"
output="dir.txt" />
Command line arguments should be specified as nested @@ -1558,7 +1562,7 @@
@@ -1570,6 +1574,14 @@-<exec executable="emacs" > +<exec executable="emacs" > <env key="DISPLAY" value=":1.0" /> </exec>
adds ${basedir}/bin to the PATH of the
system command.
Note: Although it may work for you to specify arguments using +a simple arg-element and seperate them by spaces it may fail if you switch to +a newer version of the JDK. JDK < 1.2 will pass these as separate arguments +to the program you are calling, JDK >= 1.2 will pass them as a single +argument and cause most calls to fail.
+Note2: If you are using Ant on Windows and a new DOS-Window pops up +for every command which is excuted this may be a problem of the JDK you are using. +This problem may occur with all JDK's < 1.2.
Sets a token filter for this project. Token filters are used by all tasks that perform file copying operations through the Project commodity methods.
Note: the token string must not contain the separators chars (@).
-| No | @@ -1829,9 +1840,9 @@No | @@ -2467,7 +2478,8 @@||
| target | -Generate class files for specific VM version, e.g. "1.1" or "1.2". | +Generate class files for specific VM version, e.g. + "1.1" or "1.2". | No |
Note: If you are using Ant on Windows and a new DOS-Window pops up +for every use of an external compiler this may be a problem of the JDK you are using. +This problem may occur with all JDK's < 1.2.
+<patch patchfile="module.1.0-1.1.patch" />
applies the diff included in module.1.0-1.1.patch to the files in base directory guessing the filename(s) from the diff output. -
<patch patchfile="module.1.0-1.1.patch" strip="1" />+
<patch patchfile="module.1.0-1.1.patch" strip="1" />
like above but one leading directory part will be removed. i.e. if the diff output looked like
@@ -3155,7 +3171,7 @@file file for which the token should be replaced. -Exactly one of the two. +Exactly one of the two. dir @@ -3282,14 +3298,14 @@sourcebase -Pass the "-keepgenerated" flag to rmic and + Pass the "-keepgenerated" flag to rmic and move the generated source file to the base directory. No stubversion Specify the JDK version for the generated stub code. - Specify "1.1" to pass the "-v1.1" option to rmic. + Specify "1.1" to pass the "-v1.1" option to rmic.No @@ -3471,7 +3487,7 @@ extension desired file extension to be used for the targets. - If not specified, the default is "html". + If not specified, the default is "html".No @@ -3482,8 +3498,8 @@ processor name of the XSLT processor to use. Permissible -values are "xslp" for the XSL:P processor, "xalan" for the Apache XML Xalan -processor, or the name of an arbitrary XSLTLiaison class. +values are "xslp" for the XSL:P processor, "xalan" +for the Apache XML Xalan processor, or the name of an arbitrary XSLTLiaison class. Defaults to xslp or xalan (in that order), if one is found in your class path No @@ -3705,9 +3721,9 @@Unjar/Unwar/Unzip
Description
Unzips a zip-, war- or jarfile.
-For JDK 1.1 "last modified time" field is set to current time instead of being +
For JDK 1.1 "last modified time" field is set to current time instead of being carried from zipfile.
-File permissions will not be restored on extracted files. +
File permissions will not be restored on extracted files.
Parameters
@@ -3735,8 +3751,8 @@ Untar
Description
Untars a tarfile.
-File permissions will not be restored on extracted files. -
For JDK 1.1 "last modified time" field is set to current time instead of being +
File permissions will not be restored on extracted files.
+For JDK 1.1 "last modified time" field is set to current time instead of being carried from tarfile.
Parameters
@@ -4054,14 +4070,14 @@
verbose -set to "yes" if you want to see the output from - the cabarc tool. defaults to "no". +set to "yes" if you want to see the output from + the cabarc tool. defaults to "no". No compress -set to "no" to store files without compressing. - defaults to "yes". +set to "no" to store files without compressing. + defaults to "yes". No @@ -4098,33 +4114,33 @@ defaultexcludes indicates whether default excludes should be used - or not ("yes"/"no"). Default excludes are used when omitted. + or not ("yes"/"no"). Default excludes are used when omitted.No Examples
-<cab cabfile="${dist}/manual.cab" - basedir="htdocs/manual" +<cab cabfile="${dist}/manual.cab" + basedir="htdocs/manual" />cabs all files in the htdocs/manual directory in a file called manual.cab in the ${dist} directory.
-<cab cabfile="${dist}/manual.cab" - basedir="htdocs/manual" - excludes="mydocs/**, **/todo.html" +<cab cabfile="${dist}/manual.cab" + basedir="htdocs/manual" + excludes="mydocs/**, **/todo.html" />cabs all files in the htdocs/manual directory in a file called manual.cab in the ${dist} directory. Files in the directory mydocs, or files with the name todo.html are excluded.
-<cab cabfile="${dist}/manual.cab" - basedir="htdocs/manual" - includes="api/**/*.html" - excludes="**/todo.html" - verbose="yes" +<cab cabfile="${dist}/manual.cab" + basedir="htdocs/manual" + includes="api/**/*.html" + excludes="**/todo.html" + verbose="yes" />cab all files in the htdocs/manual directory in a file called @@ -4289,7 +4305,7 @@ FTP server, and the dir attribute as the local directory to put the files into. The file structure from the FTP site is preserved on the local machine.
- <ftp action="get" + <ftp action="get" server="ftp.apache.org" userid="anonymous" password="me@myorg.com"> @@ -4307,7 +4323,7 @@ filesets are relative to the remote directory, not a local directory. In fact, the dir attribute of the fileset is ignored completely.- <ftp action="del" + <ftp action="del" server="ftp.apache.org" userid="anonymous" password="me@myorg.com" > @@ -4795,8 +4811,8 @@VssGet
Description:
Task to perform GET commands to Microsoft Visual Source Safe. --The following attributes are interpretted: +
If you specify two or more attributes from version, date and +label only one will be used in the order version, date, label.
Parameters:
@@ -4854,7 +4870,18 @@ Note that only one of version, date or label should be specified
Examples
-None yet available
++<vssget localPath="C:\mysrc\myproject" + recursive="true" + label="Release1" + login="me,mypassword" + vsspath="/source/aProject" + writable="true"/> ++Does a get on the VSS-Project $/source/aproject using the username +me and the password mypassword. It will recursively get the files +which are labeled Release1 and write them to the local directory +C:\mysrc\myproject. The local files will be writable.
Build Events
@@ -4895,10 +4922,13 @@ name of the method must begin with "set", followed by the attribute name, with the first character in uppercase, and the rest in lowercase. The type of the attribute can beString, any - primitive type,Class,File(in which case the - value of the attribute is interpreted relative to the project's basedir) - or any other type that has a constructor with a singleString- argument + primitive type (they are converted for you from their String-representation + in the build-file. If you specify a boolean your method will be passed the value + true if the value specified in the build-file is one of "true", + "yes" or "on"),Class,File+ (in which case the value of the attribute is interpreted relative to the + project's basedir) or any other type that has a constructor with a single +StringargumentIf your task has enumerated attributes, you should consider using a subclass of org.apache.tools.ant.types.EnumeratedAttribute as argument to your setter method. See org.apache.tools.ant.taskdefs.FixCRLF for @@ -5007,8 +5037,8 @@ href="http://jakarta.apache.org/jyve-faq/Turbine/screen/DisplayTopics/action/SetAll/project_id/2/faq_id/16">jakarta.apache.org. This FAQ is interactive, which means you can ask and answer questions online. - One of the questions poping up quite often is "Is there a DTD for -buildfiles?". Please refer to the FAQ for an answer.
+One of the questions poping up quite often is "Is there a DTD for +buildfiles?". Please refer to the FAQ for an answer.
Feedback
To provide feedback on this software, please subscribe to the Ant User