LISTSYM subcommand — list symbol table entries

Use the LISTSYM subcommand to display the definitions of symbols for a source or to produce a display using symbols for a source.

The symbols are in a symbol table that is part of a source description. A source description is for an unformatted source that IPCS can format, for example, an SVC dump, a stand-alone dump, an SYSMDUMP dump, a trace data set, a data set, or active storage. The source description is in the dump directory allocated with ddname IPCSDDIR and is your current dump directory. The current dump directory is your user dump directory or, for users with write access authority, might be the sysplex dump directory.

Related subcommands
- DROPSYM
- EQUATE
- RENUM
- STACK

Syntax

  { LISTSYM } [ (symbol-list) | * ]
  { LSYM    }
              [ SELECT [(ALL | DROP | NODROP)] ]
              [ SUMMARY | NOSUMMARY ]

-------- SETDEF-Defined Parameters -------------------------
Note: You can override the following SETDEF parameters.
See SETDEF subcommand — set defaults.

              [ ACTIVE | MAIN | STORAGE          ]
              [ DSNAME(dsname) | DATASET(dsname) ]
              [ FILE(ddname) | DDNAME(ddname)    ]
              [ PATH(path-name)     ]
              [ DISPLAY[(display-options)]   ]
              [ NODISPLAY[(display-options)] ]
              [ PRINT | NOPRINT ]
              [ TERMINAL | NOTERMINAL ]
              [ TEST | NOTEST ]

Parameters
symbol-list or *
Specifies the symbols to be displayed:
- symbol-list specifies one or more particular symbols.
- * specifies all the symbols in the symbol table. If you omit this parameter, the default is *.
The symbol-list can be a single symbol, a range of symbols, a list of symbols, or any combination of these. When you specify a range, separate the first and last symbols in the range with a colon. When you specify a list, separate the symbols with commas. If you specify more than one symbol or range, enclose them in parentheses. The list can contain a maximum of 31 symbols, ranges, or both.

The symbols must follow the IPCS naming conventions for symbols if a range is specified. See IPCS symbols.

For a range, IPCS displays all symbols whose names begin with the first character string through all symbols whose names begin with the second character string. A range of symbols is inclusive; IPCS displays all the symbols in the range and at both ends of the range.
SELECT(ALL | DROP | NODROP)
Specifies a selection criterion for symbols to be displayed:
- ALL specifies that all symbols are to be displayed.
- DROP specifies that only symbols with the DROP attribute are to be displayed.
- NODROP specifies that only symbols with the NODROP attribute are to be displayed.
If you omit ALL, DROP, or NODROP, the default is ALL.
SUMMARY or NOSUMMARY

SUMMARY indicates that a processing summary (a final total line) is to be produced.
NOSUMMARY specifies that a processing summary is to be suppressed. The NOSUMMARY parameter is useful to turn off summary messages when the subcommand is invoked within a CLIST or a REXX exec.

DISPLAY[(display-options)]

NODISPLAY[(display-options)]
Specifies the display options. The defaults are:
```
DISPLAY(NOMACHINE NOREMARK REQUEST NOSTORAGE SYMBOL AlIGN)
```
LISTSYM uses a special, tabular display format unless you specify one of the following display options:
```
DISPLAY(MACHINE NOREQUEST STORAGE NOSYMBOL)
```
If you specify none of these options, IPCS uses the general-purpose dump display format.
In addition, the archaic REMARKS parameter can be specified as a separate parameter. REMARKS is the equivalent of DISPLAY(REMARK). It causes the display to include any remarks associated with a symbol.
ACTIVE or MAIN or STORAGE

DSNAME(dsname) or DATASET(dsname)

FILE(ddname) or DDNAME(ddname)

Specifies the source of the source description containing the symbol. If one of these parameters is not specified, the default is your current source.
Return Codes
See Standard subcommand return codes for a description of the return codes produced by the LISTSYM subcommand.
Example 1: List a range of symbols.
- Action
```
COMMAND ===> listsym (my:my title acvt)
```
- Result
  The following output is produced.
```
SYMBOL   ADDRESS  ATTRIBUTES
ACVT       1D418. ASID(X'0001') POSITION(-24) LENGTH(1248) STRUCTURE(CVT) DROP
MY#LONG#SYMBOLIC
               0. ASID(X'0078') LENGTH(96) AREA DROP
MYARRAY    F0000. ASID(X'0078') POSITION(+64) LENGTH(4) ENTRIES(52:77)
                  SIGNED DROP
MYCVT      1D418. ASID(X'0001') POSITION(-24) LENGTH(1248) STRUCTURE(CVT) DROP
TITLE          0. HEADER POSITION(20) LENGTH(53) CHARACTER NODROP
5 DEFINITIONS LISTED
```
- Explanation
  - Symbols are always processed alphabetically. Specifying “acvt” after the other selection criteria produces the same result as moving it to the beginning of the list.
  - A caption line is provided for the special, tabular format of the LISTSYM display. Symbol and address captions describe the values that will appear beneath. Attributes are shown in a self-describing format using standard IPCS parameters plus decimal or hexadecimal values. Underscores are added to the caption line when transmitted to a print data set.
  - The entire definition of a symbol is typically displayed on one line. The format resembles that of the EQUATE subcommand parameters.
  - When the symbol and the address overlap, if both are displayed on a single line, the symbol will appear alone on the initial line, and the address and attributes will begin on a second line.
  - When the full complement of attributes will not fit on one line, they may overflow onto an additional line.
Example 2: List a range of ASCB symbols.
- Action
```
COMMAND ===> listsym (ascb00001 : ascb00050)
```
- Result
  LISTSYM displays the ASCB symbols for ASID 1 through 50.
Example 3: List a range of TCB symbols.
- Action
```
COMMAND ===> listsym (tcb00001aaaaa : tcb00001baaaa)
```
- Result
  LISTSYM displays the specified range of TCBs.