TOC PREV NEXT INDEX DOC LIST MASTER INDEX




Configuration Management Control Switches List

This file contains alphabetical list of the valid Configuration Management Control switches. An overview of switches can be found in the Programmer's Guide.

APEX_ABANDON
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Abandon any checked-out files prior to perform the command. This switch does not apply when copying an entire subsystem (Apex/Summit) or Rational subsystem (Apex/ClearCase).

APEX_ABANDON_UNREACHABLE
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Used during version control maintenance on the Summit/CM database to specify that reservations in the database should be abandoned if the checked-out object is not accessible on the file system. This swich is usually used when a file was checked out in a view, the view is not accessible for some reason, and the user wishes to make the database consistent.

APEX_ACCESS_CATEGORY
Area:
Configuration Management
Switch Kind:
Session
Type:
Access Category
Option:
Yes
Default Value:
group_public
Range:
user_only, private, user_group, user_public, group_only, group_public, public, unmanaged

Specifies the access category to use when creating views (Apex/Summit) or Rational subsystems (Apex/ClearCase). Access control is discussed in detail in the Programmer's Guide

APEX_ALL
Area:
Utilities, Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Use all options valid for the command.

APEX_ALLOW_ CHECKED_OUT
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Allow a file to be changed while it is checked out. When this occurs the contents of the version is copied onto the file and the file remains checked out.

APEX_ALLOW_PRIVATE
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Used to specify that copy, move and delete should be allowed even if a Summit/CM view contains privately checked-out files.

APEX_CHECK_IN
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Check in any checked out files prior to performing the command. This switch does not apply when copying an entire subsystem (Apex/Summit) or Rational subsystem (Apex/ClearCase).

APEX_CHECKED_IN
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Include information on checked-in objects.

APEX_CHECKED_ OUT
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Include information on checked-out objects.

APEX_COMPRESSED
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Show line differentials as opposed to complete image with marked differences.

APEX_CONSIDER_WHITESPACE
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Control whether whitespace is considered when displaying differences. If not set, extra spaces and tabs at the beginning and end of lines are not considered as differences.

APEX_CONTEXT_ LINES
Area:
Configuration Management
Switch Kind:
Session
Type:
Integer
Option:
Yes
Default Value:
0
Range:

When the APEX_COMPRESSED switch is True, this switch controls the number of Context lines that will be displayed around the difference regions.

APEX_CREATE
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

When the history already exists and the file contents do not match the latest version, create a new version based on the current contents of the file. This is a way of forcing the operation to succeed. The history must not be checked out for this to be successful.

APEX_CURRENT
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Current
Range:
Version Number

The version number to use for the current object. Can specify a simple or a full version number. If a full version number is supplied, the files are ignored.

APEX_DEFAULT
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Make the history the default history for the specified views.

APEX_DELETED
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Include information on deleted objects.

APEX_EXISTING
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Specifies that the source files that do not exist in the destination will not be created.

APEX_FILE
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
Filename

If set to a non-empty value, store the version image into the file.

APEX_FIRST
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
First
Range:
Version Number

The first version to use in the command.

APEX_FORCE
Area:
Configuration Management, Object Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True

Force the command to occur. Tries to maintain consistency of data structures but the operation will happen even if consistency is broken.

APEX_KEEP_ CURRENT
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

If the current version is not the latest, allow the check out to succeed without updating the file to the latest version.

APEX_KEYWORD_ERROR
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
error
Range:

Used in keyword replacement error handling. Specifies the value of the replacement string if the error which occurred is none of the following: keyword syntax error, undefined keyword error, or no_object error.

APEX_KEYWORD_NO_OBJECT
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
object_does_not_exist
Range:

Used in keyword replacement error handling. When a no_object error occurs because the named object does not exist, the replacement string is set to this value.

APEX_KEYWORD_UNDEFINED
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
undefined
Range:

Used in keyword replacement error handling. When an undefined error occurs because the an attribute or modifier is applied to a name for which it is not defined, the replacement string is set to this value.

APEX_LAST
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Last
Range:
Version Number

The last version to use for the command.

APEX_LATEST
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Update the contents of the object to correspond to the latest version. If the file does not have the latest version, the operation will fail if this switch or the APEX_KEEP_ CURRENT switch is False.

APEX_LOCKING
Area:
Configuration Management, Editors
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Installation dependent
Range:
No_Remote, Rsh, On, MAX_RETRY

This compound-valued switch specifies which kind of object locking is used and what command, if any, to use when inquiring about process existence on remote machines. The named value 'Kind' can have values of 'Rational' or 'NFS'; if not specified or unrecognized, Rational locking is used. The named value 'Remote' can have values of 'rsh', 'on', or 'No_Remote'; if not specified or unrecognized, on is assumed. MAX_RETRY limits the number of attempts that will be made to acquire a lock. MAX_RETRY must be set to a non-negative number.

Note: Set by installation. Do not change.

APEX_MATCH
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

When the history already exists, the current file contents must match the latest version of the history. If the contents do not match, the operation fails.

APEX_NEW_ HISTORY
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
default_history
Range:
History name

The new history to use when the APEX_SET_HISTORY switch is True. This switch does not apply when copying an entire subsystem.

APEX_NOTE
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
False
Range:
Any text string

The text to enter as a note associated with new version.

APEX_NOTE_FILE
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
Filename

The contents of the file are entered as a note associated with the version.

APEX_NOTES
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Show the notes as well as the other information.

APEX_OUT_OF_DATE
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Include information on controlled objects that do not have the latest version.

APEX_PERMANENT
Area:
Configuration Management, Object Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

If the latest version of the file is deleted, create a new version whose contents correspond to that of the last undeleted version.

APEX_PREVIOUS
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Previous
Range:
Version Number

The version number to use for the previous object. Can specify a simple or a full version number (see version numbers). If a full version number is supplied, the APEX_PREVIOUS_FILE switch is ignored.

APEX_PREVIOUS_FILE
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range

A file containing the previous object.

APEX_PRIVATE
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Used to specify that a private check out should occur.

APEX_REPLACE_SWITCHES
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Used to specify that switches should be replaced during the command. If not set, only the COMPILER_KEY switch is updated from the model.

APEX_REPLACEMENT
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Previous
Range:
Version Number

The object is reverted to this version. Note that the default causes objects to revert to their previous versions.

APEX_SET_HISTORY
Area:
Configuration Management, Object Management

See the description of APEX_SET_HISTORY in Object Management Switches topic.

APEX_SOURCE
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
Sets of views, directories, or files

The source of the accept_changes command. When a file or directory is named, the destination must name views. When a view is named the destination can name views, directories or files.

APEX_SWITCH_CONTEXT
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
" "
Range:
Pathname

Used by the set_switch command to determine the context to use in setting switches.

APEX_UNCONTROLLED
Area:
Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Include information on uncontrolled objects.

APEX_UPGRADE_PRIVATE
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Used to specify that a private check out should be upgraded to a check out with reservation.

APEX_VERBOSE
Area:
Configuration Management, Export/Import
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Display additional information.

APEX_VERSION
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Current
Range:
Version Number

The version of the object to use.

APEX_VERSION_ATTRIBUTE_KEY
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
" "
Range:
* *, directory name

The name of the attribute definition directory to use. This directory contains the set of extended attributes that are defined at a particular site to meet the specific requirements of those users.

BUILD_COMPONENT
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
String
Option:
Yes
Default Value:
cpp
Range:
cpp, java, java_cpp

Specifies the component to be built in the view. The standard makefiles support C/C++, Java or a combination as components.

BUILD_PHASES
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
String
Option:
Yes
Default Value:
"prepare -imports <view>, code -imports <view>"
Range:
phases

Specifies the set of build commands or "phases" which should be executed when the build command is run in the view. Usually this used to define the meaning of "build everything" in the view. The value may be any list of commands separated by commas. The default value will run the prepare command on the current view and all imports and then run the code command on the current view and all imports.

DEFAULT_EXPORT_SET
Area:
Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
all_units
Range:
Export set name

The export set that import and export commands will use if you do not explicitly specify an export set when invoking them.

DELIVER_OBJECTS
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
String
Option:
Yes
Default Value:
" "
Range:
relative-names

The view relative names of objects that are to be copied as part of the deliver command.

DELIVER_OBJECTS_[1-9]
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
String
Option:
Yes
Default Value:
" "
Range:
relative-names

The view relative names of objects that are to be copied as part of the deliver command.

DELIVER_TO_DIRECTORY
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
String
Option:
Yes
Default Value:
" "
Range:
pathname

The directory to which the corresponding objects are to be delivered.

DELIVER_TO_DIRECTORY_[1-9]
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
String
Option:
Yes
Default Value:
" "
Range:
pathname

The directory to which the corresponding objects are to be delivered.

INTERFACE_COPY_EXCLUSIONS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
*.2.ada *.C *.cc *.cpp *.cxx *.c
Range:

This switch controls which objects get copied when an interface view is copied.

INTERFACE_COPY_INCLUSIONS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
*
Range:
True

This switch controls which objects get copied when an interface view is copied.

INTERFACE_ONLY
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

The view is to contain only interface units. When the value is False, the view can contain interface and implementation unitsæor example: specifications and bodies. When True, the view can contain only interface units-----for example: specifications

INTERFACE_RELEASE_LEVELS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
0.0.0
Range:
See Switches for Generation of View Names (Apex/Summit).

The pattern of level numbers to be used in the automatically generated names of interface-only release views.

INTERFACE_RELEASE_NAME
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
<subsystem>/Releases/<view>.ifc. <levels>
Range:
See Switches for Generation of View Names (Apex/Summit).

The pattern to be used when automatically generating the names of interface-only release views.

INTERFACE_WORKING_LEVELS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
0.0.0
Range:
See Switches for Generation of View Names (Apex/Summit).

The pattern of level numbers to be used in the automatically generated names of interface-only working views.

INTERFACE_WORKING_NAME
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
<subsystem>/<user>.ifc
Range:
See Switches for Generation of View Names (Apex/Summit)

The pattern to be used when automatically generating the names of interface-only working views.

LOCAL_VISIBILITY_DISABLED
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Provides the means to disable all local visibility. If set to True, no symbolic links are created in Links/Local.

LOCAL_VISIBILITY_EXCLUSIONS
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
Tokens
Option:
Yes
Default Value:
" "
Range:
names

Contains a list of names, possibly containing wildcards, for which additional links will not be created in Links/Local even if the object is named by an expression in corresponding inclusion switch.

LOCAL_VISIBILITY_INCLUSIONS
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
Tokens
Option:
Yes
Default Value:
" "
Range:
names

Contains a list of names, possibly containing wildcards, for which additional links will be created in Links/Local unless the object is also named in the corresponding exclusion switch.

LOCAL_VISIBILITY_OVERRIDE_DEFAULT
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

If false then links to objects named by LOCAL_VISIBILITY_INCLUSIONS and LOCAL_VISIBILITY_EXCLUSIONSSS will be added to the default links in Links/Local. If true then the new links will be added instead of the default links.

RELEASE_COPY_EXCLUSIONS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
*~ #*# .nfs*
Range:
True, False

This switch controls which objects get copied when a release view is copied.

RELEASE_COPY_INCLUSIONS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
* .*
Range:
True, False

This switch controls which objects get copied when a release view is copied.

RELEASE_LEVELS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
0.0.0
Range:
See Switches for Generation of View Names (Apex/Summit)

The pattern of level numbers to be used in the automatically generated names of release views.

RELEASE_NAME
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
<subsystem>/Releases/<view>.<levels>
Range:
See Switches for Generation of View Names (Apex/Summit)

The pattern of level numbers to be used in the automatically generated names of release views.

SORT_DYNAMIC_STD_MACROS
Area:
Summit/CM Configuration Management - C/C++ only
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

Determines whether the dynamic standard macros, as defined in the Properties.sw file, will be sorted (sort is based on whitespace separated items) before being set in the makefiles. Setting this switch to true will have a performance impact during any operation that updates the makefiles. Maintaining sorted lists will ensure consistent build orders.

VC_ACCEPT_CHANGES_SOURCE
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
""
Range:
objects, history, latest

Specifies the kind of source to be used.

VC_ACCEPT_CHANGES_SOURCE_OBJECTS
Area:
Configuration Management
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
""
Range:
pathname

Specifies that the destination objects will be updated to versions associated with these source files or views.

VC_ACCEPTABLE_HISTORIES
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
default_history
Range:
histories

Specifies a set of histories for which controlled files can be accepted into the current view. The special value default_history allows this switch to refer to the value of the VC_DEFAULT_HISTORY switch.

VC_ACCEPTABLE_HISTORY_CHANGES
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
""
Range:
histories

Specifies how the history of exising controlled objects is allowed to change.

VC_DEFAULT_HISTORY
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
Common
Range:
Version history family name

The default version-history family for a view. The default version-history family is used whenever you place a new file under version control without explicitly specifying a version history.

VC_DIRECTORY_EXCLUSIONS
Area:
Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
Exports Imports Policy
Range:
Simple directory names

The simple names of directories that are not to contain any files under version control. This switch used to be called VC_DIR_EXCLUSION.

VC_DIRECTORY_INCLUSIONS
Area:
Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
*
Range:
Simple directory names

The simple names of directories that can contain files under version control. This switch used to be called VC_DIR_INCLUSION.

VC_EXECUTABLE_EXCLUSIONS
Area:
Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:

Range:
Simple file names

The simple names of executable files that are not to be placed under version control. An "executable file" is any file-----binary or not, shell script or not-----with its execute permissions turned on by the chmod command.

VC_EXECUTABLE_INCLUSIONS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
*.sh *.csh
Range:
Simple file names

The simple names of executable files that can be placed under version control.

VC_FILE_EXCLUSIONS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
Makefile *~
Range:
Simple file names

The simple names of nonexecutable files that are not to be placed under version control.

VC_FILE_INCLUSIONS
Area:
Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
*
Range:
Simple file names

The simple names of nonexecutable files that can be placed under version control.

VC_VIEW_ATTRIBUTES
Area:
Summit/CM Configuration Management
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
""
Range:
tokens

Used for customization to allow users to specify an attribute of a Summit/CM view or Rational Subsystem that can be tested by other switches.

VERSION_CONTROL_KEY
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
List of Pathnames
Option:
No
Default Value:

Range:
List of Pathnames

The programs or scripts to use in extending the basic version control operations. This switch controls the version control operations in the associated subsystem and is used for customization of Summit/CM operations. It is only valid at the subsystem level.

WORKING_COPY_EXCLUSIONS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
*~ #*# .nfs*
Range:
True, False

This switch controls which objects get copied when a working view is copied.

WORKING_COPY_INCLUSIONS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
Boolean
Option:
Yes
Default Value:
* .*
Range:
True, False

This switch controls which objects get copied when a working view is copied.

WORKING_LEVELS
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
0.0.0
Range:
See Switches for Generation of View Names (Apex/Summit)

The pattern of level numbers to be used in the automatically generated names of working views.

IWORKING_NAME
Area:
Summit/CM Configuration Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
<subsystem>/<user>.wrk
Range:
See Switches for Generation of View Names (Apex/Summit)

The pattern to be used when automatically generating the names of working views.


Rational Software Corporation 
http://www.rational.com
support@rational.com
techpubs@rational.com
Copyright © 1993-2001, Rational Software Corporation. All rights reserved.
TOC PREV NEXT INDEX DOC LIST MASTER INDEX TECHNOTES APEX TIPS