Previous Topic: UtilitiesNext Topic: CA SymDump System Reports


Dump Viewer Commands

This section describes the commands available in the dump viewer.

Some commands are only available on Dump Index display, while others are only available when a dump is loaded. For a list of valid commands for each of these environments, see the chapter Viewing Dumps on TSO/ISPF.

This section contains the following topics:

BOTTOM

CMSG

CTRACE

DISASSEM

DOWN

DROP

DUMP

EQUATE

FIND

HELP

HOME

KEEP

LEFT

LISTMAPS

LOADMAPS

MAP

NOTES

OPTIONS

PRINT

REFRESH

RFIND

RIGHT

SELECT

SELECTX

SETINDEX

STATUS

SORT

SYMBOLS

TOP

UP

BOTTOM

Scrolls the display to the last line.

Abbreviation

None

Syntax
BOTTOM

CMSG

Displays a CICS Message Help report for any CICS message, CICS dump code or CICS transaction abend code.

Abbreviation

CM

Syntax
CMSG arg

Where:

arg specifies the CICS message, CICS dump code or CICS transaction code for which the help report is being requested.

Examples:

CTRACE

Displays the CICS Auxiliary Trace dialog.

Abbreviation

CT

Syntax
CTRACE 

DISASSEM

Formats the contents of virtual storage using the built-in disassembler.

Abbreviation

DI

Syntax
DISASSEM address length  

Where:

address

Specifies the virtual storage location to be disassembled.

Note: For more information about address specification, see the description of the DUMP command in this appendix.

length

Identifies the length of storage to be disassembled.

Examples:

DOWN

Use the DOWN command to scroll the current display forward.

Abbreviation

None

Syntax
DOWN {number-of-lines|MAX|CSR|PAGE|HALF}  

Where:

number-of-lines

Specifies the number of lines to scroll the display

MAX

Scrolls the display to the bottom.

CSR

Scrolls the display to the current cursor position, or one page if the cursor is not located within the display area.

PAGE

Scrolls the display by the number of lines in the display area.

HALF

Scrolls the display by one half the number of lines in the display area.

If no argument is specified, the scroll amount is determined by the default scroll value that appears in the upper right corner of the display.

DROP

Deletes a previously defined symbol.

Abbreviation

None

Syntax
DROP <symbol-name|ALL> 

Where:

symbol-name

Specifies the name of the symbol to delete.

ALL

Specifies that all symbols must be deleted.

Examples:

DUMP

Displays the contents of virtual storage from the selected dump.

Abbreviation

D

Syntax
DUMP address 

Where:

address

Specifies the virtual storage location to be dumped, address can include a symbol and can specify an indirect address. Enter address using the following syntax. The base variable is required; the prefix, suffix and offset variables are optional:

[prefix]base[suffix][+|-offset[suffix]…]

A symbol can be used as part or all of the address operand. The symbol is automatically replaced by its assigned value during address resolution. For more information, see "Using Symbols". The built-in symbols are as follows:

PSW

The PSW at the time the dump was captured.

CURRTCB

The address of the TCB at the time the dump was captured.

R0 to R15

The general purpose registers at the time the dump was captured.

Valid values for prefix are:

@

Treats the address as a 31-bit indirect address.

%

Treats the address as a 24-bit indirect address.

Valid values for base are:

*

Current location reference. Valid only when the Command is entered from a DUMP, MAP, or DISASSEM display. The asterisk (*) is replaced by the starting address of the current display.

hex value

A one- to eight-digit hexadecimal address.

decimal value

A one to 10 decimal digit followed by a decimal point.

symbol

A symbol previously defined by an EQUATE command or one of the predefined symbols.

Valid values for suffix are:

?

Treats the address as a 31-bit indirect address.

%

Treats the address as a 24-bit indirect address.

Valid values for offset are:

hex value

A one to eight digit hexadecimal address.

decimal value

A one to ten decimal digit followed by a decimal point.

L'symbol

The length of a previously defined symbol.

L'map

The length of a previously loaded map.

L'map label

The length of a previously loaded label within a loaded map.

nnnnnnnnK

Any number of kilobytes (KB). The value nnnnnnnn is multiplied by 1024 for kilobytes.

nnnnnnnnP

Any number of pages (P). The value nnnnnnnn is multiplied by 4096 for pages.

nnnnnnnnM

Any number of megabytes (MB). The value nnnnnnnn is multiplied by 1048576 for megabytes.

map.label

The offset of a label defined within a loaded map (that is, psa.psaaold).

symbol

The value of a symbol previously defined by an EQUATE command or the value of a predefined symbol.

Indirect Addresses

An indirect address identifies the address of an address. Suffix characters used to specify indirect address references are processed as they are encountered from left to right. Prefix characters used to specify indirect address references are processed once after the remainder of the address parameter has been completely resolved.

Examples:

EQUATE

Defines a symbol to represent a virtual storage address or any other numeric value. For more information, see "Using Symbols".

Abbreviation

EQ

Syntax
EQUATE symbol address {length|USE mapname}  

Where:

symbol

Specifies a one to eight character symbol name beginning with a letter (a to z) and containing any alphanumeric characters including the national symbols @, #, and $.

address

Specifies the virtual storage location to be equated with a symbol.

Note: See the description of the DUMP command in this appendix for more information about address specification.

length

Specifies the length of the area to be equated with a symbol.

Mapname

Specifies the name of a loaded map that is used to Auto-Map the specified address.

Examples:

FIND

Locates:

Abbreviation

F

Syntax

From a DUMP display:

FIND data start-address {length}

From any other display:

FIND string {PREV}

Where:

data

Specifies the EBCDIC or hexadecimal data to be located. Specify hexadecimal data as an even number of digits enclosed by x’ ‘.

start-address

Specifies the storage address where the search must begin.

Note: For more information about address specification, see the description of the DUMP command in this appendix.

length

Specifies the length, as a hexadecimal value, of storage to be searched. If not specified, a default length of 10000 bytes is searched.

string

Specifies any group of letters or numbers up to 31 characters long. If string contains a blank, you must enclose string in apostrophes. If string contains an apostrophe (‘), you must enclose string in quotation marks (“).

PREV

Locates the previous occurrence of string.

Examples:

HELP

Requests help for the current display, the current message, or the specified topic or message.

Abbreviation

H

Syntax

HELP {topic|COMMANDS|TOPICS|MESSAGE}

Where:

topic

Specifies any command, message number, or topic for which help is being requested.

COMMANDS

Displays a selection list of all dump viewer commands.

TOPICS

Displays a selection list of help topics.

MESSAGE

Displays a selection list of all product messages.

Examples:

HOME

Gives the current display home state status.

Abbreviation

None

Syntax
HOME

KEEP

Adds a data record from the display to the Keep Window; enables, or disables the window display. The KEEP command can also be used as a synonym for REMOVE.

Abbreviation

None

Syntax
KEEP {ON|OFF} 

Where:

ON

Enables the window display.

OFF

Disables the window display.

If the Keep Window display is enabled and no argument is specified on the KEEP command, the line of data identified by the cursor position is added or removed from the window.

LEFT

Scrolls the current display to the left.

Abbreviation

None

Syntax
LEFT {number-of-columns|MAX|CSR|PAGE|HALF}  

Where:

number-of-columns

Specifies the number of columns to scroll the display

MAX

Scrolls the display to the first column.

CSR

Scrolls the display to the current cursor position, or the width of one page if the cursor is not located within the display area.

PAGE

Scrolls the display by the number of columns in the display area.

HALF

Scrolls the display by one half the number of columns in the display area.

If no argument is specified, the scroll amount is determined by the default scroll value that appears in the upper right corner of the display.

LISTMAPS

Displays the names of the currently loaded maps.

Abbreviation

None

Syntax
LISTMAPS 

LOADMAPS

Loads maps from a member in a map library.

Abbreviation

None

Syntax
LOADMAPS mapname [maplib] 

Where:

mapname

Specifies the name of a map library member to be loaded.

maplib

Specifies the name of the map library.

Example:

LOADMAPS CADVMMVS CAI.MAPLIB

MAP

Formats the contents of virtual storage using one of the loaded maps. For more information about the use of maps, see "Advanced Techniques."

Abbreviation

None

Syntax
MAP address mapname 
address

Specifies the virtual storage location to be mapped.

Note: For more information about address specification, see the description of the DUMP command.

mapname

Specifies the name of the map to use. When mapping a known control block, you do not need to specify the name of the map to use for formatting. The location and map name for most OS control blocks and many CICS control blocks are already known to the dump viewer.

Note: For more information about listing available maps, see the description of the LISTMAPS command.

Examples:

NOTES

Edits the Electronic Notepad.

Abbreviation

None

Syntax
NOTES {dsname} 

Where:

dsname

The dsname of the reports dataset for an existing dump.  If you specify a fully-qualified dsname, it must be enclosed in apostrophes.  If no apostrophes are used, your ZPREFIX value will be appended as the high-level qualifier.  This argument is only permitted when using the NOTES command on the command line from the Dump Index display. Once a dump is selected for viewing, only the notepad for that dump may be edited.

OPTIONS

Displays the options in effect.

Abbreviation

OPT

Syntax
OPTIONS

PRINT

Use the PRINT command from any display to print all or part of the display to any print destination. You are always prompted for a printer destination.

Abbreviation

PR

Syntax
PRINT

No parameters are required. However, you are prompted for the following information:

Title

A 1-32 character title that appears at the top of every printed page.

Printer

The destination to which the printed output will be routed. This can be specified as a printer name, node.userid, or left blank to spool the printed output to your TSO user ID.

Print Lines

The starting and ending lines to print. By default, the starting line is set to one and the ending line is set to the number of lines in the report.

Copies

Number of copies to print.

Class

The sysout class that will be used to allocate the print data set.

Lines/Page

Number of logical lines per page, including the title and header lines.

Record Size

Logical record length to use for the print data set. This is the maximum width of the data being printed. You can increase or decrease this value to fit your printer. However, decreasing the record size can result in truncation of data.

Page Def

Name of the library member that PSF uses to define the page layout for printing on a 3800 Printing Subsystem Model 3.

Form Def

Name of the library member that PSF uses to define the form layout for printing on a 3800 Printing Subsystem Model 3.

Chars

Name of the character arrangement tables for printing on a 3800 Printing Subsystem Model 3.

REFRESH

Refreshes the contents of the Dump Index display.

Abbreviation

REF

Syntax
REFRESH 

RFIND

Repeats the previous FIND command.

Abbreviation

RF

Syntax
RFIND

RIGHT

Scrolls the current display to the right.

Abbreviation

None

Syntax
RIGHT {number-of-columns|MAX|CSR|PAGE|HALF} 

Where:

number-of-columns

The number of columns to scroll the display

MAX

Scrolls the display to the last column.

CSR

Scrolls the display to the current cursor position, or the width of one page if the cursor is not located within the display area.

PAGE

Scrolls the display by the number of columns in the display area.

HALF

Scrolls the display by one half the number of columns in the display area.

If no argument is specified, the scroll amount is determined by the default scroll value that appears in the upper right corner of the display.

SELECT

Selects a dump data set for viewing. This command is only valid from the Dump Index display.

Abbreviation

S

Syntax
SELECT

No parameters are required; however, you are prompted for the following information:

reports dsname

The data set name of a reports data set for the captured dump.

storage dsname

The data set name of a storage data set for the captured dump.

SELECTX

Selects a dump data set for viewing and adds the related data set names to the current dump index. This command is only valid from the Dump Index display.

Abbreviation

SX

Syntax
SELECTX

No parameters are required; however, you are prompted for the following information:

reports dsname

The data set name of a reports data set for the captured dump.

storage dsname

The data set name of a storage data set for the captured dump.

SETINDEX

Selects a new dump index file for the Dump Index display.

Abbreviation

SET

Syntax
SETINDEX dsname

Where:

Dsname

The data set name of dump index. If the dsname parameter is omitted, you are prompted for it.

STATUS

Displays the current status of the dump capture facility, the availability of SYSVIEW/E Services, the product genlevel, and the system ID. STATUS also displays the core address for each resident module associated with the dump capture facility.

Abbreviation

ST

Syntax
STATUS

SORT

Sorts the current output display on any column by name. Column names appear in the highlighted header line at the top of the display. By default, the display is sorted in ascending alphabetical order.

Once sorted, specify an asterisk in place of the column name to return the display to its initial order.

Abbreviation

None

Syntax
SORT <column-name|*> {D|H}

Where:

column-name

The name of the column as it appears on the highlighted header line in the display.

*

Specifies that the display must be returned to its original sort order.

D

Sorts in descending order.

H

Indicates that the column being sorted contains hexadecimal data in EBCDIC display format and must be sorted with the characters A-F considered greater than 0-9.

Examples:

SYMBOLS

Displays the currently defined symbols. Symbols are created by the EQUATE command. For more information, see "Using Symbols".

Abbreviation

None

Syntax
SYMBOLS
Built-in Symbols

Each time a dump is loaded, CA SymDump System provides the following built-in symbols:

PSW

The PSW at the time the dump was captured.

CURRTCB

The address of the TCB which requested the dump.

R0 thru R15

The general purpose registers at the time the dump was captured.

TOP

Scrolls the display to the top line.

Abbreviation

None

Syntax
TOP

UP

Scrolls the current display backward.

Abbreviation

None

Syntax
UP {number-of-lines|MAX|CSR|PAGE|HALF} 

Where:

number-of-lines

Specifies the number of lines to scroll the display.

MAX

Scrolls the display to the top.

CSR

Scrolls the display to the current cursor position, or one page if the cursor is not located within the display area.

PAGE

Scrolls the display by the number of lines in the display area.

HALF

Scrolls the display by one half the number of lines in the display area.

If no argument is specified, the scroll amount is determined by the default scroll value in the upper right corner of the display.