The Windowing Interface

Using the Help Window

The Help window is used to access the debugger's hypertext help system. You can use the following formats of the help command to open the Help window:

help: displays the help system index when you enter it in the Command window.
help <>: provides context-sensitive help based on the cursor position. This command is normally assigned to the PF1 key; however, you can also enter it from the Command window. (The help key assignment is shown in the Status window.)
helpWINDOW-NAME|COMMAND-NAME|TOPIC: allows direct access to information about a particular window, command, or topic. For example, help print opens the Help window and displays help information about the print command.

Note: The pair of angle brackets <> is used as a placeholder to specify the name of the window in which the cursor is currently located. When you press the PF key, the name of your current window is substituted for <> and the command is executed. For example, pressing the PF1 key when the cursor is in the Log window issues the following command:

window help <>

Since the cursor is in the Log window, log is substituted for the <> placeholder symbol when the command is executed. See Using Placeholders in Window Subcommands for additional information about the <> placeholder. [cautionend]

Help Key

The left side of the Status window identifies the PF key assigned to the help <> command. Normally, the PF1 key is assigned to this command. If no key is assigned, the Status window displays HELP:HELP, which indicates that you must issue the help command from the Command window in order to access the help system.

Pressing the help key opens the Help window, which then displays context-sensitive help information based on the current location of the cursor. For example, Help Window, Command Window Card shows the Help window that is displayed by pressing the PF1 key while the cursor is located in the Command window.

Help Window, Command Window Card

[IMAGE]

Hypertext Cards and Links

The Help window displays information in hypertext format on hypertext cards. For example, Help Window, Command Window Card shows the card for the Command window. These cards are displayed one at a time. You move between cards by a networks of links. A link has special display attributes that distinguish it from the surrounding text in a card. When you are running the debugger, links are displayed in either green or bold, depending on the characteristics of your terminal. You select a link by moving the cursor onto the link and pressing the ENTER key.

Navigation Links

Five navigation links always appear in the upper-left corner of the Help window. The navigation links are labeled NEXT, PREV, BTRK, INDEX, and HELP. As described in Help Window, these links are used to move rapidly through the help system following a predefined path or to move back through the cards you have selected.

Links within the Text of a Card

Most cards also display links that are embedded in the text of the card. For example, the Command window card shown in Help Window, Command Window Card contains a link called debugger commands on the first line of the description. Selecting this link causes the COMMAND DIRECTORY card, shown in Help Window, COMMAND DIRECTORY Card, to be displayed. The COMMAND DIRECTORY card contains additional links to cards that describe each of the debugger commands. By selecting the help link, you can access the card shown in Help Window, Help Command Card.

Help Window, COMMAND DIRECTORY Card

[IMAGE]

Help Window, Help Command Card

[IMAGE]

Links to Pop-Up Windows

Some links are associated to pop-up windows. Selecting such a link causes a pop-up window to be displayed inside the Help window. For example, selecting the link named examples on the help card shown in Help Window, Help Command Card causes the pop-up window shown in Help Window, Pop-Up Window to be displayed. After you read a pop-up window, press the ENTER key to close the pop-up window and return to the card from which it was selected.

Help Window, Pop-Up Window

[IMAGE]

Chapter Contents
Previous
Next
Top of Page