Associates an equivalence string and set of attributes with a key on the terminal keyboard. The /KEY qualifier is required.

Format

DEFINE/KEY key-name equivalence-string

Parameters

key-name

Specifies the name of the key that you are defining. Use the following key names when defining keys:

Key Name	LK201	VT100	VT52
PF1	PF1	PF1	[blue]
PF2	PF2	PF2	[red]
PF3	PF3	PF3	[gray]
PF4	PF4	PF4	- -
KP0, KP1 to KP9	0, 1 to 9	0, 1 to 9	0, 1 to 9
PERIOD	.	.	.
COMMA	,	,	n/a
MINUS	-	-	n/a
ENTER	Enter	ENTER	ENTER
Find (E1)	Find	- -	- -
Insert Here (E2)	Insert Here	- -	- -
Remove (E3)	Remove	- -	- -
Select (E4)	Select	- -	- -
Prev Screen (E5)	Prev Screen	- -	- -
Next Screen (E6)	Next Screen	- -	- -
HELP	Help	- -	- -
DO	Do	- -	- -
F17 to F20	F17 to F20	- -	- -

equivalence-string

Specifies the string to be processed when you press the key. The string can be a SHOW CLUSTER command. If the string contains any spaces, enclose the equivalence string in quotation marks.

Qualifiers

/ECHO (default)

/NOECHO

Determines whether the equivalence string is displayed on your screen after the key has been pressed. You cannot use /NOECHO with the /NOTERMINATE qualifier.

/ERASE

/NOERASE (default)

Determines whether the current line is erased before the key translation is inserted.

/IF_STATE=(state-name,...)

/NOIF_STATE

Specifies a list of one or more states, one of which must take effect for the key definition to be in effect. If you omit the /IF_STATE qualifier or use /NOIF_STATE, the current state is used.

/LOCK_STATE

/NOLOCK_STATE (default)

Specifies that the state set by the /SET_STATE qualifier remain in effect until explicitly changed. If you use the /NOLOCK_STATE qualifier, the state set by /SET_STATE is in effect only for the next definable key that you press or for the next read-terminating character that you type.

The /LOCK_STATE qualifier can be specified only with the /SET_STATE qualifier.

/LOG (default)

/NOLOG

Controls whether the system displays a message indicating that the key definition has been successfully created.

/SET_STATE=state-name

/NOSET_STATE (default)

Causes the specified state-name to be set when the key is pressed. The state name can be any alphanumeric string.

If you omit the SET_STATE qualifier or use /NOSET_STATE, the current state that was locked remains in effect. If you have not included this qualifier with a key definition, use the DCL command SET KEY to change the current state.

/TERMINATE

/NOTERMINATE (default)

Specifies whether the current equivalence string is to be terminated (that is, processed) when the key is pressed. Pressing Return has the same effect as using /TERMINATE.

The /NOTERMINATE qualifier allows you to create key definitions that insert text into command lines, after prompts, or into other text that you are typing.

Description

The DEFINE/KEY command enables you to assign definitions to the keys on certain terminals. The terminals include VT52s, the VT100 series, and terminals with LK201 keyboards, such as the VT200 series.

The equivalence string definition can contain different types of information. Definitions can consist of SHOW CLUSTER commands. When you define a key to insert a text string, use the /NOTERMINATE qualifier so that you can continue typing more data after the string has been inserted.

In most instances you will want to take advantage of the echo feature. The default setting is /ECHO. With the /ECHO qualifier set, the key definition is displayed on the screen each time you press the key.

You can use the /STATE qualifier to increase the number of key definitions available on your terminal. The same key can be assigned any number of definitions as long as each definition is associated with a different state. State names can contain any alphanumeric characters, dollar signs, and underscores. Generally, you want to create a state name that is easy to remember and type and, if possible, reminds you of the types of definitions you created for that state.

Example

Command> DEFINE/KEY PF3 "LOCAL_PORT"/NOTERMINATE
      

This command defines the PF3 key on the keypad to output the "LOCAL_PORT" text string. This key could be used with the ADD key to form the ADD LOCAL_PORT command.

Terminates the selection of a previously selected window. When the DESELECT command is entered after a MOVE command, SHOW CLUSTER completes the move operation when it deselects the window. See also the MOVE and SELECT commands for related information.

Format

DESELECT

Parameters

None.

Qualifiers

None.

Example

Command> DESELECT
      

When you sent the DESELECT command, the previously selected window is deselected and the window is no longer highlighted.

Terminates the SHOW CLUSTER display and returns control to the DCL command level. You can also press Ctrl/Z to exit at any time.

Format

EXIT

Parameters

None.

Qualifiers

None.

Example

COMMAND> EXIT
      

This command terminates the SHOW CLUSTER display and returns control to the DCL command level.

Provides online help information to use SHOW CLUSTER commands, parameters, and qualifiers. Press Ctrl/Z to exit.

Format

HELP [keyword ...]

Parameter

keyword

Specifies the command, parameter, or qualifier for which help information is to be displayed. If you omit the keyword, HELP displays a list of available help topics, and prompts you for a particular keyword.

Qualifiers

None.

Examples

COMMAND> HELP INITIALIZE
      

This command displays help information about the SHOW CLUSTER command INITIALIZE.

COMMAND> HELP FIELDS
      

This command displays help information about the valid field names that you can specify with the ADD, REMOVE, and SET commands.

Resets the display using the original default values for field names, class names, and field widths. It also restores any systems that were removed from the display by the REMOVE SYSTEMS command.

Format

INITIALIZE

Parameters

None.

Qualifiers

None.

Description

The INITIALIZE command resets the SHOW CLUSTER display to its default setting, consisting of the SCS window with data from the SYSTEMS class and the MEMBERS class. The report shows the node name, the software version, and the status of cluster members.

If you save a series of commands in an initialization file, using the SAVE command, SHOW CLUSTER automatically inserts an INITIALIZE command at the beginning of the file. Any command procedure that you build should start with the INITIALIZE command. In this way, you always tailor the display from a known state.

Example

COMMAND> INITIALIZE
      

This command resets the current display to the default display and restores any systems that were removed from the display.

Moves a selected window to a specified position.

Format

MOVE direction value

Parameters

direction

Specifies the direction in which the window is to be moved. If you do not enter a direction for this parameter, SHOW CLUSTER prompts you for one. You must specify one of the following keywords:

UP
DOWN
RIGHT
LEFT

value

Number of columns or lines the window is to be moved. You must specify a numeric value from 1 to 511. If you do not enter a number for this parameter, SHOW CLUSTER prompts you for one.

Qualifiers

None.

Description

The MOVE command allows you to reposition a window manually on the display screen. With one window in the SHOW CLUSTER display, you can enter MOVE commands directly. However, with multiple windows, you must select the appropriate window (SELECT window-name) before invoking MOVE commands. The MOVE command implicitly disables AUTO_POSITIONING.

To move a selected window, either enter MOVE commands at the command prompt or use the arrow keys defined as MOVE commands. Entering the command SET FUNCTION MOVE redefines the direction keys as MOVE UP 1, MOVE DOWN 1, MOVE RIGHT 1, and MOVE LEFT 1, respectively.

When you enter a MOVE command, the window changes position by column (horizontally), or by line (vertically). An empty frame appears around the new window position. When you are satisfied with the position of the window, enter the DESELECT command, which moves the window to the new position. Entering another SELECT command before the previous window has been deselected also moves the window to its new position.

Example

Command> SELECT CLUSTER
Command> MOVE RIGHT 10
Command> DESELECT
      

The command sequence in this example moves the CLUSTER window 10 columns to the right.

Exhibits a wide display area, a part at a time, as though being unrolled.

Format

PAN direction value

Parameters

direction

Specifies the direction in which the display is to be panned. If you do not enter a direction for this parameter, SHOW CLUSTER prompts you for one. You must specify one of the following keywords:

UP
DOWN
RIGHT
LEFT

value

Number of columns or lines the display is to be panned. You must specify a numeric value from 1 to 511. If you do not enter a number for this parameter, SHOW CLUSTER prompts you for one.

Qualifiers

None.

Description

The PAN commands rotate the entire display by column (horizontally) and by line (vertically). A portion of the display that extends beyond the limits of the screen can be brought into view.

The display moves in the opposite direction from that specified by the PAN command. In other words, a PAN LEFT 10 command moves the display 10 columns to the right, similar to the effect of panning a camera over a landscape.

To pan the display, either enter PAN commands at the command prompt, or use the arrow keys defined as PAN commands. Entering the command SET FUNCTION PAN redefines the up, down, right, and left arrow keys as PAN UP 1, PAN DOWN 1, PAN RIGHT 1, and PAN LEFT 1, respectively.

Note If you set the function to PAN, the arrow keys are no longer defined to perform DCL line-mode editing. Only one function can be enabled at a time, using the SET FUNCTION command.

Example

Command> PAN DOWN 10
      

This command pans the display 10 lines.

Clears the screen, removes extraneous characters, and updates all fields. Pressing Ctrl/W has the same effect as entering REFRESH.

Format

REFRESH

Parameters

None.

Qualifiers

None.

Example

Command> REFRESH
      

This command clears the screen, removes extraneous characters, and updates all fields.

Removes CIRCUITS class information from the SHOW CLUSTER display.

Format

REMOVE CIRCUITS [/qualifier[,...]]

Parameters

None.

Qualifiers

/TYPE=ALL

Specifies that all types of circuits on each system be removed from the display, including formative, open, and closing circuits. If you specify the REMOVE CIRCUITS command without any qualifiers, all types of circuits are removed from the display by default.

/TYPE=OPEN

/TYPE=NOOPEN

Controls whether open circuits or nonopen circuits are removed from the display.

Description

The REMOVE CIRCUITS command removes CIRCUITS class information from the SHOW CLUSTER display. CIRCUITS class information includes data for all currently enabled fields in the CIRCUITS class.

For a list of valid CIRCUITS class fields, see Table 22-2.

Examples

COMMAND> REMOVE CIRCUITS
      

This command removes all currently enabled CIRCUITS class fields from the display.

COMMAND> REMOVE CIRCUITS/TYPE=OPEN
      

This command removes all Open circuits from the display.

Removes CLUSTER class information from the SHOW CLUSTER display.

Format

REMOVE CLUSTER

Parameters

None.

Qualifiers

None.

Description

The REMOVE CLUSTER command removes CLUSTER class information from the SHOW CLUSTER display. CLUSTER class information includes data for all currently enabled fields in the CLUSTER class.

For a list of valid CLUSTER class fields, see Table 22-3.

Example

COMMAND> REMOVE CLUSTER
      

This command removes all currently enabled CLUSTER class fields from the SHOW CLUSTER display.

Removes CONNECTIONS class information from the SHOW CLUSTER display.

Format

REMOVE CONNECTIONS [/qualifier[,...]]

Parameters

None.

Qualifiers

/NAME=ALL

Removes all connections currently displayed by SHOW CLUSTER. This qualifier allows you to clear the display before adding specific connection information with the command ADD CONNECTIONS/NAME=local-process-name.

/NAME=local-process-name

Specifies the local process name of connections that are to be removed from the display. A local process name appears in the LOC_PROC_NAME field; it can be up to 16 characters in length. If the local process name is abbreviated, SHOW CLUSTER removes all local process names matching the abbreviation.

/TYPE=ALL

Specifies that all types of connections on each circuit be removed from the SHOW CLUSTER display.

/TYPE=OPEN

/TYPE=NOOPEN

Controls whether connections in the open or nonopen state are removed from the SHOW CLUSTER display.

Description

The REMOVE CONNECTIONS command removes CONNECTIONS class information from the SHOW CLUSTER display. CONNECTIONS class information includes data for all currently enabled fields in the CONNECTIONS class.

For a list of valid CONNECTIONS class fields, see Table 22-4.

Examples

COMMAND> REMOVE CONNECTIONS
      

This command removes all currently enabled CONNECTIONS class fields from the SHOW CLUSTER display.

COMMAND> REMOVE CONNECTIONS/NAME=(VMS$DISK_CL_DRVR,VMS$TAPE_CL_DRVR)
      

This command removes the CONNECTIONS class fields associated with the local process names VMS$DISK_CL_DRVR and VMS$TAPE_CL_DRVR from the SHOW CLUSTER display.

COMMAND> REMOVE CONNECTIONS/TYPE=OPEN
      

This command removes all Open connections from the SHOW CLUSTER display.

Removes COUNTERS class information from the SHOW CLUSTER display.

Format

REMOVE COUNTERS

Parameters

None.

Qualifiers

None.

Description

The REMOVE COUNTERS command removes COUNTERS class information from the SHOW CLUSTER display. COUNTERS class information includes data for all currently enabled fields in the COUNTERS class.

For a list of valid COUNTERS class fields, see Table 22-5.

Example

COMMAND> REMOVE COUNTERS
      

This command removes all currently enabled COUNTERS class fields from the SHOW CLUSTER display.