TOC PREV NEXT INDEX DOC LIST MASTER INDEX




Utility Switches List

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

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

Include switch aliases.

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_ARCH
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Installation dependent
Range:
sun4, sun4_solaris2, rs6k, mips_irix5, hppa_hpux, alpha_osf1

Compute architecture on which Apex is running.

Note: Set at installation. Do not change.

APEX_AUTHOR_ALIAS
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:

When not empty, the value of this switch overrides the use of $USER as the replacement of the Author attribute during keyword replacement. The value of this switch will be whitespace stripped.

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

Only check for problems, do not make any repairs.

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

Perform any maintenance on any state involving compilation. This includes the state associated with importing and exporting.

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

Include Context switches.

APEX_DIALOG_PATH
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Installation dependent
Range:
Pathname

Location of the dialog boxes.

Note: Set by installation. Do not change.

APEX_DLGLIST_LIMIT
Area:
Utilities
Switch Kind:
Session
Type:
Natural
Option:
No
Default Value:
10
Range:

Adjusts the default setting for the delete dialog box. Specifies the maximum number of symbolic links displayed by the verification query. To have an effect, this switch must be set prior to starting apex.

APEX_DOC_PATH
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Installation dependent
Range:
Pathname

Location of the online documentation.

APEX_EXECUTION_ XTERM
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
UNIX xterm commands

Xterm command to use to create the xterm used when executing a program

APEX_GUI_DEL_DEFAULT_VIEW
Area:
Utilities
Switch Kind:
Session
Type:
Boolean
Option:
No
Default Value:
False
Range:
True, False

Adjusts the default setting for the delete dialog box. When false, the default setting is "Create Deleted Version". When true, the default setting is "Delete from view only". To have an effect, this switch must be set prior to starting apex.

APEX_HELP_BROWSER
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
netscape
Range:
Pathname

Startup command for the Rational Apex online help browser. Netscape is provided with Apex. To use a different browser, change this value.

APEX_HELP_BROWSER_OPEN
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
none
Range:
browser command

Unix command to cause the browser to open the online help documents. Two keyword replacements are supported:
        <browsername>  first token in APEX_HELP_BROWSER
        <helpfilename>  the name of the file to be opened

If a value is not specified and the simple name of the APEX_HELP_BROWSER command is "netscape" (note that if you specified a full pathname, like /usr/apps/bin/netscape, the default will still apply), this switch will use the following to open the help file:
        <browsername> openURL(<helpfilename>)

APEX_HISTORY
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
All
Range:
Subsystem names, All

Version histories to check.

APEX_HOME
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
No
Default Value:
Installation dependent
Range:
Pathname

Home directory for Rational Apex release.

Note: Set by installation. Do not change.

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

Check for abandoned locks and aborted updates. When repair is requested, abandoned locks are recovered and aborted updates are reverted or completed.

APEX_MENUS_PATH
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Installation dependent
Range:
Pathname

Directory containing the files that define the GUI menus.

Note: Set by installation. Do not change.

APEX_MESSAGE_ SERVER
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Installation dependent
Range:

Path to the message server.

Note: Set by installation. Do not change.

APEX_MESSAGES
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Installation dependent
Range:

Identifies the path on which to search for message catalogs and switch registration files.

Note: Set by installation. Do not change.

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

Check the UNIX permissions.

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

Replace an existing name with a new name. Otherwise, objects that have an existing permanent name are not affected.

APEX_RETAIN_SHELLS
Area:
Utilities
Switch Kind:
Session
Type:
Boolean
Option:
No
Default Value:
False
Range:
True, False

Keep shell windows (those created by the Tools > Shell command) when Apex is exited.

APEX_RULES_PATH
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:
Installation dependent
Range:
Pathname

Directory containing the rules files..

Note: Set by installation. Do not change.

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

Include Session switches.

APEX_SHELL_XTERM
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
UNIX xterm commands

Command used to create an xterm when a Tools > Shell command is requested.

You can use this switch to change the default shell window type (xterm) launched by the Tools > Shell command:

For example,

However, use of "unmanaged" results in the xterms not appearing in the window directory, not being able to pass command-line options to the command, and the created xterms are not closed automatically when Apex exits.

An alternate method of changing the default shell window type which does not have the restrictions associated with "unmanaged" can be found in the description of the Tools > Shell command.

APEX_SOURCE_ PATH
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
No
Default Value:

Range:
Pathname

The directory containing the source objects.

APEX_SUMMIT_ENABLED
Area:
Utilities
Switch Kind:
Session
Type:
Boolean
Option:
Yes
Default Value:
False unless -summit option to apexinit is used
Range:
True, False

When set, Rational compiler-specific menu items are not enabled. Is set when invoking apexinit -summit

Note: Rational Summit/TM is separately licensed from Apex.

APEX_UNMANAGED_SHELLS
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:

Shell windows not to be managed by Apex. These windows will not appear in the Windows window and will not be closed when Apex exits.

APEX_XTERM
Area:
Utilities
Switch Kind:
Session
Type:
String
Option:
Yes
Default Value:

Range:
UNIX terminal commands

Xterm command to use when creating xterms from Apex.

You can use this switch to change the default shell window type (xterm) launched by the Tools > Shell command:

For example,

However, use of "unmanaged" results in the xterms not appearing in the window directory, not being able to pass command-line options to the command, and the created xterms are not closed automatically when Apex exits.

An alternate method of changing the default shell window type which does not have the restrictions associated with "unmanaged" can be found in the description of the Tools > Shell command.


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