diff --git a/manual/Tasks/jspc.html b/manual/Tasks/jspc.html index adad6f24f..1e84ace4f 100644 --- a/manual/Tasks/jspc.html +++ b/manual/Tasks/jspc.html @@ -24,7 +24,7 @@ -

jspc (deprecated)

+

jspc

Deprecated

If you use this task with Tomcat's Jasper JSP compiler, you should seriously diff --git a/manual/Tasks/makeurl.html b/manual/Tasks/makeurl.html index b20f94a1e..f00b17b42 100644 --- a/manual/Tasks/makeurl.html +++ b/manual/Tasks/makeurl.html @@ -14,55 +14,21 @@ See the License for the specific language governing permissions and limitations under the License. --> - + + Makeurl Task - - - - - - - - - - - -
- - - -
- Makeurl Task - - - - Apache Ant - -
-
+ - - - - - - - - - -
 
- - - Description -
+

Makeurl Task

+

Description

This task takes one or more filenames and turns them into URLs, which it then assigns to a property. Useful when setting up RMI or JNLP codebases, for example. Nested filesets are supported; if present, these are turned into the URLs with the supplied separator between them (default: space). -

Examples:

 <makeurl file="${user.home}/.m2/repository" property="m2.repository.url"/>
@@ -72,163 +38,86 @@ Sets the property m2.repository.url to the file: URL of the local M
 <makeurl property="codebase"><fileset dir="lib includes="*.jar"/></makeurl>
Set the property codebase to the three URLs of the files provided as nested elements. -
- - - - - - - - - - - - -
 
- - - Parameters -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Attribute - - Description - - Type - - Requirement -
- file - - name of a file to be converted into a URL - - File - - optional, if a nested fileset or path is supplied -
- property - - name of a property to set to the URL - - String - - required -
- separator - - separator for the multi-URL option - - String - - optional -
- validate - - validate that every named file exists - - boolean - - optional; default: true -
-
- - - - - - - - - - -
 
- - - Parameters as nested elements -
- - - - - -
 
- - fileset (org.apache.tools.ant.types.FileSet) -
- A fileset of JAR files to include in the URL list, each separated by the separator. - - - -
- - - - - - -
 
- - path (org.apache.tools.ant.types.Path) -
- Add a path to the URL. All elements in the path will be converted to individual URL entries. - - - -
- - -
- - - +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
+ Attribute + + Description + + Type + + Requirement +
+ file + + name of a file to be converted into a URL + + File + + optional, if a nested fileset or path is supplied +
+ property + + name of a property to set to the URL + + String + + required +
+ separator + + separator for the multi-URL option + + String + + optional +
+ validate + + validate that every named file exists + + boolean + + optional; default: true
+

Parameters as nested elements

+

fileset (org.apache.tools.ant.types.FileSet)

+ +A fileset of JAR files to include in the URL list, each separated by the separator. + +

path (org.apache.tools.ant.types.Path)

+Add a path to the URL. All elements in the path will be converted to individual URL entries. diff --git a/manual/Tasks/setproxy.html b/manual/Tasks/setproxy.html index 245924ce8..b6da936e4 100644 --- a/manual/Tasks/setproxy.html +++ b/manual/Tasks/setproxy.html @@ -14,207 +14,127 @@ See the License for the specific language governing permissions and limitations under the License. --> - + + Setproxy Task - - - - - + +

Setproxy Task

+ +

Description

+Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites. You can nominate an http and ftp proxy, or a socks server, reset the server settings, or do nothing at all. + +

Examples

+
<setproxy/>
do nothing +
<setproxy proxyhost="firewall"/>
set the proxy to firewall:80 +
<setproxy proxyhost="firewall" proxyport="81"/>
set the proxy to firewall:81 +
<setproxy proxyhost=""/>
stop using the http proxy; don't change the socks settings +
<setproxy socksproxyhost="socksy"/>
use socks via socksy:1080 +
<setproxy socksproxyhost=""/>
stop using the socks server. +

+You can set a username and password for http with the proxyHost and proxyPassword attributes. On Java1.4 and above these can also be used against SOCKS5 servers. +

+ +

Parameters

+
- + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- - - -
- Setproxy Task -
Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites. - 		- - - Apache Ant - -
+ 		+ Attribute + + Description + + Type + + Requirement
- - - - - - - - - - -
 
- - - Description -
- Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites. You can nominate an http and ftp proxy, or a socks server, reset the server settings, or do nothing at all.

Examples 

<setproxy/>
do nothing 
<setproxy proxyhost="firewall"/>
set the proxy to firewall:80 
<setproxy proxyhost="firewall" proxyport="81"/>
set the proxy to firewall:81 
<setproxy proxyhost=""/>
stop using the http proxy; don't change the socks settings 
<setproxy socksproxyhost="socksy"/>
use socks via socksy:1080 
<setproxy socksproxyhost=""/>
stop using the socks server.

You can set a username and password for http with the proxyHost and proxyPassword attributes. On Java1.4 and above these can also be used against SOCKS5 servers.

-
- - - - - - - - - - - - -
 
- - - Parameters -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Attribute - - Description - - Type - - Requirement -
- nonproxyhosts - - A list of hosts to bypass the proxy on. These should be separated with the vertical bar character '|'. Only in Java 1.4 does ftp use this list. e.g. fozbot.corp.sun.com|*.eng.sun.com - - String - - Optional -
- proxyhost - - the HTTP/ftp proxy host. Set this to "" for the http proxy option to be disabled - - String -
- proxypassword - - Set the password for the proxy. Used only if the proxyUser is set. - - String -
- proxyport - - the HTTP/ftp proxy port number; default is 80 - - int -
- proxyuser - - set the proxy user. Probably requires a password to accompany this setting. Default="" - - String -
- socksproxyhost - - The name of a Socks server. Set to "" to turn socks proxying off. - - String -
- socksproxyport - - Set the ProxyPort for socks connections. The default value is 1080 - - int -
-
- - - - - - - - - - -
 
- - - Parameters as nested elements -
- -
- - - + 		+ nonproxyhosts + + A list of hosts to bypass the proxy on. These should be separated with the vertical bar character '|'. Only in Java 1.4 does ftp use this list. e.g. fozbot.corp.sun.com|*.eng.sun.com + + String + + Optional +
+ proxyhost + + the HTTP/ftp proxy host. Set this to "" for the http proxy option to be disabled + + String +
+ proxypassword + + Set the password for the proxy. Used only if the proxyUser is set. + + String +
+ proxyport + + the HTTP/ftp proxy port number; default is 80 + + int +
+ proxyuser + + set the proxy user. Probably requires a password to accompany this setting. Default="" + + String +
+ socksproxyhost + + The name of a Socks server. Set to "" to turn socks proxying off. + + String +
+ socksproxyport + + Set the ProxyPort for socks connections. The default value is 1080 + + int
- diff --git a/manual/Tasks/subant.html b/manual/Tasks/subant.html index 424bb67ef..8cc4c2950 100644 --- a/manual/Tasks/subant.html +++ b/manual/Tasks/subant.html @@ -18,48 +18,13 @@ + Subant Task - - - - - - - - - - - - - - - -
- - - -
- Subant Task -
Calls a given target for all defined sub-builds. - 		- - - Apache Ant - -
-
- - - - - - - - - - -
 
- - - Description -
+ +

Subant Task

+

Description

Calls a given target for all defined sub-builds. This is an extension @@ -68,26 +33,20 @@ This task must not be used outside of a target if it invokes the same build file it is part of. -

-

Since Apache Ant 1.6

+

+

Since Apache Ant 1.6

-

subant uses ant internally so many things +

+ subant uses ant internally so many things said in ant's manual page apply - here as well.

+ here as well. +

- - - - - -
- - - Use with directories -
-

+

Use with directories

+

subant can be used with directory sets to execute a build from different directories. 2 different options are offered : -

+

  • to run the same build file /somepath/otherpath/mybuild.xml @@ -96,381 +55,196 @@
  • if you want to run directory1/mybuild.xml, directory2/mybuild.xml, ...., use the antfile attribute. The subant task does not set the base directory for you in this case, because you can specify it in each build file.
    • -
- -
- -
- - - - + - - - - - - - -
 
- - - Parameters -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Attribute - - Description - - Type - - Requirement -
- antfile - - Build file name, to use in conjunction with directories.
Defaults to "build.xml".
If genericantfile is set, this attribute is ignored. - 		- String - - Optional -
- buildpath - - Set the buildpath to be used to find sub-projects. - - Path -
- buildpathref - - Buildpath to use, by reference. - - Reference -
- failonerror - - Sets whether to fail with a build exception on error, or go on. - - boolean -
- genericantfile - - Build file path, to use in conjunction with directories.
Use genericantfile, in order to run the same build file with different basedirs.
If this attribute is set, antfile is ignored. - 		- File -
- inheritall - - Corresponds to - <ant>'s - inheritall attribute but defaults - to false in this task.. - - boolean -
- inheritrefs - - Corresponds to <ant>'s inheritrefs attribute. - - boolean -
- output - - Corresponds to <ant>'s output attribute. - - String -
- target - - - - String -
- verbose - - - Enable/ disable log messages showing when each sub-build path is entered/ exited. - The default value is false. - - boolean -
-
- - - - - - - - - - -
 
- - - Parameters as nested elements -
- - - - - -
 
- - any filesystem based resource collection -
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Attribute + + Description + + Type + + Requirement +
+ antfile + + Build file name, to use in conjunction with directories.
Defaults to "build.xml".
If genericantfile is set, this attribute is ignored. + 		+ String + + Optional +
+ buildpath + + Set the buildpath to be used to find sub-projects. + + Path +
+ buildpathref + + Buildpath to use, by reference. + + Reference +
+ failonerror + + Sets whether to fail with a build exception on error, or go on. + + boolean +
+ genericantfile + + Build file path, to use in conjunction with directories.
Use genericantfile, in order to run the same build file with different basedirs.
If this attribute is set, antfile is ignored. + 		+ File +
+ inheritall + + Corresponds to + <ant>'s + inheritall attribute but defaults + to false in this task.. + + boolean +
+ inheritrefs + + Corresponds to <ant>'s inheritrefs attribute. + + boolean +
+ output + + Corresponds to <ant>'s output attribute. + + String +
+ target +   + String +
+ verbose + + Enable/ disable log messages showing when each sub-build path is entered/ exited. + The default value is false. + + boolean +
+

Parameters as nested elements

+

any filesystem based resource collection

This includes <fileset>, <dirset> and <filelist> which are the nested resource collections supported prior to Ant 1.7. - - - -
- - - - - - -
 
- - dirset (org.apache.tools.ant.types.DirSet) -
- Adds a directory set to the implicit build path.

Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead! - - - -

- - - - - - -
 
- - filelist (org.apache.tools.ant.types.FileList) -
- Adds an ordered file list to the implicit build path.

Note that contrary to file and directory sets, file lists can reference non-existent files or directories! - - - -

- - - - - - -
 
- - fileset (org.apache.tools.ant.types.FileSet) -
- Adds a file set to the implicit build path.

Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead! - - - -

- - - - - - -
 
- - property (org.apache.tools.ant.taskdefs.Property) -
- Corresponds to <ant>'s nested <property> element. - -

When more than one nested <property> element +

dirset (org.apache.tools.ant.types.DirSet)

+Adds a directory set to the implicit build path. +

+ Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead! +

+

filelist (org.apache.tools.ant.types.FileList)

+Adds an ordered file list to the implicit build path. +

+ Note that contrary to file and directory sets, file lists can reference non-existent files or directories! +

+

fileset (org.apache.tools.ant.types.FileSet)

+Adds a file set to the implicit build path. +

+ Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead! +

+

property (org.apache.tools.ant.taskdefs.Property)

+Corresponds to <ant>'s nested <property> element. +

+ When more than one nested <property> element would set a property of the same name, the one declared last will win. This is for backwards compatibility reasons even so it is different from the way <property> tasks in build - files behave.

- - - - -
- - - - - - -
 
- - propertyset (org.apache.tools.ant.types.PropertySet) -
+ files behave. +

+

propertyset (org.apache.tools.ant.types.PropertySet)

Corresponds to <ant>'s nested <propertyset> element. - - - -
- - - - - - -
 
- - buildpath (org.apache.tools.ant.types.Path) -
+

buildpath (org.apache.tools.ant.types.Path)

Creates a nested build path, and add it to the implicit build path. - - - -
- - - - - - -
 
- - buildpathelement (org.apache.tools.ant.types.Path.PathElement) -
+

buildpathelement (org.apache.tools.ant.types.Path.PathElement)

Creates a nested <buildpathelement>, and add it to the implicit build path. - - - -
- - - - - - - - - - - -
 
- - target (org.apache.tools.ant.taskdefs.Ant.TargetElement) -
+

target (org.apache.tools.ant.taskdefs.Ant.TargetElement)

You can specify multiple targets using nested <target> 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. - - - - - - - - - - - - - -
AttributeDescriptionRequired
nameThe name of the called target.Yes
-

since Ant 1.7.

-
- - - -
- - - - - - - - - - - -
 
- - - Examples -
- 
+	
+          
+            
+            
+            
+          
+          
+            
+            
+            
+          
+	
AttributeDescriptionRequired
nameThe name of the called target.Yes

+
since Ant 1.7.

+
Examples

+
         <project name="subant" default="subant1">
             <property name="build.dir" value="subant.build"/>
             <target name="subant1">
@@ -481,12 +255,12 @@
                 </subant>
             </target>
         </project>
-        

+

this snippet build file will run ant in each subdirectory of the project directory, where a file called build.xml can be found. The property build.dir will have the value subant1.build in the ant projects called by subant. -

+

           <subant target="">
               <propertyset>
@@ -495,27 +269,27 @@
               </propertyset>
               <fileset dir="." includes="*/build.xml"/>
           </subant>
-
+

this snippet build file will run ant in each subdirectory of the project directory, where a file called build.xml can be found. All properties whose name starts with "foo" are passed, their names are changed to start with "bar" instead -

+

           <subant target="compile" genericantfile="/opt/project/build1.xml">
               <dirset dir="." includes="projects*"/>
           </subant>
-
+

assuming the subdirs of the project dir are called projects1, projects2, projects3 this snippet will execute the compile target of /opt/project/build1.xml, setting the basedir to projects1, projects2, projects3 -

- - -

Now a little more complex - but useful - scenario. Assume that we have - a directory structure like this:

- 
+

+

+  Now a little more complex - but useful - scenario. Assume that we have
+  a directory structure like this:
+

+
         root
           |  common.xml
           |  build.xml
@@ -542,7 +316,6 @@
 
         build.xml:

         <project>
-
             <macrodef name="iterate">
                 <attribute name="target"/>
                 <sequential>
@@ -564,45 +337,33 @@
         <project name="modA">
             <import file="../../common.xml"/>
         </project>
-        

+
-

This results in very small buildfiles in the modules, maintainable - buildfile (common.xml) and a clear project structure. Additionally - the root buildfile is capable to run the whole build over all - modules. -

+

+ This results in very small buildfiles in the modules, maintainable + buildfile (common.xml) and a clear project structure. Additionally + the root buildfile is capable to run the whole build over all + modules. +

- 
+
         <subant failonerror="false">
             <fileset dir="." includes="**/build.xml" excludes="build.xml"/>
             <target name="clean"/>
             <target name="build"/>
         </subant>
-        

+
-

Does a "clean build" for each subproject.

-

Hint: because buildfiles are plain xml, you could generate the - masterbuildfile from the common buildfile by using a XSLT transformation: -

+

Does a "clean build" for each subproject.

+

+ Hint: because buildfiles are plain xml, you could generate the + masterbuildfile from the common buildfile by using a XSLT transformation: +

- 
+
         <xslt in="common.xml"
               out="master.xml"
-              style="${ant.home}/etc/common2master.xsl"
-        />
-        

-
-        
-
-
- -
- + style="${ant.home}/etc/common2master.xsl"/> + diff --git a/manual/Tasks/tempfile.html b/manual/Tasks/tempfile.html index 1be00d07f..d4d9d52da 100644 --- a/manual/Tasks/tempfile.html +++ b/manual/Tasks/tempfile.html @@ -14,60 +14,22 @@ See the License for the specific language governing permissions and limitations under the License. --> - + + Tempfile Task - - - - - - - - - - - -
- - - -
- Tempfile Task -
This task sets a property to the name of a temporary file. - 		- - - Apache Ant - -
-
- - - - - - - - - - -
 
- - - Description -
- + +

Tempfile Task

+

Description

This task sets a property to the name of a temporary file. Unlike java.io.File.createTempFile, this task does not actually create the temporary file, but it does guarantee that the file did not exist when the task was executed. - -

Examples: - +

Examples:

<tempfile property="temp.file"/>
create a temporary file @@ -79,151 +41,94 @@ 
<tempfile property="temp.file" destDir="build"/>
create a temporary file in the build subdirectory - -
- - - - - - - - - - - - -
 
- - - Parameters -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Attribute - - Description - - Type - - Requirement -
- property - - Sets the property you wish to assign the temporary file to. - - String - - Required -
- destdir - - Sets the destination directory. If not set, the basedir directory is used instead. - - File - - Optional -
- prefix - - Sets the optional prefix string for the temp file. - - String -
- suffix - - Sets the optional suffix string for the temp file. - - String -
- deleteonexit - - Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default false. Since Apache Ant 1.7 - - boolean -
- createfile - - Whether the temp file should be created by this task; default false.Since Ant 1.8 - - boolean -
-
- - - - - - - - - - -
 
- - - Parameters as nested elements -
- -
- - - +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
+ Attribute + + Description + + Type + + Requirement +
+ property + + Sets the property you wish to assign the temporary file to. + + String + + Required +
+ destdir + + Sets the destination directory. If not set, the basedir directory is used instead. + + File + + Optional +
+ prefix + + Sets the optional prefix string for the temp file. + + String +
+ suffix + + Sets the optional suffix string for the temp file. + + String +
+ deleteonexit + + Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default false. Since Apache Ant 1.7 + + boolean +
+ createfile + + Whether the temp file should be created by this task; default false.Since Ant 1.8 + + boolean
-