SourceOffSite Tasks User Manual

- -

by -

Jesse Stockall

-Version 1.1 2002/01/23 -
-
- -

- -

Introduction
The Tasks

-
- -

Introduction

- -

These tasks provide an interface to the -Microsoft Visual SourceSafe SCM via -SourceGear's SourceOffSite -product. SourceOffSite is an add-on to Microsoft's VSS, that allows remote -development teams and tele-commuters that need fast and secure read/write -access to a centralized SourceSafe database via any TCP/IP connection. SOS -provides Linux ,Solaris & Windows clients. The - org.apache.tools.ant.taskdefs.optional.sos -package consists of a simple framework to support SOS functionality as well -as some Apache Ant tasks encapsulating frequently used SOS commands. Although it -is possible to use these commands on the desktop, they were primarily intended -to be used by automated build systems. These tasks have been tested with -SourceOffSite version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks -have been tested with Linux, Solaris & Windows2000.

- -

The Tasks

- - - - - - - - - - - - - - - - - - - - - -

sosget	Retrieves a read-only copy of the specified project or file.
soslabel	Assigns a label to the specified project.
soscheckin	Updates VSS with changes made to a checked out file or project, - and unlocks the VSS master copy.
soscheckout	Retrieves a read-write copy of the specified project - or file, locking the VSS master copy

-
- -

Task Descriptions

- -

SOSGet
-

Description

- Task to perform GET commands with SOS
-

Attribute	Values	Required
soscmd	Directory which contains soscmd(.exe) - soscmd(.exe) must be in the path if this is not specified	No
vssserverpath	path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini	Yes
sosserverpath	address & port of the SOS server - eg. 192.168.0.1:8888	Yes
projectpath	SourceSafe project path - eg. $/SourceRoot/Project1	Yes
file	Filename to act upon - If no file is specified then act upon the project	No
username	SourceSafe username	Yes
password	SourceSafe password	No
localpath	Override the working directory and get to the specified path	No
soshome	The path to the SourceOffSite home directory	No
nocompress	true or false - disable compression	No
recursive	true or false - Only works with the GetProject command	No
version	a version number to get - Only works with the GetFile command	No
label	a label version to get - Only works with the GetProject command	No
nocache	true or false - Only needed if SOSHOME is set as an environment variable	No
verbose	true or false - Status messages are displayed	No

Attribute	Values	Required
soscmd	Directory which contains soscmd(.exe) - soscmd(.exe) must be in the path if this is not specified	No
vssserverpath	path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini	Yes
sosserverpath	address and port of the SOS server - eg. 192.168.0.1:8888	Yes
projectpath	SourceSafe project path - eg. $/SourceRoot/Project1	Yes
username	SourceSafe username	Yes
password	SourceSafe password	No
label	The label to apply to a project	Yes
comment	A comment to be applied to all files being labeled	No
verbose	true or false - Status messages are displayed	No

Attribute	Values	Required
soscmd	Directory which contains soscmd(.exe) - soscmd(.exe) must be in the path if this is not specified	No
vssserverpath	path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini	Yes
sosserverpath	address and port of the SOS server - eg. 192.168.0.1:8888	Yes
projectpath	SourceSafe project path - eg. $/SourceRoot/Project1	Yes
file	Filename to act upon If no file is specified then act upon the project	No
username	SourceSafe username	Yes
password	SourceSafe password	No
localpath	Override the working directory and get to the specified path	No
soshome	The path to the SourceOffSite home directory	No
nocompress	true or false - disable compression	No
recursive	true or false - Only works with the CheckOutProject command	No
nocache	true or false - Only needed if SOSHOME is set as an environment variable	No
verbose	true or false - Status messages are displayed	No
comment	A comment to be applied to all files being checked in	No

Attribute	Values	Required
soscmd	Directory which contains soscmd(.exe) - soscmd(.exe) must be in the path if this is not specified	No
vssserverpath	path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini	Yes
sosserverpath	address and port of the SOS server - eg. 192.168.0.1:8888	Yes
projectpath	SourceSafe project path - eg. $/SourceRoot/Project1	Yes
file	Filename to act upon If no file is specified then act upon the project	No
username	SourceSafe username	Yes
password	SourceSafe password	No
localpath	Override the working directory and get to the specified path	No
soshome	The path to the SourceOffSite home directory	No
nocompress	true or false - disable compression	No
recursive	true or false - Only works with the CheckOutProject command	No
nocache	true or false - Only needed if SOSHOME is set as an environment variable	No
verbose	true or false - Status messages are displayed	No

SourceOffSite Tasks User Manual

Contents

Introduction

The Tasks

Task Descriptions

SOSGet
-

Description

Parameters

Example

SOSLabel

Description

Parameters

Example

SOSCheckIn

Description

Parameters

Example

SOSCheckOut

Description

Parameters

Example

SourceOffSite Tasks User Manual

Contents

Introduction

The Tasks

Task Descriptions

SOSGet -

Description

Parameters

Example

SOSLabel

Description

Parameters

Example

SOSCheckIn

Description

Parameters

Example

SOSCheckOut

Description

Parameters

Example

SOSGet
-