<sscmbatch>

[This is preliminary documentation and subject to change.]

Processes Surround SCM batch files.

Processes the batch commands found in the input file. Each line in the input file should contain a single Surround SCM command including proper command line options. The sscm command, Surround SCM server address, port number, username and password are not required for each command line.

Parameters

AttributeTypeDescriptionRequired
inputfile File to read commands from. True
outputfile File to direct all standard output to. When executing commands from the input file, all output is written to this file instead of being displayed on the screen. False
failonerrorbool Determines if task failure stops the build, or is just reported. The default is true. False
ifbool If true then the task will be executed; otherwise, skipped. The default is true. False
serverconnectstring The address and port number of the Surround SCM server host computer. Format is server:port. If not entered, the last saved connection parameters are used. False
serverloginstring The username and password used to login to the Surround SCM server. Format is username:password. If not entered, the last saved login parameters are used. False
timeoutint The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. False
unlessbool Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. False
verbosebool Determines whether the task should report detailed build log messages. The default is false. False

Framework-configurable parameters

AttributeTypeDescriptionRequired
useruntimeenginebool Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. False

Nested Elements:

<arg>

The command-line arguments for the external program.

Represents a command-line argument.

Parameters

AttributeTypeDescriptionRequired
filefile The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. False
ifbool Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true. False
linestring List of command-line arguments; will be passed to the executable as is. False
path<path> The value for a PATH-like command-line argument; you can use : or ; as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. False
unlessbool Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false. False
valuestring A single command-line argument; can contain space characters. False

Nested Elements:

<path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

Examples

</arg>

Examples

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.1869.0)