diff --git a/docs/manual/OptionalTasks/starteam.html b/docs/manual/OptionalTasks/starteam.html new file mode 100644 index 000000000..7b426d360 --- /dev/null +++ b/docs/manual/OptionalTasks/starteam.html @@ -0,0 +1,159 @@ + + + +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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
servernameThe name of the StarTeam server.yes
serverportThe port number of the StarTeam server.yes
projectnameThe name of the StarTeam project.yes
viewnameThe name of the view in the StarTeam project.yes
usernameThe username of the account used to log in to the StarTeam server.yes
passwordThe password of the account used to log in to the StarTeam server.yes
targetfolderThe folder to which files are checked out.yes
foldernameThe subfolder in the project from which to check out files.no
forceOverwrite existing folders if this is set to "true". Defaults to "false".no
recursionIndicates if subfolders should be searched for files to check out. Defaults to "true".no
verboseProvides progress information. Defaults to "false".no
includesOnly 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
excludesDo 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="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="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="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="C:\dev\buildtest\co"
+            foldername="\Dev"
+            excludes="*.bak *.old"
+            force="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="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="C:\dev\buildtest\co"
+            includes="*.htm *.html"
+            excludes="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. +

+ + + \ No newline at end of file diff --git a/docs/manual/optionaltasklist.html b/docs/manual/optionaltasklist.html index 792f32ba1..5a2608c83 100644 --- a/docs/manual/optionaltasklist.html +++ b/docs/manual/optionaltasklist.html @@ -34,6 +34,7 @@ RenameExtensions
Script
Sound
+Starteam
Stylebook
Telnet
Test