Return-Path: Delivered-To: apmail-jakarta-ant-dev-archive@jakarta.apache.org Received: (qmail 51485 invoked by uid 500); 15 Mar 2001 22:21:40 -0000 Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk Reply-To: ant-dev@jakarta.apache.org list-help: list-unsubscribe: list-post: Delivered-To: mailing list ant-dev@jakarta.apache.org Received: (qmail 51421 invoked from network); 15 Mar 2001 22:21:36 -0000 Message-ID: <7783A141C794D4118AAA00306E00B0B11255ED@msgatl06.iss.net> From: "Di Iorio, Matthew (ISS Atlanta)" To: "'ant-dev@jakarta.apache.org'" Subject: [SUBMIT] docs for starteam optional task Date: Thu, 15 Mar 2001 17:18:02 -0500 MIME-Version: 1.0 X-Mailer: Internet Mail Service (5.5.2653.19) Content-Type: multipart/mixed; boundary="----_=_NextPart_000_01C0AD9D.CCD9F240" X-Spam-Rating: h31.sny.collab.net 1.6.2 0/1000/N This message is in MIME format. Since your mail reader does not understand this format, some or all of this message may not be legible. ------_=_NextPart_000_01C0AD9D.CCD9F240 Content-Type: text/plain; charset="iso-8859-1" Attached is documentation for the starteam optional task. Matt ------_=_NextPart_000_01C0AD9D.CCD9F240 Content-Type: text/html; name="starteam.html" Content-Transfer-Encoding: quoted-printable Content-Disposition: attachment; filename="starteam.html" Ant User Manual

Starteam

Description

Checks out files from a StarTeam project.

The includes and excludes attributes function differently = from other tasks in Ant. Multiple patters must be seperated by spaces, not commas. See the examples for more information.

This program makes use of functions from the StarTeam API. As a result this task is only available to licensed users of StarTeam. You must = have starteam-sdk.jar in your classpath to run this task. For more information about the StarTeam API and how to license it, see the StarBase web site.

Parameters

=20 =20
Attribute Description Required
servername The name of the StarTeam server. yes
serverport The port number of the StarTeam server. yes
projectname The name of the StarTeam project. yes
viewname The name of the view in the StarTeam = project. yes
username The username of the account used to log in to = the StarTeam server. yes
password The password of the account used to log in to = the StarTeam server. yes
targetfolder The folder to which files are checked out. yes
foldername The subfolder in the project from which to check = out files. no
force Overwrite existing folders if this is set to = "true". Defaults to "false". no
recursion Indicates if subfolders should be searched for = files to check out. Defaults to "true". no
verbose Provides progress information. Defaults to = "false". no
includes Only check out files that match at least one of = the patterns in this list. Patterns must be seperated by spaces. = Patterns in excludes take precedence over patterns in = includes. no
excludes Do not check out files that match at least one = of the patterns in this list. Patterns must be seperated by spaces. = Patterns in excludes take precedence over patterns in = includes. no

Examples

  <starteam servername=3D"STARTEAM"=20
            serverport=3D"49201"
            projectname=3D"AProject"=20
            viewname=3D"AView"
            username=3D"auser"
            password=3D"secret"
            targetfolder=3D"C:\dev\buildtest\co"
  />
The minimum necessary to check out files out from a StarTeam server. = This will check out all files in the AView view of the AProject = project to C:\dev\buildtest\co. 
  <starteam servername=3D"STARTEAM"=20
            serverport=3D"49201"
            projectname=3D"AProject"=20
            viewname=3D"AView"
            username=3D"auser"
            password=3D"secret"
            targetfolder=3D"C:\dev\buildtest\co"
            foldername=3D"\Dev"
            excludes=3D"*.bak *.old"
            force=3D"true"
  />
This will checkout all files from the Dev folder and below that = do not end in .bak or .old. The force flag will cause any = existing files to be overwritten by the version in StarTeam. 
  <starteam servername=3D"STARTEAM"=20
            serverport=3D"49201"
            projectname=3D"AProject"=20
            viewname=3D"AView"
            username=3D"auser"
            password=3D"secret"
            targetfolder=3D"C:\dev\buildtest\co"
            includes=3D"*.htm *.html"
            excludes=3D"index.*"
  />
This is an example of overlapping includes and excludes = attributes. Because excludes takes precedence over includes, files named = index.html will not be checked out by this command.

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

------_=_NextPart_000_01C0AD9D.CCD9F240--