Notational conventions

A uniform notation describes the format of data management macro instructions. This notation is not part of the language; it is merely a way of describing the format of the instructions. The instruction format definitions in this book use the following conventions:
[ ]
Brackets enclose an optional entry. You may, but need not, include the entry. Examples are:
  • [length]
  • [MF=E]
|
An OR sign (a vertical bar) separates alternative entries. You must specify one, and only one, of the entries unless you allow an indicated default. Examples are:
  • [REREAD|LEAVE]
  • [length|'S']
{ }
Braces enclose alternative entries. You must use one, and only one, of the entries. Examples are:
  • BFTEK={S|A}
  • {K|D}
  • {address|S|O}
Sometimes alternative entries are shown in a vertical stack of braces. An example is:

MACRF={{(R[C|P])}
{(W[C|P|L])}
{(R[C],W[C])}}

In the example above, you must choose only one entry from the vertical stack.

. . .
An ellipsis indicates that the entry immediately preceding the ellipsis may be repeated. For example:
  • (dcbaddr,[(options)],. . .)
‘  ’
A ‘ ’ indicates that a blank (an empty space) must be present before the next parameter.
UPPERCASE BOLDFACE
Uppercase boldface type indicates entries that you must code exactly as shown. These entries consist of keywords and the following punctuation symbols: commas, parentheses, and equal signs. Examples are:
  • CLOSE , , , ,TYPE=T
  • MACRF=(PL,PTC)
UNDERSCORED UPPERCASE BOLDFACE
Underscored uppercase boldface type indicates the default used if you do not specify any of the alternatives. Examples are:
  • [EROPT={ACC|SKP|ABE}]
  • [BFALN={F|D}]
Lowercase Italic
Lowercase italic type indicates a value to be supplied by you, the user, usually according to specifications and limits described for each parameter. Examples are:
  • number
  • image-id
  • count