File Options

Use File Options to customize the way you work with files. In a few cases (such as Marking Unlocked Files Read Only), your administrator's choices may override your preferences.

Note: The Show 'Deleted' File Status Values personal option is removed from StarTeam Cross Platform client, as multiple users reported confusion with the deleted status values.

To use File Options to customize the way you work with files, select Tools > Personal Options > File, and use the options described in the table below.

Check-out

Use last modification time for check-out files

Uses the same time for each checked-out file as the time stamp of the revision being checked out. Otherwise, the time stamp used for the checked-out file is the current time (the time check-out occurs.)

Merging
Use last modification time for check-out files Uses the same time for each checked-out file as the time stamp of the revision being checked out. Otherwise, the time stamp used for the checked-out file is the current time (the time check-out occurs.)
Always pop-up merge utility Opens the merge utility to display the merged file even when there are no conflicts.
Locking
Exclusively lock files on check-out Sets the default Lock Status option to Exclusive in the Check Out dialog box . Otherwise, the default is Keep Current.
Clear file locks on check-in Sets the default Lock Status option to Unlock in the Check Out dialog box. Otherwise, the default is Keep Current.
Use non-exclusive locks in integration Creates a non-exclusive lock when locking a file from the application integration– that is, a lock that allows others to check in the file. Using non-exclusive locks also allows more than one person to edit a file at one time. If team members are not editing the same lines of the file, the merged file usually has no conflicts.
Mark unlocked working files read-only Sets working copies of files that you have not locked to read-only when you add files, check in files, check out files, or unlock files. If this check box is selected, only locked files can be edited.
EOL

Automatic EOL conversion for check-out operations

Performs an automatic EOL conversion on check-out operations. If selected, also select the operating system on which you are working:

  • Windows (CR-LF)
  • Unix(LF)
  • Mac(R)

Files can be checked out in LF format on every platform, regardless of specific options.

The EOL Format property can be set in the StarTeam Cross-Platform Client in the Add/Check-in and File Properties dialog boxes.

The default for automatic EOL conversion for check-out operations is selected if the user does not have that option defined already.

The EOL Property values are:

Undefined

(null in the SDK).

Client Defined

Causes workstation default or per-checkout EOL conversion option to be used.

Fixed CR, Fixed LF, and Fixed CRLF

Causes this EOL format to be used always. The workstation/check-out conversion option is ignored.

Note: Once EOL Format is defined, Update Status works for all text files, regardless of what EOL format was used when they were checked-out. For compatibility with older Clients, if check-out "EOL conversion" is not requested, and EOL Format is Undefined, files are still checked out with the EOL convention with which they were added to the StarTeam Server.

General

Use file checksums (MD5) to calculate status

Uses the checksum instead of the file time stamp and size to compute the Statusfield when the application is refreshed. Using the checksum provides a more accurate status value than the time stamp, but takes longer. If not selected, the application uses the time stamp and size.

File encoding for keyword expansion

Specifies the code page to be used for keyword expansion by choosing a default file encoding from the list.

Repository

File status repository default

Indicates where you want file status information stored, either in a central repository location on your workstation or in a child folder (named .sbas) of each working folder.

Central You can enter or browse for a location on your computer other than the default central repository location. Whenever you make a change to a file in the working folder, the status for that file is undated only on your computer in the specified location. Everyone else sees the status Unknown for that file. Over time, all the files may have been changed, and the statuses can become Unknown for all users of all files.
Per-folder Useful in the special case where multiple users are sharing a working folder, for example, on a shared network drive. For example, suppose several users all check files in and out of a shared working folder. If these users have set the central repository option for file statuses, the statuses are stored on each of their computers. Whenever a user makes a change to a file in the working folder, the status for that file is undated only on that user’s computer. Everyone else sees the status Unknown for that file. Over time, all the files may have been changed, and the statuses can become Unknown for all users of all files. Using the per-folder option causes the statuses to be updated within the working folder itself. Everyone has access to those status changes and Unknown statuses do not occur.
Purge Opens the Status Repository Cleanup dialog box where you can remove file status data from the workstation status repository.
Default Resets the Central repository location to the default setting
URL Options

Display template

Specifies a special template used to generate an HTML representation of an item when the item’s URL is copied to the Clipboard. With no format, there is a default HTML representation that specifies the type of item and identifies it by name and number. When the text is generated from the template, the specified property values are substituted for the variables in ~~*~~. The variables may be referenced by the same names used in report templates, as well as by the display name of the property. When using the display name, you can omit spaces, and case will be ignored. For example, if you use the following sample template for a file: ~~FolderPath~~:~~Name~~, the HTML representation will be the path to the selected file: StarTeam\:buildinfo.properties. This template is a super-set of that used by the report feature of the client.

Another example about using project information: Server:~~Server~~|Project:~~Project~~|View:~~View~~|~~Path~~\~~Name~~

Generate ID-based URLs

Specifies the URL by ID rather than by name. For example, an ID-based URL would be starteam://hostname:49201/12;ns=Project;scheme=id, while a name-based URL would be starteam://hostname:49201/myproject.

Note: Folders always use an ID-based URL.

Alternate Applications

Opens the Alternate Applications dialog box where you can specify an alternate editor, merge utility, and comparison utility to use in the application if you don't want to use the default tools for those functions. Includes fields for specifying options to use with the applications.

Open With... Enables you to provide a command on a non-Microsoft Windows system that will display at least one type of files and folders. The command should consist of the path to an application and the command-line options for which the application for which the application can substitute the selected file. The application runs this command whenever you do one of the following: Double-click a file or folder in the item list, double-click an attachment, or generate and open a report. The following command is suggested: netscape -remote "openFile($file)" because Netscape can handle many different media types, such as image files, text files, and HTML.

Merge Utility Options

Use the following command-line options to represent files sent to the alternate merge utility.

$branchtip A place holder for the path to the tip revision of the file to be merged.
$usertip A place holder for the path to the local working file to be merged.
$basefile A place holder for the path to the common ancestor for the $branchtip and $usertip files.
$resultfile A place holder for the path to the file that will store the output from the merged file.
Compare Utility Options

Use the following command-line options to represent files sent to the alternate compare utility.

$file1

A place holder for the path to the first of the two files to be compared.

$file2

A place holder for the path to the second of the two files to be compared.