PURPOSE: The equated command LISTER produces paged and formatted listings of any or all objects in a Data Base Library (DBL) except Data Sets (DS) and System Files (SF). The objects that can be listed are Schema Definitions (SD), Process Modules (PM), Command Modules (CM), Global Storage (GS) definitions, Index Definitions (ID), Control Files (CF), and Data Index (DI) definitions. The program presents a series of options that allows a choice of formatting features that can be used. A complete printout of the application, including a table of contents, is possible. The output of Lister is written to a file.
LISTER
EXAMPLE 1: shows all the extended options. Response to prompts are indicated in bold print.
*LISTER<CR>
CM LISTER version 4.05
Enter the DBL name or HELP or QUIT: <BOOKS>
Do you want to include all items in DBL BOOKS? <Yes> <CR>
Extended Options? <Yes> <CR>
Table of contents? <Yes> <CR>
Output formatted for printer? <Yes> <CR>
Text formatted? <Yes> <CR>
If the "Text Format" prompt were answered with "NO", the following six prompts would not appear.
Do you want any nesting identification added to ACCENT code? <Yes> <CR>
Specify the number of spaces to indent per nesting level:<2> <CR>
Do you want to indent the left margin? <Yes> <CR>
Single spacing (Type 'NO' for double spacing)? <Yes> <CR>
Do you want to print the line numbers? <YES> NO<CR>
Specify the page width in characters: <79> <CR>
Page after each PM section? <No> <CR>
Reports being generated...
Files BOOKS.REP and BOOKS.TCN are ready
When a table of contents is requested, LISTER creates two files: report file (.REP), table of contents (.TCN). In order to view the files, use the LIST command.
*LIST SF BOOKS.TCN <CR>
*LIST SF BOOKS.REP <CR>
EXAMPLE 2: shows the option of listing DBL objects by type and name instead of including all qualified DBL objects (DS’s not included). The extended options are skipped so a table of contents file is not created. A single report file is created. @UNIQUE_ID is used as the first three characters of the output file name. @UNIQUE_ID can be set to any 3 characters you want prior to executing Lister.
*TYPE @UNIQUE_ID
12C
*SET "LIS" TO @UNIQUE_ID
*LISTER<CR>
CM LISTER version 4.05
Enter the DBL name or HELP or QUIT: <BOOKS>
Do you want to include all items in DBL BOOKS? <Yes> NO<CR>
Do you want to choose items by name? <YES> <CR>
Enter each type and name on a new line and terminate the list
with a carriage return on a blank line or an asterisk, '*'.
Item: SD BOOKS <CR>
Item: <CR>
Extended Options? <Yes> NO<CR>
Report being generated...
System file LIST.TMP is ready
EXAMPLE 3: shows the option of listing DBL objects by type.
*LISTER<CR>
CM LISTER version 4.05
Enter the DBL name or HELP or QUIT: <BOOKS>
Do you want to include all items in DBL BOOKS? <Yes> NO<CR>
Do you want to choose items by name? <YES> NO<CR>
Enter all item types to be included on one line, separated by
commas. (ex. SD, DI): SD
Extended Options? <Yes> NO<CR>
Report being generated...
System file LISLST.TMP is ready
NOTES: If a DBL is declared when LISTER is invoked, it will be indicated as the default DBL in the first prompt.
When "Extended Options" are not specified, the report file contains the text of the objects with no indentation. Each object begins at the top of a new page. Item names appear at the top of the first page along with the date and time of listing. This report is formatted to be printed on a line printer.
"Output formatted for printer" controls number of lines per page. The default is 60 lines per page for high speed printers. If answered "NO", LISTER formats the report with 66 lines per page for compatibility with terminals.
"Text formatting" performs a number of alterations to the actual layout of the object’s text. Line continuations are provided to fit text within the specified page width. For all CM’s and PM’s, formatting adds clarity to the control blocks by indenting two spaces for each newly nested block. If text formatting is chosen, several sub-options are available to further refine presentation of the objects:
Indent left margin
Single or double spacing
Printing or omission of line numbers
Choice of page width (default is 80)
Beginning each PM section on a new page
If beginning each PM section on a new page, each ROUTINE and SEGMENT will also start at the top of a new page. The current PM section name appears at the top of each page along with the PM name. During the printing of the process section, the current ROUTINE or SEGMENT name appears below the section name in the header.
If the first line of text in any DBL object is a comment, it will be included in the table of contents. Thus the first line of an object can contain a brief description or statement of purpose.
Error messages will be displayed if incorrect information is entered. The prompt is then repeated to give the user another chance.
The word "item" in the prompts is equivalent to the word "object" as used in the reference manual.
SEE ALSO: LIST Command, COMPOSE Utility Command, and @UNIQUE_ID System Fields