The following section describes the syntax used for the compound
VCMUtility option
<check-out options>.
[+cwf] [+eol {on | off | cr | lf | crlf}] [+filter {CGIMOU}] [+o] [+ro] [+rp <work folder path>]
Specifies non-default check-out options. The available check-out options are similar to those provided by the
StarTeam command-line (stcmd), except that option names must be prefixed with a ‘
+
’ sign. The available options are detailed below.
- +cwf
- Requests the creation of working folders for all specified folders, even if they do not have files to be checked-out by this run. Only visible folders are created.
- +eol <eol option>
- Requests conversion of all end-of-line delimiters for text files to the specified format. An
<eol option> of
on uses the client-configured EOL format.
off prevents any EOL conversion.
cr,
lf, and
crlf cause each EOL to be converted to a carriage-return, line-feed, or carriage-return/line-feed pair, respectively. Note that text files with a "fixed" EOL format are always converted to the specified format.
- +filter
-
+filter {CGIMOU}
Specifies the status of files to consider for check-out:
Current, merGe, mIssing,
Modified,
Out-of-date, or
Unknown. Multiple status flags can be combined. If
+filter is not specified, the default filter is
IO (Missing and
Out-of-date). If
Merge,
Merge, or
Unknown files are included without the
+o option, a warning is generated for each such file, and the file is not checked out.
- +o
- Specifies that, in addition to
Missing and
Out-of-date files, files whose status is
Modified,
Merge, or
Unknown are included. Furthermore, all files are overwritten without warning. If
+filter is also specified, only the specified files are checked out.
- +ro
- Sets each file to read-only after check out. By default, checked-out files are read-write.
- +rp
- Specifies the root working folder of the "merge preview". Files are checked-out to child working folders relative to
<work folder path>.