# <ccmklabel>

Applies a ClearCase label.

This task uses the `cleartool mklabel` command to apply a ClearCase label to specified elements.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
typename | string | Name of the label type | True
comment | string | Specify a comment. Only one of `comment` or `commentfile` may be used. | False
commentfile | file | Specify a file containing a comment. Only one of `comment` or `commentfile` may be used. | False
follow | bool | For any VOB symbolic links encountered, labels the corresponding target. | False
recurse | bool | If true, process each subdirectory recursively under the viewpath. Default is false. | False
replace | bool | If true, allow the replacement of a label of the same type on the same branch. The default is false. | False
version | string | Identify a specific version to attach the label to. | False
viewpath | file | Path to the ClearCase view file or directory that the command will operate on. | False
vob | string | Path to the ClearCase view file or directory that the command will operate on. | 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
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
--- | --- | --- | ---
exename | string | The name of the executable that should be used to launch the external program. | False
useruntimeengine | bool | 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

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

- Performs a ClearCase mklabel on the file `c:/views/viewdir/afile` under the `main` branch for `version 2` (`\main\2`). All matching elements will be applied with label `VERSION_1`. `Some comment text` is added as a comment. Subdirectories will be recursed.

      <ccmklabel viewpath="c:/views/viewdir/afile"
              comment="Some comment text"
              recurse="true"
              version="\main\2"
              typename="VERSION_1"/>

### Requirements

Assembly: NAnt.Contrib.Tasks (0.85.2479.0)

### See Also

<ccmklbtype>