From 949e52ddb4038766f3ab86343727c75a7e808067 Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Tue, 10 Apr 2001 07:06:37 +0000 Subject: [PATCH] Move the "Running Ant" section from "Installing Ant" to a page of its own. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268934 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/install.html | 99 --------------------------------- docs/manual/running.html | 115 +++++++++++++++++++++++++++++++++++++++ docs/manual/toc.html | 1 + 3 files changed, 116 insertions(+), 99 deletions(-) create mode 100644 docs/manual/running.html diff --git a/docs/manual/install.html b/docs/manual/install.html index 84bd50bb5..80a48678d 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -196,105 +196,6 @@ This will only install the bin and lib directories. install-lite targets will overwrite the current Ant version in ANT_HOME.

-
-

Running Ant

-

Running Ant is simple, when you installed it as described in the previous -section. Just type ant.

-

When nothing is specified, Ant looks for a build.xml -file in the current directory. If found, it uses that file as the -buildfile. If you use the -find option, -Ant will search for a buildfile in -the parent directory, and so on, until the root of the filesystem -has been reached. To make Ant use -another buildfile, use the command-line -option -buildfile file, -where file is the buildfile you want to use.

- -

You can also set properties that override properties specified in the -buildfile (see the property task). -This can be done with -the -Dproperty=value option, -where property is the name of the property, -and value is the value for that property. -This can also be used to pass in the value of some environment variables. -You can also access environment variables using the -property task. - -Just pass -DMYVAR=%MYVAR% (Windows) or --DMYVAR=$MYVAR (Unix) -to Ant - you can then access -these variables inside your buildfile as ${MYVAR}.

- -

Two more options are: -quiet, -which instructs Ant to print less -information on the console when running, and --verbose, which causes Ant to print -additional information to the console.

- -

It is also possible to specify one or more targets that should be executed. -When omitted, the target that is specified in the -default attribute of the <project> tag is -used.

- -

The -projecthelp -option gives a list of this project's -targets. First those with a description, then those without one.

- -

Command-line option summary:

-
ant [options] [target [target2 [target3] ...]]
-Options:
--help                  print this message
--projecthelp           print project help information
--version               print the version information and exit
--quiet                 be extra quiet
--verbose               be extra verbose
--debug                 print debugging information
--emacs                 produce logging information without adornments
--logfile file          use given file for log output
--logger classname      the class that is to perform logging
--listener classname    add an instance of class as a project listener
--buildfile file        use specified buildfile
--find file             search for buildfile towards the root of the filesystem and use the first one found
--Dproperty=value       set property to value
-
-

Examples

-
- 
ant
-
-

runs Ant using the build.xml file in the current directory, on -the default target.

-
- 
ant -buildfile test.xml
-
-

runs Ant using the test.xml file in the current directory, on -the default target.

-
- 
ant -buildfile test.xml dist
-
-

runs Ant using the test.xml file in the current directory, on a -target called dist.

-
- 
ant -buildfile test.xml -Dbuild=build/classes dist
-
-

runs Ant using the test.xml file in the current directory, on a -target called dist, setting the build property to the -value build/classes.

- -

Running Ant by Hand

-

If you have installed Ant in the do-it-yourself way, Ant can be started -with:

-
- 
java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]
-
- -

These instructions actually do exactly the same as the ant -command. The options and target are the same as when running Ant with the ant -command. This example assumes you have set your classpath to include:

-

Library Dependencies

The following libraries are needed in your CLASSPATH or in the diff --git a/docs/manual/running.html b/docs/manual/running.html new file mode 100644 index 000000000..57eb35cbd --- /dev/null +++ b/docs/manual/running.html @@ -0,0 +1,115 @@ + + + + +Ant User Manual + + + + +

Running Ant

+

Running Ant is simple, when you installed it as described in the previous +section. Just type ant.

+

When nothing is specified, Ant looks for a build.xml +file in the current directory. If found, it uses that file as the +buildfile. If you use the -find option, +Ant will search for a buildfile in +the parent directory, and so on, until the root of the filesystem +has been reached. To make Ant use +another buildfile, use the command-line +option -buildfile file, +where file is the buildfile you want to use.

+ +

You can also set properties that override properties specified in the +buildfile (see the property task). +This can be done with +the -Dproperty=value option, +where property is the name of the property, +and value is the value for that property. +This can also be used to pass in the value of some environment variables. +You can also access environment variables using the +property task. + +Just pass -DMYVAR=%MYVAR% (Windows) or +-DMYVAR=$MYVAR (Unix) +to Ant - you can then access +these variables inside your buildfile as ${MYVAR}.

+ +

Two more options are: -quiet, +which instructs Ant to print less +information on the console when running, and +-verbose, which causes Ant to print +additional information to the console.

+ +

It is also possible to specify one or more targets that should be executed. +When omitted, the target that is specified in the +default attribute of the <project> tag is +used.

+ +

The -projecthelp +option gives a list of this project's +targets. First those with a description, then those without one.

+ +

Command-line option summary:

+
ant [options] [target [target2 [target3] ...]]
+Options:
+-help                  print this message
+-projecthelp           print project help information
+-version               print the version information and exit
+-quiet                 be extra quiet
+-verbose               be extra verbose
+-debug                 print debugging information
+-emacs                 produce logging information without adornments
+-logfile file          use given file for log output
+-logger classname      the class that is to perform logging
+-listener classname    add an instance of class as a project listener
+-buildfile file        use specified buildfile
+-find file             search for buildfile towards the root of the filesystem and use the first one found
+-Dproperty=value       set property to value
+
+

Examples

+
+ 
ant
+
+

runs Ant using the build.xml file in the current directory, on +the default target.

+
+ 
ant -buildfile test.xml
+
+

runs Ant using the test.xml file in the current directory, on +the default target.

+
+ 
ant -buildfile test.xml dist
+
+

runs Ant using the test.xml file in the current directory, on a +target called dist.

+
+ 
ant -buildfile test.xml -Dbuild=build/classes dist
+
+

runs Ant using the test.xml file in the current directory, on a +target called dist, setting the build property to the +value build/classes.

+ +

Running Ant by Hand

+

If you have installed Ant in the do-it-yourself way, Ant can be started +with:

+
+ 
java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]
+
+ +

These instructions actually do exactly the same as the ant +command. The options and target are the same as when running Ant with the ant +command. This example assumes you have set your classpath to include:

+ +
+
+

Copyright © 2000,2001 Apache Software Foundation. All rights +Reserved.

+ + + + diff --git a/docs/manual/toc.html b/docs/manual/toc.html index 31d223eaa..36c01029a 100644 --- a/docs/manual/toc.html +++ b/docs/manual/toc.html @@ -11,6 +11,7 @@

Table of Contents

Introduction
Installing Ant
+Running Ant
Using Ant
Built-in Tasks
Optional Tasks