Chapter Contents

Previous

Next
Command Directory

help

Access Debugger Online Help

ABBREVIATION
h{elp}

FORMAT
help [DEBUGGER-CMD-NAME | WINDOW-NAME | TOPIC]

DESCRIPTION
The help command invokes the help system. The optional arguments, DEBUGGER-CMD-NAME, WINDOW-NAME, and TOPIC, are used to access information debugger commands, windows, and topics such as how to set up a configuration file. Context-sensitive help is provided by the help < > command, which is assigned to the PF1 key by default. The key currently assigned to this command is displayed on the left side of the Status window.

Enter the help command with no arguments to access an index of the help system. The index is used to select help on topics such as prefix-area commands and debugger windows.

The DEBUGGER-CMD-NAME argument is used to specify the command you want help with. DEBUGGER-CMD-NAME can be any debugger command or its abbreviation.

The WINDOW-NAME argument can be used to access help for a specific window. The WINDOW-NAME argument must be one of the following:

Browse Command Config
Dump Find Help
Keys Log Message
Popup Print Register
Source Status Termin
Termout Watch

The TOPIC argument is used to access a specific topic in the help system. Here are some of the topics that are covered:

Any of these topics can be entered as a TOPIC argument to the help command. For example, entering the following command will access help on closing windows:
help closing windows

The debugger converts all TOPIC arguments to uppercase before searching the help system for the topic. The search routine used by the help system to find information about your topic is not case sensitive; therefore, the TOPIC argument can be any combination of uppercase and lowercase characters.

The help command cannot be followed by another debugger command on the same line. That is, the arguments to the help command are assumed to extend to the end of the line, including any semicolons on the line.

EXAMPLES

help
opens the Help window and displays the INDEX.

help break
opens the Help window and displays the card for the break command.

help config window
opens the Help window and displays the card for the Configuration window.

help prefix-area commands
uses the TOPIC argument to display information about prefix-area commands.

SYSTEM DEPENDENCIES
none

COMMAND CAN BE ISSUED FROM

PROFILE yes
configuration file no
Source window prefix none

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

RETURN CODES SET
Successful: 0
Unsuccessful: 1


Chapter Contents

Previous

Next

Top of Page

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