diff --git a/docs/index.html b/docs/index.html index b8d53edc4..9b9da3d12 100644 --- a/docs/index.html +++ b/docs/index.html @@ -11,9 +11,10 @@

Ant User Manual

by

+

Version 1.0.3 - 2000/02/06

@@ -644,11 +645,11 @@ preferred, because of speed.

Examples

-
-

<cvs cvsRoot=":pserver:anoncvs@jakarta.apache.org:/home/cvspublic" - package="jakarta-tools" dest="${ws.dir}" />

-
-

This checks out the package/module "jakarta-tools" from the CVS +

  <cvs cvsRoot=":pserver:anoncvs@jakarta.apache.org:/home/cvspublic"
+       package="jakarta-tools"
+       dest="${ws.dir}"
+  />
+

checks out the package/module "jakarta-tools" from the CVS repository pointed to by the cvsRoot attribute, and stores the files in "${ws.dir}".

Delete

@@ -668,10 +669,10 @@ repository pointed to by the cvsRoot attribute, and stores the files in "${

Examples

-
-

<delete file="/lib/ant.jar" />

-

<delete file="${ant}" />

-
+
  <delete file="/lib/ant.jar" />
+

deletes the file /lib/ant.jar.

+
  <delete file="${ant}" />
+

deletes the file ${ant}.

Deltree

Description

@@ -690,10 +691,12 @@ repository pointed to by the cvsRoot attribute, and stores the files in "${

Examples

-
-

<deltree dir="dist" />

-

<deltree dir="${dist}" />

-
+
  <deltree dir="dist" />
+

deletes the directory dist, including its files and +subdirectories.

+
  <deltree dir="${dist}" />
+

deletes the directory ${dist}, including its files and +subdirectories.

Echo

Description

@@ -712,9 +715,7 @@ repository pointed to by the cvsRoot attribute, and stores the files in "${

Examples

-
-

<echo message="Hello world" />

-
+
  <echo message="Hello world" />

Exec

Description

@@ -815,10 +816,8 @@ archive with http/ftp.

Examples

-
-

<get src="http://jakarta.apache.org/" dest="help/index.html" - />

-
+
  <get src="http://jakarta.apache.org/" dest="help/index.html" />
+

gets the index page of http://jakarta.apache.org/, and stores it in the file help/index.html.

GZip

Description

@@ -995,13 +994,13 @@ the one that is currently running Ant.

Examples

-
-

<java class="test.Main" />

-

<java class="test.Main" args="-h" />

-

<java class="test.Main" args="-h" - fork="yes" jvmargs="-Xrunhprof:cpu=samples,file=log.txt,depth=3" - />

-
+
  <java class="test.Main" />
+
  <java class="test.Main" args="-h" />
+
  <java class="test.Main"
+        args="-h"
+        fork="yes"
+        jvmargs="-Xrunhprof:cpu=samples,file=log.txt,depth=3"
+  />

Javac

Description

@@ -1395,18 +1394,16 @@ instead.

Examples

-
- 
<javadoc packagenames="com.dummy.test.*" 
-         sourcepath="src" 
-         destdir="docs/api"
-         author="true"
-         version="true"
-         use="true"
-         windowtitle="Test API"
-         doctitle="<h1>Test</h1>"
-         bottom="<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>"
-/>
-
+
  <javadoc packagenames="com.dummy.test.*"
+           sourcepath="src"
+           destdir="docs/api"
+           author="true"
+           version="true"
+           use="true"
+           windowtitle="Test API"
+           doctitle="<h1>Test</h1>"
+           bottom="<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>"
+  />

KeySubst

Description

@@ -1448,10 +1445,7 @@ separator, which might we changed with the sep attribute.

Examples

-
-

<keysubst src="abc.txt" dest="def.txt" - keys="VERSION=1.0.3*DATE=2000-01-10" />

-
+
  <keysubst src="abc.txt" dest="def.txt" keys="VERSION=1.0.3*DATE=2000-01-10" />

Mkdir

Description

@@ -1471,10 +1465,10 @@ necessary.

Examples

-
-

<mkdir dir="${dist}" />

-

<mkdir dir="${dist}/lib" />

-
+
<mkdir dir="${dist}" />
+

creates a directory ${dist}.

+
<mkdir dir="${dist}/lib" />
+

creates a directory ${dist}/lib.

Property

Description

@@ -1530,16 +1524,16 @@ This also holds for properties loaded from a property file.

Examples

-
-

<property name="foo.dist" value="dist"/>

-

<property file="foo.properties" />

-

<property resource="foo.properties" />

-
+
  <property name="foo.dist" value="dist" />
+

sets the property foo.dist to the value "dist".

+
  <property file="foo.properties" />
+

reads a set of properties from a file called "foo.properties".

+
  <property resource="foo.properties" />
+

reads a set of properties from a resource called "foo.properties".

Replace

Description

-

Replaces the occurrence of a given string with another string in a file. When -the value attribute is omitted, it defaults to "".

+

Replaces the occurrence of a given string with another string in a file.

Parameters

@@ -1549,25 +1543,25 @@ the value attribute is omitted, it defaults to "".

- + - + - +
filefile for which the token should be replacedfile for which the token should be replaced. Yes
tokenthe token which must be replacedthe token which must be replaced. Yes
valuethe new value for the tokenthe new value for the token. When omitted, an empty string + ("") is used. No

Examples

-
-

<replace file="${src}/index.html" token="@@@" - value="wombat" />

-
+
  <replace file="${src}/index.html" token="@@@" value="wombat" />
+

replaces occurrences of the string "@@@" with the string +"wombat", in the file ${src}/index.html.

Rmic

Description

@@ -1591,10 +1585,9 @@ the value attribute is omitted, it defaults to "".

Examples

-
-

<rmic class="com.xyz.FooBar" - base="${build}/classes" />

-
+
  <rmic class="com.xyz.FooBar" base="${build}/classes" />
+

runs the rmic compiler for the class com.xyz.FooBar. The +compiled files will be stored in the directory ${build}/classes.

Taskdef

Description

@@ -1623,10 +1616,9 @@ href="#writingowntask">Writing your own task".

Examples

-
-

<taskdef name="myjavadoc" value="com.mydomain.JavadocTask" - />

-
+
  <taskdef name="myjavadoc" value="com.mydomain.JavadocTask" />
+

makes a task called myjavadoc available to Ant. The class com.mydomain.JavadocTask +implements the task.

Tstamp

Description

@@ -1646,9 +1638,7 @@ href="#inittarget">init target.

Examples

-
-

<tstamp/>

-
+
  <tstamp/>

Zip

Description

@@ -1747,10 +1737,17 @@ or files with the name todo.html are excluded.

in the ${dist} directory. Only html files under the directory api are zipped, and files with the name todo.html are excluded.

Deprecated examples

-
  <zip zipfile="${dist}/manual.zip" basedir="htdocs/manual" items="*" />
+
  <zip zipfile="${dist}/manual.zip"
+       basedir="htdocs/manual"
+       items="*"
+  />

zips all files in the htdocs/manual directory in a file called manual.zip in the ${dist} directory.

-
  <zip zipfile="${dist}/manual.zip" basedir="htdocs/manual" items="*" ignore="mydocs, todo.html"/>
+
  <zip zipfile="${dist}/manual.zip"
+       basedir="htdocs/manual"
+       items="*"
+       ignore="mydocs, todo.html"
+  />

zips all files in the htdocs/manual directory in a file called manual.zip in the ${dist} directory. Files/directories with the names mydocs and todo.html are excluded.