Debugging Commands

This chapter describes the commands valid for use during a debugging session. There are four types of commands:

Display
Line
Control
Report

Use display commands to locate selected data in the program and position it on the screen. These are commands such as FIND and SCROLL; they can be used in any panel containing a command input field.

Control and line commands direct the test session and you enter them only in the Intercept panel. Line commands are shorter versions of some control commands.

Report commands generate reports to be printed and analyzed offline. Only enter report commands in the Intercept panel.

This section contains the following topics:

Display Commands

Display commands locate and position data on the screen. Enter them on the command line of any panel containing a command input field.

The following display commands are available to use with the application:

COLUMN
FIND
FP (Find Paragraph)
FS (Find Statement)
KDOWN (Scroll Keep Window Down)
KSIZE (Keep Window Size)
KUP (Scroll Keep Window Up)
LOCATE
.label

COLUMN Command

The COLUMN command places a line that shows the column numbers on the first line of the display area of the Intercept or Display panel.

Syntax

Use the following syntax for COLUMN:

COLUMN <ON|OFF>

Variables

Use the following variables with the COLUMN command:

ON	Enables the column numbers display.
OFF	Disables the column numbers display.

If no argument is specified, ON is assumed.

COLUMN OFF is functionally equivalent to the RESET command, which removes the column numbers from the panel display.

FIND Command

The FIND command searches the file until the string operand is matched.

Syntax

Use the following syntax for FIND:

FIND string <col1 <col2>> <NEXT|FIRST|LAST|PREV>

You can enter FIND in its abbreviated form: F.

Variables

Use the following variables with the FIND command:

string	The search argument on the data area. String can be alphabetic, numeric, and special characters. If string contains embedded blanks or quotes, it must be enclosed in single or double quotation marks.
col1	Specifies the column in which to begin the search for string. If col1 is specified and col2 is omitted, the string must start in the specified column.
col2	Specifies the last column of a range of columns to search for string. If col2 is greater than the record length, the record length is used.
NEXT	Causes a search for the next occurrence of string starting at the beginning of the first line displayed after the cursor location. The default is NEXT.
FIRST	Causes a scroll to the top of the data followed by a FIND NEXT operation.
LAST	Starts the scan at the bottom of the data and moves backward to find the last occurrence of string.
PREV	Starts the scan at the current cursor location and moves backward to find the previous occurrence of string.

Usage Notes

To find the next occurrence of TEST in a program, enter:

F "'TEST'"

FP Command (Find Paragraph)

The Find Paragraph command scrolls the display to the definition of the specified paragraph, procedure, or label name.

Syntax

Use the following syntax for FP:

FP paragraph-name|procedure-name|label-name

You must enter this command in its abbreviated form: FP.

Variables

Use the following variable with the FP command:

paragraph-name	Designates a paragraph name defined in the Procedure Division of the currently qualified COBOL program.
procedure-name	Designates a procedure name defined in the currently qualified PL/I program.
label-name	Designates a label name defined in the currently qualified assembler or PL/I program.

FS Command (Find Statement)

The Find Statement command scrolls a display to a specified statement number.

Syntax

Use the following syntax for FS:

FS statement-number

You must enter this command in its abbreviated form: FS.

Variables

Use the following variables with the .label command:

statement-number

Specifies a statement number in the currently qualified program.

Cursor Sensitive Find

If a data name is displayed and you wish to locate its definition, place the cursor over the data name and press Enter. The application repositions the display at the definition of the data name.

If a paragraph, procedure, or label name is displayed and you wish to locate the line on which it starts, place the cursor over the name and press Enter. the application repositions the display at the paragraph, procedure, or label.

KDOWN Command (Scroll Keep Window Down)

Use the KDOWN command to scroll the keep window in the downward direction. The keep window appears on the Intercept panel immediately above the first line of the program listing.

Syntax

Use the following syntax for KDOWN:

KDOWN scroll-amt

Variables

Use the following variables with the KDOWN command:

scroll-amt	Identifies the number of lines to scroll, specified as one of the following:
PAGE	Scroll up one full page.
HALF	Scroll up one half page.
MAX	Scroll up to the top of the window.
nnn	Scroll the number of lines specified.

Usage Notes

The keep window is not scrollable if the number of entries in the window is less than the maximum depth defined by the KSIZE command. If the window is not scrollable, the KDOWN command is not functional.

If no argument is specified, the default scroll amount is used. The default scroll amount is defined in the upper right corner of the Intercept panel.

KSIZE (or KS) Command (Keep Window Size)

Use the KSIZE command to determine the size of your keep window. The keep window appears on the Intercept panel immediately above the first line of the program listing.

The KSIZE command lets you control the maximum depth of the keep window and whether the window should be fixed or variable in size.

Syntax

Use the following syntax for KSIZE:

KSIZE depth F|V

Enter this command in its abbreviated form: KS.

Variables

Use the following variables with the KSIZE command:

depth	The maximum number of lines of data to be displayed in the window at one time.
F	Specify F for a fixed window size.
V	Specify V for a variable sized window.

Usage Notes

You can set the keep window size to any depth from 1 to 15 lines of data. The default depth is 6 lines.

If KSIZE is defined as fixed, the keep window always occupies the maximum depth, even if the window contains less data items that the maximum. If the window is defined as variable, it will never occupy more lines on the screen than are necessary to display all of the data items, and never more than the maximum depth.

Define your keep window as fixed to prevent bouncing of your source listing while stepping through the program.

KUP Command (Scroll Keep Window Up)

Use the KUP command to scroll the keep window in the upward direction. The keep window appears on the Intercept panel immediately above the first line of the program listing.

Syntax

Use the following syntax for KUP:

KUP scroll-amt

Variables

Use the following variables with the KUP command:

scroll-amt	Identifies the number of lines to scroll, specified as one of the following:
PAGE	Scroll up one full page.
HALF	Scroll up one half page.
MAX	Scroll up to the top of the window.
nnn	Scroll the number of lines specified.

Usage Notes

The keep window is not scrollable if the number of entries in the window is less than the maximum depth defined by the KSIZE command. If the window is not scrollable, the KUP command is not functional.

If no argument is specified, the default scroll amount is used. The default scroll amount is defined in the upper right corner of the Intercept panel.

LOCATE Command

Use the LOCATE command to scroll to a specified line or a user-defined symbolic label in the program.

Syntax

Use the following syntax for LOCATE:

LOCATE nnnnnn|.label

You can enter this command in its abbreviated form: L.

Variables

Use the following variables with the LOCATE command:

nnnnnn	Specifies a relative line number. The display scrolls so that the line number is the first line of the display. A line number of zero causes a scroll to the top of the data; 999999 causes a scroll to the bottom of the data.
.label	Causes the display to scroll so that the line number equated to the symbolic label is the first line in the display.

A symbolic label equates to a line number. To establish a symbolic label, scroll the display until the line number to be equated is on the first line of the display. Enter the label in the COMMAND input field in the format:

xxxxxxx

The period is required and is followed by up to seven alphanumeric characters. The application does not retain symbolic labels when the test session ends.

.label Command

This command assigns a symbolic label to the current line number in the program.

Syntax

Use the following syntax for .label:

.xxxxxx

Variables

Use the following variables with the .label command:

xxxxxxx

The period is required and may be followed by up to 7 alphanumeric characters.

The application does not retain symbolic labels when the test session ends.