Command and syntax reference

This section contains descriptions of File-AID/RDX primary and line commands. Each description consists of notes on command usage and a syntax diagram. For a more detailed explanation, refer to the section that covers the option where the command is used.

Notation rules

This space uses the following notation rules:

  • Screen names appear with initial caps. For example:
    • …. on the Extract Specification screen
  • Field names and column names appear in bold letters with initial caps. For example:
    • …. in the Creator Name field
    • …. in the Field Value column
  • Actual field values taken from a screen appear in text in a line printer typeface. For example:
    • Type S next to FRSAMP.ORDER_TABLE to select it.
  • Command names appear in all uppercase. For example:
    • The CANCEL command causes…
  • User input appears in bold uppercase letters. For example:
    • Enter YES to edit the JCL.

Reading the syntax diagrams

Syntax diagrams define primary command syntax.

A parameter is either a keyword or a variable.

All KEYWORDs are shown in uppercase characters and must be spelled exactly as shown. You cannot substitute another value. If any part of a KEYWORD is shown in lowercase characters, that part is optional.

Variables are user-specified values and are printed in lowercase italics. For example, dataset-name indicates you are to substitute a value.

The syntax for commands is described in diagrams that help you visualize parameter use. The following example shows a command and a parameter:

image2021-10-8_11-35-13.png

Read the diagrams from left to right and from top to bottom. These symbols help you follow the path of the syntax:

image2023-1-6_11-8-55.png


Indicates the beginning of a statement.

image2023-1-6_11-9-10.png

Indicates the statement is continued on the next line.

image2023-1-6_11-9-36.png

Indicates the statement is continued from the previous line.

image2023-1-6_11-9-46.png

Indicates the end of a statement.

Required parameters appear on the horizontal line (the main path). Optional parameters appear below the main path. Default parameters appear above the main path and are optional. The command executes the same regardless whether the default parameter is included.

image2021-10-8_11-36-17.png

Vertically stacked parameters are mutually exclusive. If you must choose a parameter, one item of the stack appears on the main path. If the parameters are optional, the entire stack appears below the main path. If a parameter in a stack is the default, it appears above the main path.

image2021-10-8_11-36-49.png

If the same parameters are used with several commands their syntax may be documented in a separate diagram. In the command syntax, these common parameters are indicated with separators before and after the parameter name.

image2021-10-8_11-37-20.png

An arrow returning to the left indicates a repeatable item. If the arrow contains a comma, separate the repeated items with a comma.

image2021-10-8_11-37-37.png

This section provides information about the following topics:

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*