Chapter Contents

Previous

Next
Command Directory

keys

Assign or List PF Key Commands

ABBREVIATION
k{eys}

FORMATS
Format 1: keys [list N]
Format 2: keys define N "STRING"
Format 3: keys default N
Format 4: keys help N
Format 5: keys ispf N on|off

DESCRIPTION
PF keys can be used to issue debugger commands in full-screen mode. The keys command is used to list or modify PF key assignments. You can issue the keys command from the command line, the command window, or a configuration file; however, it is not valid in a PROFILE.

Format 1: This format lists the PF key assignments. Issuing the command without any arguments will display all PF key assignments. If issued with the optional list keyword, the keys command will display the command assigned to the PF key specified by the N argument. Using an asterisk (*) as the N argument also displays all PF key assignments.

Format 2: In the configuration file, this format changes the definition of the PF key indicated by the N argument to the command specified by the STRING argument. This becomes the session's initial assignment for that PF key, which is copied to a table used by the debugger.

When used outside the configuration file, during a debug session, this format does not change the initial PF key; therefore, you can use format 3 to restore your default PF key assignments.

Format 3: This format sets the PF key indicated by the N argument to its default command assignment. Using an asterisk (*) for the N argument gives all PF keys their initial assignments for the session. When used in a configuration file, this command must be before any keys define commands (format 2).

Format 4: This format sets the PF key indicated by the N argument to the help < > command. N can be any number from 0 to 24. The key assigned to the help < > command is referred to as the help key. If you do not want to have a help key, a 0 is used as the N argument.

If format 4 of the keys command is used to reassign the help key during a session, the default command assignment is restored to the old help key. By default, PF1 is assigned the help < > command.

If present in the configuration file, the keys help command must be before the keys define command.

Format 5: This format is used to specify PF keys that are to be handled by ISPF. The N argument is used to select the PF key. Use an asterisk (*) for the N argument to indicate all PF keys. The keyword on is used to assign a PF key to ISPF and the keyword off causes the debugger to handle the key. This setting is shown in the Keys window. By default all keys are handled by the debugger. The help key cannot be assigned to ISPF.

EXAMPLES

keys
displays all PF key assignments.

keys list 2
displays the assignment for the PF2 key.

keys list *
displays all PF key assignments.

keys define 7 "break entry"
assigns the break entry command to the PF7 key.

keys default 7
restores the PF7 key to the initial assignment for the session.

keys default *
restores all PF keys to their initial assignments for the session.

ADDITIONAL DISCUSSION AND EXAMPLES
See Using PF Keys and Setting Up a Configuration File.

SYSTEM DEPENDENCIES
none

COMMAND CAN BE ISSUED FROM

PROFILE no
configuration file yes (Keys define command only)
Source window prefix none

SCOPE
The keys command is not affected by changes in scope.

RETURN CODES SET
Successful: 0
Unsuccessful: 1

SEE ALSO
config


Chapter Contents

Previous

Next

Top of Page

Copyright © 2001 by SAS Institute Inc., Cary, NC, USA. All rights reserved.