z/OS TSO/E CLISTs
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


How to read the CLIST statement syntax

z/OS TSO/E CLISTs
SA32-0978-00

Throughout this chapter, syntax is described using the structure defined below.

Read the syntax diagrams from left to right, from top to bottom, following the path of the line.

Double arrows indicate the beginning and ending of a statement.

Read syntax diagramSkip visual syntax diagram
>>-STATEMENT---------------------------------------------------><

If a statement syntax requires more than one line to be shown, single arrows indicate their continuation.

Read syntax diagramSkip visual syntax diagram
>>-STATEMENT--…………--…………--…………--…………---------------------------->

>--…………--…………--…………--…………--………---------------------------------><

Required items appear on the horizontal line (the main path).

Read syntax diagramSkip visual syntax diagram
>>-STATEMENT--required_item------------------------------------><

Optional items appear below the main path.

Read syntax diagramSkip visual syntax diagram
>>-STATEMENT--+---------------+--------------------------------><
              '-optional_item-'   

If you can choose from two or more items, they are stacked vertically.
  • If you must choose one of the items, an item of the stack appears on the main path.
    Read syntax diagramSkip visual syntax diagram
    >>-STATEMENT--+-required_choice_1-+----------------------------><
                  '-required_choice_2-'   
    
    
  • If choosing one of the items is optional, the entire stack appears below the main path.
    Read syntax diagramSkip visual syntax diagram
    >>-STATEMENT--+-------------------+----------------------------><
                  +-optional_choice_1-+   
                  '-optional_choice_2-'   
    
    

An arrow returning to the left above the main line indicates an item that can be repeated.

Read syntax diagramSkip visual syntax diagram
              .-----------------.   
              V                 |   
>>-STATEMENT----repeatable_item-+------------------------------><

A repeat arrow above a stack indicates that you can make more than one choice from the stacked items, or repeat a single choice.

Read syntax diagramSkip visual syntax diagram
              .-----------------------.   
              V                       |   
>>-STATEMENT----+-repeatable_item_1-+-+------------------------><
                '-repeatable_item_2-'     

Default values appear above the main path. For example, if you choose neither choice_2 nor choice_3, choice_1 is assumed. (Defaults can be coded for clarity reasons.)

Read syntax diagramSkip visual syntax diagram
              .-choice_1-.   
>>-STATEMENT--+----------+-------------------------------------><
              +-choice_2-+   
              '-choice_3-'   

If a syntax diagram becomes too large or too complex to be printed or shown, fragments of it are shown below the main diagram as details.

Read syntax diagramSkip visual syntax diagram
>>---STATEMENT----required_variable--+----------------------+--->
                                     '-'optional_parameter'-'   

>--| FRAGMENT |------------------------------------------------><

FRAGMENT

|--OPERAND--+--------------------+--+--------------------+------>
            +-optional_choice_1a-+  +-optional_choice_2a-+   
            '-optional_choice_1b-'  '-optional_choice_2b-'   

>--+--------------------+--+--------------------+---------------|
   +-optional_choice_3a-+  +-optional_choice_4a-+   
   '-optional_choice_3b-'  '-optional_choice_4b-'   

The previous syntax diagram is equivalent to the following diagram:

Read syntax diagramSkip visual syntax diagram
>>---STATEMENT----required_variable--+----------------------+--->
                                     '-'optional_parameter'-'   

>--OPERAND--+--------------------+--+--------------------+------>
            +-optional_choice_1a-+  +-optional_choice_2a-+   
            '-optional_choice_1b-'  '-optional_choice_2b-'   

>--+--------------------+--+--------------------+--------------><
   +-optional_choice_3a-+  +-optional_choice_4a-+   
   '-optional_choice_3b-'  '-optional_choice_4b-'   

In a CLIST statement, use uppercase letters, numbers, and the set of symbols listed below exactly as shown in the syntax.
apostrophe or single quote
'
asterisk
*
comma
,
equal sign
=
parentheses
( )
period
.
ampersand
&
percent
%
colon
:

Lowercase italic letters and symbols appearing in the syntax represent variable information for which you substitute specific information in the statement. For example, if name appears in the syntax, substitute a specific value (for example, ALPHA) for the variable when you enter the statement.

Hyphens join lowercase words and symbols to form a single variable. For example, if member-name appears in the syntax, substitute a specific value (for example, BETA) for the variable in the statement.

Alphanumeric characters: unless otherwise indicated, an alphanumeric character is one of the following:
Alphabetic:
A-Z
Numeric:
0-9
Special:
$ # @.

CLIST statements may be prefixed with a label consisting of 1-31 alphanumeric characters, beginning with an alphabetic character. The label may appear on a separate line. A colon must immediately follow the label name. For example,

label:
  • IF A= …

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014