Home > Articles

Global Concepts

  • Print
  • + Share This
This chapter is from the book

This chapter is from the book

The Ant Command Line

We've already discussed a few of the Ant command-line switches and arguments, but we need to spend a little time covering all of them. There really aren't that many, but they can fundamentally change the way Ant works.

The general format of an Ant command line looks like Listing 3.77.

Listing 3.77 General Form of Ant Command Line

ant [options] [target...]

Notice that you can specify multiple targets on the command line and they will be executed in the order you gave them. This is optional, and if no targets are given, the default target will be executed.

The options that Ant supports are

  • -help prints a usage message.

  • -version prints the version of Ant and exits.

  • -projecthelp displays the names and descriptions of targets in the build file.

  • -quiet suppresses most output messages to the console.

  • -verbose displays more information about what the build is doing.

  • -debug displays more information than you probably want about what the build is doing.

  • -emacs prints console output in a format that Emacs can parse.

  • -logfile <filename> sends all console output to the given filename.

  • -logger <log class> uses the specified class to log messages.

  • -listener <listener class> uses the specified class to process build events.

  • -buildfile <build filename> uses the specified build file instead of build.xml.

  • -find [build filename] searches for a build.xml file (or the specified filename.

  • -Dkey=value sets a Java property for Ant to use.

  • -propertyfile <filename> sets properties for every line in the specified file.

  • inputhandler <inputhandler class> uses the specified class to process interactive user input.

We'll now discuss each of these with a bit of explanation. We'll begin with -projecthelp because -help and -version are self-explanatory.

-projecthelp

This switch is extremely useful, especially with a new project or if you've just gotten a build file from someone else. It will print the names and descriptions of each target in the file, indicating which target is the default. Listing 3.78 shows the output using the build file for Ant itself.

Listing 3.78 Shows -projecthelp Output

Buildfile: build.xml
Main targets:

 allclean      --> cleans up everything
 bootstrap     --> creates a bootstrap build
 build       --> compiles the source code
 clean       --> cleans up build and dist directories
 dist        --> creates a complete distribution
 dist-lite     --> creates a minimum distribution to run Apache Ant
 distribution    --> creates the full Apache Ant distribution
 interactive-tests --> runs interactive tests
 jars        --> creates the Apache Ant jars
 javadocs      --> creates the API documentation
 main        --> creates a minimum distribution in ./dist
 main_distribution --> creates the zip and tar distributions
 run-single-test  --> -runs the single unit test defined in the testcase property
 src-dist      --> creates a source distribution
 test        --> run JUnit tests
 test-jar      --> creates the Apache Ant Test Utilties jar
 test-javadocs   --> creates the API documentation for test utilities

Default target: main

You can see from the last line that if you do not specify a target to execute, the target called main will be run.

Notice that each of the targets has some descriptive text after the name. This is taken from the description attribute of each target. If you don't specify any description attributes, Ant will display all of your targets in response to a -projecthelp. As soon as you specify one target with a description attribute, Ant will display only those targets that have a description. So, after you start setting descriptions, you have to take it to completion if you want your project help to be useful. You can omit descriptions for targets that are purely internal to the build and should never be called by a user.

-quiet, -verbose, and -debug

These three switches control how much or how little information is sent to the logger or console. -quiet will output only errors, which is quite a bit less text than running Ant without -quiet. -verbose will print several hundred lines of information, showing properties, classpaths, and other settings; -debug prints an even more in-depth listing. If you're having problems with a build, try using one of these two switches to increase the amount of output. One interesting thing that will be displayed when using -verbose or -debug is that FileSets will display the files they are processing and whether or not they have been selected.

-emacs

If you are executing Ant from within Emacs, you must use this switch to cause Ant to alter its output so that Emacs can parse it. If you do this, Emacs will be able to take you to the source of errors in your source file. Otherwise, you'll have to manually navigate to these locations.

-logfile <filename>

By default, Ant logs everything to the console. You can redirect this output to a file by specifying the -logfile switch and giving a filename to log to. If there is already a file with that name, it will be overwritten.

-logger <log class>, -listener <listener class>

-logger enables you to replace the DefaultLogger with a different logger. -listener enables you to replace the event listener. Consult the "Listeners and Loggers" section earlier in this chapter for more details and a list of available loggers and listeners.

-buildfile <build filename>

By default Ant looks for a file called build.xml in the current directory. If you want to specify a different file, either in the current directory or elsewhere, pass it as the parameter to the -buildfile switch.

-find [build filename]

The -find switch is similar to -buildfile in that it lets you give an alternative build file to execute. However, instead of telling Ant specifically where the file is, the -find switch forces Ant to search for the alternative build file. If you don't give a filename, Ant will search for build.xml. The search rules are contrary to what you might expect, however. You would generally expect a find to start in the current directory and work down. The -find switch actually searches from the current directory up. In other words, it would first look for the build file in the current directory, and then it would move to its parent, and then its parent, and so forth, either until it found a build file or reached the drive root.

-Dkey=value

The -D switch is identical to the Java -D switch; it enables you to set properties from the command line. For example, if you had a target that executes only if the release.build property has been set, you could run Ant as in Listing 3.79 to set this property.

Listing 3.79 Setting a Property from the Command Line

ant -Drelease.build=true build

NOTE

It is important to note that properties set on the command line take precedence over those set by <property> tasks or in properties files. This is useful to occasionally change a property that needs to be at its default most of the time.

-propertyfile <filename>

This switch is equivalent to specifying a loadproperties task inside your build file. It will load all the key/value pairs from this properties file as properties that can be used in your build.

-inputhandler <inputhandler class>

This switch is a bit more esoteric than the others. Its purpose is to specify a different class to handle user input during the <input> task. This task enables you to prompt your user for input to answer build questions, and so on. The input task is covered in Chapter 4.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020