Return-Path: Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm Delivered-To: mailing list ant-dev@jakarta.apache.org Received: (qmail 12437 invoked by uid 500); 24 Sep 2000 08:45:55 -0000 Delivered-To: apmail-jakarta-ant-cvs@apache.org Received: (qmail 12434 invoked by uid 1142); 24 Sep 2000 08:45:55 -0000 Date: 24 Sep 2000 08:45:55 -0000 Message-ID: <20000924084555.12433.qmail@locus.apache.org> From: conor@locus.apache.org To: jakarta-ant-cvs@apache.org Subject: cvs commit: jakarta-ant/docs index.html conor 00/09/24 01:45:54 Modified: docs index.html Log: Documentation update - Put UpToDate in the correct sort-order - Added docs for antcall-task - Added docs for mail-task (copied from javadoc's) - Removed and colons from

Parameters:

and

Description:

- Removed 'illegal' high ASCII-Values from the file to make MS IE and Homesite (CSE HTML Validator) happy Added Nico as an author :-) Submitted by: Nico Seessle Revision Changes Path 1.113 +128 -38 jakarta-ant/docs/index.html Index: index.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/index.html,v retrieving revision 1.112 retrieving revision 1.113 diff -u -r1.112 -r1.113 --- index.html 2000/09/20 15:53:25 1.112 +++ index.html 2000/09/24 08:45:54 1.113 @@ -21,6 +21,7 @@

Conor MacNeill (conor@cortexebusiness.com.au)

Stefano Mazzocchi (stefano@apache.org)

Sam Ruby (rubys@us.ibm.com)

Nico Seessle (nico@seessle.de)

Roger Vaughn (rvaughn@seaconinc.com)

Dave Walend (dwalend@cs.tufts.edu)

@@ -751,7 +752,7 @@ taken to be an exclude pattern -

Examples:

Examples

   <patternset id="non.test.sources" >
     <include name="**/*.java" />
  @@ -818,7 +819,7 @@
       No
     
   
  -Examples:
  +Examples
      <fileset dir="${server.src}" >
     <patternset id="non.test.sources" >
  @@ -841,6 +842,7 @@
   Built in tasks
   
     Ant
  +  AntCall
     AntStructure
     Available
     Chmod
  @@ -863,6 +865,7 @@
     Java
     Javac
     Javadoc/Javadoc2
  +  Mail
     Mkdir
     Patch
     Property
  @@ -876,17 +879,17 @@
     Taskdef
     Touch
     Tstamp
  -  Uptodate
     Unjar
     Untar
     Unwar
     Unzip
  +  Uptodate
     War
     Zip
   
   
   Ant
  -Description:
  +Description
   Runs Ant on a supplied buildfile. This can be used to build subprojects.
   When the antfile attribute is omitted, the file "build.xml"
   in the supplied directory (dir attribute) is used.
  @@ -897,7 +900,7 @@
   (See also the properties task). You can set properties
   in the new project from the old project by using nested property tags. This
   allows you to parameterize your subprojects.
  -Parameters:
  +Parameters
   
  @@ -913,7 +916,7 @@
       
  - � �
  +    
  @@ -929,18 +932,55 @@
   
     
       Attribute dir
    	the directory to use as a basedir for the new Ant project. 
   					 Defaults to the current directory. No No
     
     
       target
   Examples
     - �<ant antfile="subproject/subbuild.xml" dir="subproject" target="compile" />
  +  <ant antfile="subproject/subbuild.xml" dir="subproject" target="compile" />
  +
  +  <ant dir="subproject" />
   
  - �<ant dir="subproject" />
  +  <ant antfile="subproject/property_based_subbuild.xml">
  +    <property name="param1" value="version 1.x" />
  +    <property file="config/subproject/default.properties" />
  +  </ant>
  +
  +
  +AntCall
  +Description
  +Call another target within the same build-file optionally specifying some
  +properties (param's in this context)
  +Parameters
  +
  +  
  +    
  +    
  +    
  +  
  +  
  +    
  +    
  +    
  +  
  +Attribute Description Required
target The target to execute. Yes
  +Parameters specified as nested elements
  +param
  +Specifies the properties to set before running the specified target. See property for usage guidelines.
  +This will only set the specified properties if the property is not already
  +set in the current project!
  +Examples
  +  +  <target name="default">
  +    <calltarget target="doSomethingElse">
  +      <param name="param1" value="value"/>
  +    </calltarget>
  +  </target>
   
  - �<ant antfile="subproject/property_based_subbuild.xml">
  - � �<property name="param1" value="version 1.x" />
  - � �<property file="config/subproject/default.properties" />
  - �</ant>
  +  <target name="doSomethingElse">
  +    <echo message="param1=${param1}"/>
  +  </target>
   
  +Will run the target 'doSomethingElse' and echo 'param1=value'.
   
   AntStructure
  -Description: 
  +Description 
   Generates a DTD for Ant build files which contains information
   about all tasks currently known to Ant. 
   Note that the DTD generated by this task is incomplete, you can
  @@ -950,7 +990,7 @@
   a way to get around this problem.
   This task doesn't know about required attributes, all will be
   listed as #IMPLIED.
  -Parameters:
  +Parameters
   
  @@ -973,7 +1013,7 @@
   Sets a property if a resource is available at runtime. This resource can be a
   file resource, a class in classpath or a JVM system resource.
If the resource is present, the property value is set to true by
  -default, otherwise the property is not set. �You can set the value to
  +default, otherwise the property is not set. You can set the value to
   something specific by using the value attribute.
Normally, this task is used to set properties that are useful to avoid target
   execution depending on system parameters.
  @@ -989,12 +1029,12 @@
       
  - �
  - � �
  - � �
  - � �
  - �
  +    
  +    
  +    
  +  
  +  
  @@ -3002,6 +3042,56 @@
     </javadoc>
  +Mail
  +Description
  +A task to send SMTP email.
  +Parameters
  +
     
       Attribute
   
   the name of the property to set.
       Yes
     
value the value to set the property to. Defaults to "true". No
     value the value to set the property to. Defaults to "true". No

       classname
       the class to look for in classpath.
       Yes
     
   
  +  
  +    
  +    
  +    
  +  
  +  
  +    
  +    
  +    
  +  
  +  
  +    
  +    
  +    
  +  
  +  
  +    
  +    
  +    
  +  
  +  
  +    
  +    
  +  
  +  
  +    
  +    
  +    
  +  
  +  
  +    
  +    
  +    
  +  
  +Attribute Description Required
from Email address of sender. Yes
tolist Comma-separated list of recipients. Yes
message Message to send in the body of the email. Yes
files Filename(s) of text to send in the body of the email. 
  +	Multiple files are comma-separated.
mailhost Host name of the mail server. No, default to "localhost"
subject Email subject line. No
  +Examples
  +  +  <mail from="me" tolist="you" subject="Results of nightly build"
  +        files="build.log"/>
  +Sends an eMail from me to you with a subject of 
  +Results of nightly build and includes the contents of build.log
  +in the body of the message.
  +
  +
   Mkdir
   Description
   Creates a directory. Also non-existent parent directories are created, when
  @@ -4113,7 +4203,7 @@
   
   

   Cab
  -Description:
  +Description
   The cab task creates Microsoft cab archive files.  It is invoked
   similar to the jar or zip tasks.
   This task will only work on Windows, and will be silently ignored on
  @@ -4127,7 +4217,7 @@
   (dir becomes basedir) as well as the nested
   <include>, <exclude> and
   <patternset> elements.
  -Parameters:
  +Parameters
   
  @@ -4226,7 +4316,7 @@
   output.
FTP
  -Description:
  +Description
The ftp task implements a basic FTP client that can send, receive,
   list, and delete files.  See below for descriptions and examples of how
   to perform each task.
  @@ -4239,7 +4329,7 @@
   See the section on directory based
   tasks, on how the inclusion/exclusion of files works, and how to
   write patterns.
  -Parameters:
  +Parameters

     
       Attribute
   
   
   
   
  @@ -4413,7 +4503,7 @@
   If you don't have permission to delete a file, a BuildException is thrown.
Listing Files
  -  <ftp action="list"
  +  <ftp action="list"
          server="ftp.apache.org"
          userid=quot;anonymous"
          password="me@myorg.com" 
  @@ -4425,10 +4515,10 @@
   
This provides a file listing in data/ftp.listing of all the files on
   the FTP server relative to the default directory of the anonymous
  -user. �The listing is in whatever format the FTP server normally lists files.
  +user. The listing is in whatever format the FTP server normally lists files.
NetRexxC
  -Description:
  +Description
Compiles a NetRexx
   source tree within the running (Ant) VM.
The source and destination directory will be recursively scanned for
  @@ -4456,7 +4546,7 @@
   <include>, <exclude> and
   <patternset> elements.
   
  -Parameters:
  +Parameters

     
       Attribute
   
   
   
   
   
   
   
   
  @@ -4690,7 +4780,7 @@
   
RenameExtensions
  -Description:
  +Description
Renames files in the srcDir directory ending with the
   fromExtension string so that they end with the 
   toExtension string. Files are only replaced if 
  @@ -4704,7 +4794,7 @@
   (dir becomes srcDir) as well as the nested
   <include>, <exclude> and
   <patternset> elements.
  -Parameters:
  +Parameters

     
       Attribute
   
   
   
   
  @@ -4780,14 +4870,14 @@
   
   
Script
  -Description:
  +Description
Execute a script in a 
     BSF supported language.
   
All items (tasks, targets, etc) of the running project are
   accessible from the script, using either their name or
   id attributes.
Scripts can do almost anything a task written in Java could do.
  -Parameters:
  +Parameters

     
       Attribute
   
   
   
   
  @@ -4885,11 +4975,11 @@
   
VssGet
  -Description:
  +Description
   Task to perform GET commands to Microsoft Visual Source Safe.
   If you specify two or more attributes from version, date and 
   label only one will be used in the order version, date, label.
  -Parameters:
  +Parameters

     
       Attribute
   
   
   
  @@ -4954,11 +5044,11 @@
           vsspath="/source/aProject"
           writable="true"/>
   
  -Does a get on the VSS-Project $/source/aproject using the username
  +
  +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.
  -
  +C:\mysrc\myproject. The local files will be writable.
Build Events
   Ant is capable of generating build events as it performs the tasks necessary to build a project. 
  @@ -5126,7 +5216,7 @@
   href="http://archive.covalent.net/">http://archive.covalent.net/. Many
   thanks to Covalent Technologies.

  -Copyright � 2000 Apache Software Foundation. All rights
  +
Copyright © 2000 Apache Software Foundation. All rights
   Reserved.

     
       Attribute

Attribute	dir	the directory to use as a basedir for the new Ant project. Defaults to the current directory.	No	No
target

Attribute	Description	Required
target	The target to execute.	Yes

Attribute	the name of the property to set.	Yes
value	the value to set the property to. Defaults to "true".	No
value	the value to set the property to. Defaults to "true".	No
classname	the class to look for in classpath.	Yes