TOC PREV NEXT INDEX DOC LIST MASTER INDEX




Object Management Switches List

This file contains alphabetical list of the valid Object Management switches. An overview of switches can be found in the Programming with Apex.

APEX_ALLOW_PRIVATE
Area:
Object 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 view contains privately checked-out files.

APEX_CHECK_IN
Area:
Configuration Management, Object 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_COMP_MODE
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
no_summary

This switch has only one significant value, which is "no_summary". It must be entered in all lowercase. This value will prevent the compilation summary window from being raised after a C++ compile. Any output from the compilation job will still appear in the log window.

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

If any of the objects are uncontrolled, they are made controlled and then checked out. This switch also governs the initial setting for the control toggle of many dialog boxes.

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

Enable the C++ mechanisms in Apex.

APEX_CPP_MODEL
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
" "
Range:
View pathname

Model view used to create new C/C++ working views. The model serves as a prototype for the new views. Subdirectories, switches, and imports of the new views will be copied from the model view.

Note: Set at installation. Do not change.

APEX_CREATE_ CONFIGURATION
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
Configuration name

TBS

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

Create the history family named by the APEX_NEW_ HISTORY switch if it does not exist. This switch does not apply when copying an entire subsystem.

APEX_DEFAULT_ MODEL
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
Installation dependent
Range:
View name

Model view used to create new working views. The model serves as a prototype for the new views. Subdirectories, switches, and imports of the new views will be copied from the model view.

Note: Set at installation. Do not change.

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

Visit the newly created objects in an editor with edit mode set.

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

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

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

This switch only applies only to the RS6000 architecture. If False, core dumps will be smaller and not contain the data section.

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

Treat all of the arguments as views to be copied and create all new views with names generated from the state of each view. When this switch is True, the APEX_VIEW_KIND switch is used to determine the class of the target views.

APEX_GOAL
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Preserve
Range:
Archived, Source, Installed, Coded, Linked, Preserve

The new views will only contain files appropriate to the goal state. Units in the new views will be compiled to the requested state, as required except in the case of preserve, which preserves the original state but does not perform any recompilation. A value other than preserve is equivalent to cleaning the view to that goal and then compiling the view to that goal.

APEX_IMPORT
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
Set of views or configurations

The imports to use for newly created views. These import views are added to those specified by the model. For copies of views, existing imports of a subsystem will be updated to reflect the newly specified view; no new subsystems will be imported.

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

Create an interface view when copying views.

APEX_LEVEL
Area:
Object Management
Switch Kind:
Session
Type:
Integer
Option:
Yes
Default Value:
1
Range:
1 - 8

Used in automatic name generation to specify the "release level." See Switches for Generation of View Names (Apex/Summit).

APEX_LOG_XTERM
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:

The name to be used for log xterm windows.

APEX_MAX_OPEN_CATALOGS
Area:
Object Management
Switch Kind:
Session
Type:
Integer
Option:
Yes
Default Value:
3
Range:

Specifies the number of message catalogs to keep open at any one time.

APEX_MAX_SWITCH_GROUPS
Area:
Object Management
Switch Kind:
Session
Type:
Integer
Option:
Yes
Default Value:
32
Range:

Specifies the maximum number of cached switch groups. Each switch group corresponds to a single switch file. Due to switch file inclusion and values that reference other switch files, more than one switch group may need to be active at any one time. Increasing this value causes more groups to be retained which can improve performance in cases where many switch files are being referenced during the course of a single command, at the expense of higher memory consumption.

APEX_MODEL
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
View pathname

The model to be used. In order to be used as a model, this view must not have obsolete compiler key information.

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

Form a mutual importing set from the specified set of views.

APEX_NAMING_STYLE
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Apex
Range:
Apex, Apex_Extended, csh, tsch, sh,ksh

Specifies the special characters recognized by naming. When set to something other than Apex or Apex_Extended, only the characters recognized by the named shell are accepted (with some limitations). The full set defined for Apex is specified in a message catalog; the default values include the csh set, plus character list negation from sh (using '!'), plus Apex-specific entities such as indirect files and attributes. Apex_Extended is the same as Apex, with the addition of '%' as an alternate for attributes; this is convenient for command line usage.

APEX_NEW_ HISTORY
Area:
Configuration Management, Object 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_NO_ARTIFACTS
Area:
Configuration Management, Object Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False
Range:
True, False

When objects are being updated, indicates that associated compilation artifacts, when available, should not be updated. This switch also governs the initial setting for the copy atrifacts toggle of many dialog boxes.

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

Can be used to inhibit keyword replacement in the check_in and control commands. When this switch is set, substitution symbols are left in their original form. This switch should be set when controlling binaries or data files.

APEX_PART
Area:
Object Management - Ada only
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Spec
Range:
spec, body, generic_spec, both, generic_both

The type of part to be created. This switch (together with the APEX_UNIT switch) also determines the template that will be used to fill in the initial contents. For more information, see the create_ada command. This switch is only applicable to Ada views.

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_PROTOTYPE_DIR
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
Installation dependent
Range:
Pathname

Directory containing templates to use when creating new objects. Default is set by installation. This can be a search list of directories, separated by colons (:).

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

Apply the command recursively to subobjects. If False, the operation will fail if the objects contain user-created files or directories.

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

Refresh the model-oriented information in the view. In particular, the switches, the imports, and the exports will be re-analyzed.

APEX_RELEASE_KIND
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Preserve
Range:
Development, Stable, Frozen, Preserve

Used to change the knd of a release. Changing the kind to frozen will implicitly cause a refresh of all other information as if a refresh had been specified.

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

If checked out files are abandoned, save the contents of modified files in a special .saved file.

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

The newly created objects are to be selected in the viewer.

APEX_SET
Area:
Object Management
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
default_export_set
Range:
Export set name

The export set to use for the imported views. The value, default_export_set specifies that the designated default export set of each imported view will be used.

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

Control newly created destination files with the history specified by the APEX_NEW_ HISTORY switch. This switch only applies when the source file was itself controlled.

APEX_SS_CONTEXT_EXCLUSIONS
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
tmp?*
Range:
Directory names

Used to exclude certain names from use in the creation of subsystems.

APEX_STORAGE
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
Pathname

The parent directory for the physical storage to use when creating new subsystems. When blank, the physical storage is in the location specified by the name.

APEX_STORAGE_EXCLUSIONS
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
/tmp?*
Range:
Directory names

Used to specify names of locations that should not be used for remote storage of views or subsystem.

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

The destination is to be used as a new parent location for the storage. The logical name of the object does not change. Can only be applied to subsystems and views.

APEX_SUBSYSTEM
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
Subsystem or set of subsystems name

The subsystem in which to create new objects. If blank, the current subsystem is used.

APEX_TEMP_DIR
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:

Specifies the temporary directory for use by Apex processes.

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

Remove any exports for deleted units.

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

Leave newly created destination files uncontrolled after a copy. This switch does not apply when copying an entire subsystem.

APEX_UNIT
Area:
Object Management - Ada only
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Package
Range:
Package, Procedure, Function, Task, Empty

The kind of the unit to be created. This switch (together with the APEX_PART switch) determines the template that will used to fill in the initial contents of the unit. The templates that are used are determined by APEX_PROTOTYPE_DIR session switch.

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

Remove any imports that are deleted or otherwise unreachable. This can be dangerous if the subsystem is temporarily inaccessible. For example, a view may appear to be unreachable when it is not accessible due to network failure.

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

Add the new import only if the importer currently imports some other view from the subsystem of the new import.

For models, the views are to be made up-to-date with respect to the last previous model.

APEX_USE_OVERWRITE_UPDATE
Area:
Object Management
Switch Kind:
Session
Type:
Boolean
Option:
No
Default Value:
False
Range:
True, False

When false, apex will use a link update method to save/close files. When true, apex will use an overwrite update method to save/close files. The overwrite method is less efficient, but preserves the i-node of the original file.

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

Place the newly created units under version control if possible. If the APEX_EDIT switch is set, the units are also checked out. For maintenance, the consistency of the version control information is checked. For more information, see the maintain command.

APEX_VIEW
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
" ", view or set of views

The view in which to create new objects, If blank, the current view is used. Can name a set of views.

APEX_VIEW_KIND
Area:
Object Management
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Preserve
Range:
Working, Release, Development, Stable, Frozen, Preserve

The kind of view to make the newly created views. The kind must be compatible with the extension of the target name if a target name is supplied. Specifying release is the same as specifying development. The value preserve is used to ensure that the new view will have the same Kind: as the source view.

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

Visit the newly created objects in the appropriate viewer/editor.

EXTENSIONS
Area:
Object Management
Switch Kind:
Context
Type:
String
Option:
No
Default Value:
" "
Range:
see the C/C++ Compiler Reference

Use when an Apex object subclass has multiple extensions.

INCLUDE
Area:
Object Management
Switch Kind:
Context
Type:
Search_Path
Option:
No
Default Value:

Range:

Specifies another switch file whose values are to be included as if they appeared in place of the INCLUDE switch itself. An error occurs if the named file does not exist.

INCLUDE_IMPLICIT
Area:
Object Management
Switch Kind:
Context
Type:
Boolean
Option:
No
Default Value:
True
Range:
True, False

When True, the Policy/Switches file associated with the parent directory is implicitly included at the head of the current switch file. Since the default value is True, the inclusion happens if the switch does not appear in the file. When False, the implicit inclusion is not done. The switch can appear at any point in the file. Replacement of keywords and naming attributes is not done for this switch.

INCLUDE_OPTIONAL
Area:
Object Management
Switch Kind:
Context
Type:
Search_Path
Option:
No
Default Value:

Range:

Like the INCLUDE switch, except that no error is produced if the named file does not exist.

VIEW_STORAGE_EXCLUSIONS
Area:
Object Management
Switch Kind:
Context
Type:
Tokens
Option:
Yes
Default Value:
/tmp?*
Range:

A blank-separated list of contexts in which storage for views created in the enclosing subsystem cannot be located. These context names apply to the storage name of the view, not its permanent name. The restriction imposed by this switch is in addition to those imposed by similar session switches. A possible use is to name the subsystem itself and thereby force every view in a subsystem to be relocated.

VIEW_STORAGE_INCLUSIONS
Area:
Object Management
Switch Kind:
Context
Type:
Tokens
Option:
Yes
Default Value:
" "
Range:

A blank-separated list of contexts in which storage for views created in the enclosing subsystem must be located. These context names apply to the storage name of the view, not its permanent name. If the switch value is empty, all contexts are included. The restriction imposed by this switch is in addition to any imposed by other storage exclusion switches. A possible use is to force the use of a standard, network-wide prefix instead of a pathname local to a particular machine.


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