# <sscmbranch>

[This is preliminary documentation and subject to change.]

Creates new branches for Surround SCM.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
branch | string | The name of the branch you want to create. | True
repository | string | The full repository path. | True
bylabel | string | Specifies which parent branch file versions are copied into the child branch. | False
bytimestamp | string | Specifies which parent branch file versions are copied into the child branch. Format is yyyymmddhh:mm:ss. If `bylabel` attribute is specified, this parameter is ignored. | False
comment | string | Specifies a comment for the branch operation. | False
includeremoved | bool | Include removed files when creating a branch with the `bylabel` or `bytimestamp` option. The default is true. | False
parent | string | The parent branch you want to create the new, child branch from. If not specified, the mainline branch is used. | False
type | string | Specifies the type of branch you want to create. Possible values are `workspace`, `baseline`, or `snapshot`. The default is `workspace`. | False
failonerror | bool | Determines if task failure stops the build, or is just reported. The default is true. | False
if | bool | If true then the task will be executed; otherwise, skipped. The default is true. | False
serverconnect | string | 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
serverlogin | string | 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
timeout | int | The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. | False
unless | bool | Opposite of `if`. If false then the task will be executed; otherwise, skipped. The default is false. | False
verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False

### Framework-configurable parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
managed | ManagedExecution | Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. | False
useruntimeengine | bool | Deprecated. Specifies whether the external program is a managed application which 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.

When passed to an external application, the argument will be quoted when appropriate. This does not apply to the `line` parameter, which is always passed as is.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
dir | directory | The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. | False
file | file | The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. | False
if | bool | 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
line | string | 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
unless | bool | 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
value | string | 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

- A single command-line argument containing a space character.

      <arg value="-l -a" />

- Two separate command-line arguments.

      <arg line="-l -a" />

- A single command-line argument with the value `\dir;\dir2;\dir3` on DOS-based systems and `/dir:/dir2:/dir3` on Unix-like systems.

      <arg path="/dir;/dir2:\dir3" />

#### </arg>

### Examples

- Create a new Baseline branch 'Widget 1.0' from branch 'Mainline', repository 'Mainline/Widget' with the given comments. All files are branched at the tip version.

      <sscmbranch
          serverconnect="localhost:4900"
          serverlogin="administrator:"
          branch="Widget 1.0"
          repository="Mainline/Widget"
          parent="Mainline"
          comment="Branch for continuing Widget 1.0 development"
          type="baseline"
      />

- Create a new Workspace branch 'MyWidgetDevelopment' from branch 'Widget 1.0', repository 'Mainline/Widget'. All files are branched at the tip version.

      <sscmbranch
          serverconnect="localhost:4900"
          serverlogin="administrator:"
          branch="MyWidgetDevelopment"
          repository="Mainline/Widget"
          parent="Widget 1.0"
      />

- Create a new Snapshot branch 'Build as of 12-1-03' from branch 'Widget 1.0', repository 'Mainline/Widget' with the given comments. All files are branched at their version as of 12-01-03.

      <sscmbranch
          serverconnect="localhost:4900"
          serverlogin="administrator:"
          name="Build as of 12-1-03"
          repository="Mainline/Widget"
          branch="Widget 1.0"
          comment="Snapshot of source as it was on December 1st, 2003"
          timestamp="2003120300:00:00"
          type="snapshot"
      />

### Requirements

Assembly: NAnt.Contrib.Tasks (0.93.5002.0)