Use delete-local to delete files from a working folder and the working folder itself, if empty of files, resulting from executing this command . You can delete files that are under version control, as well as files that are not in StarTeam. This action does not remove any files from version control. It merely reduces the amount of data stored on your workstation in a working folder. If you are deleting files based on their StarTeam status, it is a good idea to use update-status first.
The syntax for this command is:
stcmd{Ex} delete-local [-p "projectSpecifier" [-epwdfile "filePath"]
[-cmp] [-csf] [-encrypt encryptionType] ] [-is] [-nivf] [-rp "folderPath" |
-fp "folderPath"] [-filter "fileStatus"] [-cfgl "labelName" |
-cfgp "stateName" | -cfgd "asOfDate"] [-q|-pf “filterName”]
[-ofp “resultsOutputFilePath”] [files...]
The full syntax is:
stcmd -p "userName:password@hostName:endpoint/projectName/[viewName/][folderHierarchy/]"
For example:
stcmd -p “bsmith:rocketfive@orion:49201/StarDraw/StarDraw/SourceCode/”
The -epwdfile keyword specifies the path to the file that contains the encrypted password. Like -pwdfile , -epwdfile replaces the password being used as part of the -p or -s option, preventing others from seeing the user's password on the command line. The full syntax is: -epwdfile "filePath" .
The -pwdfile is supported for backward compatibility. Un-encrypted passwords stored using older versions of stcmd are read. However, passwords cannot be stored to files using -pwdfile anymore.
In this case, the syntax of -p or -s reduces to -p "username@hostname:port/... -epwdfile "fullyQualifiedPathToPasswordFile"".
The following is the syntax of the commands that can be used to store an encrypted password.
Use the following syntax to be prompted for the password that will be encrypted and stored in a file.
stcmd store-password -epwdfile "filePath"
stcmd store-password -epwdfile "filePath" -password "password"
After an encrypted password is stored, other stcmd commands can specify -epwdfile "filePath"' as parameters. For example:
stcmd delete-local -p "JMarsh@Orion:1024/StarDraw/StarDraw/SourceCode" -epwdfile "C:\estuff\myfile.txt" -filter "N" "*"
Compresses all the data sent between the workstation and the server and decompresses it when it arrives. Without this option, no compression takes place.
Compression speeds transmission across the network, but it takes time on the front end to compress the data and at the back end to decompress the data.
This is an optional parameter. If not specified, then the platform default is not to compress.
When the command maps the folder specified in the -p option to the underlying StarTeam folder, using -csf causes the command to differentiate StarTeam folders based on the case-sensitive spelling of their names This option does not apply to the case-sensitivity of filenames in the folders. For example, with -csf, StarTeam folders named doc and Doc are recognized as different folders. Without this option, either folder could be recognized as the doc folder.
The default is that StarTeam folders are not differentiated based on the case of letters in their names.
With or without -csf, if folder names are ambiguous, an error occurs. For example, when you use -csf, the names of two folders are ambiguous if both a Doc and doc folder exist. When you do not use -csf, folder names are ambiguous if they are spelled identically.
Encrypts all data sent between the workstation and the server and decrypts it when it arrives. Without this option, no encryption takes place. Encryption protects files, data and other project information from being read by unauthorized parties over unsecured networks.
This is an optional parameter. If not specified, then the server and the command line negotiate the encryption required by the server.
The full syntax is: -encrypt encryptionType.
The types of encryption are:
These encryption types are ordered from fastest to slowest. Each of the slower encryption types is safer than the one preceding it.
When used with add or ci, the command recursively visits all modified files in all sub-folders and checks them in.
Overrides the working folder or working directory for the StarTeam view’s root folder.
While this option allows you to use a different working folder than the one specified by the StarTeam view, its critical importance is to provide cross-platform compatibility. For example, UNIX and Microsoft Windows systems specify drive and directory path names in incompatible ways.
While the path D:\MYPRODUCT\DEVELOPMENT\SOURCE is understood on a Microsoft Windows platform, it is not understood on a UNIX platform. Use this option to define the working path if your platform does not understand the path specified in the StarTeam project.
The UNIX shell interprets a backslash (\) as an escape character when it precedes certain characters, such as quotation marks. As a result, an error occurs in the following example:
stcmd ci -p "xxx" -rp "C:\" "*"
which is interpreted as:
stcmd ci -p "xxx" -rp "C:" *"
To avoid a situation like this, escape the final character in "C:\" as follows:
stcmd ci -p "xxx" -rp "C:\\" "*"
Or avoid it as follows when the -rp path doesn’t end with the root folder as in "C:\orion\":
stcmd ci -p "xxx" -rp "C:\orion" "*"
The full syntax is: -rp "folderName" .
Folder is the Microsoft Windows term and appears in the StarTeam user interface. Directory is the correct term for the UNIX platform.
Overrides the specified StarTeam folder’s working folder or working directory. This is equivalent to setting an alternate working path for the folder.
While this option allows you to use a different working folder than the one specified by the StarTeam view, its critical importance is to provide cross-platform compatibility. For example, UNIX and Microsoft Windows systems specify drive and directory path names in incompatible ways.
While the path D:\MYPRODUCT\DEVELOPMENT\SOURCE is understood on a Microsoft Windows platform, it is not understood on a UNIX platform. Use this option to define the working path if your platform does not understand the path specified in the StarTeam project.
A backslash (\) is interpreted as an escape character when it precedes quotation marks. As a result, an error occurs in the following example:
stcmd ci -p "xxx" -fp "C:\" "*"
which is interpreted as:
stcmd ci -p "xxx" -fp "C:" *"
To avoid a situation like this, escape the final character in "C:\" as follows:
stcmd ci -p "xxx" -fp "C:\\" "*"
Or avoid it as follows when the -rp path doesn’t end with the root folder as in C:\orion\:
stcmd ci -p "xxx" -fp "C:\orion" "*"
The full syntax is: -rp "folderName".
Folder is the Microsoft Windows term and appears in the StarTeam user interface. Directory is the correct term for the UNIX platform.
"12/29/13 10:52 AM"
"December 29, 2013 10:52:00 AM PST"
"Monday, December 29, 2013 10:52:00 AM PST"
Provides a file name with a fully qualified path into which to write the command output. By default, a "|" character separates each column in the output. A new line separates each row. The first row is the command name. The second row has the property names. All subsequent rows contain the data. If the file already exists, the output is appended to the end of the file.
It is possible to override the "|" character separator by specifying separator = fieldSeparator as a parameter to the connect command.
For example, separator = ;; specifies two adjacent semicolons ( ; ) as the column separator.
Specifies the files to be used in the command by name or by file name-pattern specification, such as "*.c". All options are interpreted using the semantic conventions of UNIX instead of Windows because UNIX conventions are more specific. This means that "*", rather than "*.*" means “all files.” The pattern "*.*" means “all files with file name extensions.” For example, “star*.*” finds starteam.doc and starteam.cpp, but not starteam. To find all of these, you could use "star*".
Without this option, the default is "*". When used, this option must always be the last option. Any options after it are ignored.
If you use *, rather than "*" to indicate all files, a UNIX shell expands it into a series of items and passes this series as a group of options to the stcmd command. This can cause problems, for example, when you are checking out missing files, so it is best to use "*" to avoid unwanted complications.
If you use a set of file patterns, each pattern should be enclosed in its own set of quotation marks. For example, you can use "*.bat" "*.c", but you cannot use "*.bat *.c".
Several special characters can be used in the file specification:
If the first character following the right bracket ( [ ) is an exclamation point (!) or a caret ( ^ ), the rest of the characters are not matched. Any character not enclosed in the brackets is matched. For example, "x[a-d]y" matches "xby" but not "xey". "x[!a-d]y" matches "xey" but not "xby".
A hyphen (-) or right bracket ( ] ) may be matched by including it as the first or last character in the bracketed set.
To use an asterisk (*), question mark (?), or left bracket ( [ ) in a pattern, you must precede it with the escape character (which is the backslash (\).
The following example uses delete-local to delete some files from the working folder for the StarTeam folder named SourceCode. SourceCode is a child of the root folder StarDraw (in the StarDraw view of the StarDraw project). This example deletes all files that are not under version control. Those files have the file status Not In View.
Use the -p with delete-local or the stateful set command to set the context of the project/view/parent folder.
stcmd delete-local -filter "N" "*"