System Command Syntax

This document covers the following topics:


Syntax Elements

The following symbols are used within the syntax descriptions of system commands:

Element Explanation
ABCDEF Upper-case letters indicate that the term is either a Natural keyword or a Natural reserved word that must be entered exactly as specified.
ABCDEF If an optional term in upper-case letters is completely underlined (not a hyperlink!), this indicates that the term is the default value. If you omit the term, the underlined value applies.
ABCDEF If a term in upper-case letters is partially underlined (not a hyperlink!), this indicates that the underlined portion is an acceptable abbreviation of the term.
abcdef Letters in italics are used to represent variable information. You must supply a valid value when specifying this term.
[ ] Elements contained within square brackets are optional.

If the square brackets contain several lines stacked one above the other, each line is an optional alternative. You may choose at most one of the alternatives.

{ } If the braces contain several lines stacked one above the other, each line is an alternative. You must choose exactly one of the alternatives.
| The vertical bar separates alternatives.
... A term preceding an ellipsis may optionally be repeated. A number after the ellipsis indicates how many times the term may be repeated.

If the term preceding the ellipsis is an expression enclosed in square brackets or braces, the ellipsis applies to entire bracketed expression.

,... A term preceding a comma-ellipsis may optionally be repeated; if it is repeated, the repetitions must be separated by commas. A number after the comma-ellipsis indicates how many times the term may be repeated.

If the term preceding the comma-ellipsis is an expression enclosed in square brackets or braces, the comma-ellipsis applies to entire bracketed expression.

:... A term preceding a colon-ellipsis may optionally be repeated; if it is repeated, the repetitions must be separated by colons. A number after the colon-ellipsis indicates how many times the term may be repeated.

If the term preceding the colon-ellipsis is an expression enclosed in square brackets or braces, the colon-ellipsis applies to entire bracketed expression.

Other symbols (except [ ] { } | ... ,... :...) 

All other symbols except those defined in this table must be entered exactly as specified.

Exception:

The SQL scalar concatenation operator is represented by two vertical bars that must be entered literally as they appear in the syntax definition.

Example of Command Syntax

CATALOG [object-name [library-id]]
  • CATALOG is a Natural keyword which you must enter as specified. The underlining indicates that you may also enter it in abbreviated form as CAT.

  • object-name and library-id are user-supplied operands for which you specify the name of the program you wish to deal with and the ID of the library in which that program is contained.

  • The square brackets indicate that object-name and library-id are optional elements which you can, but need not, specify. The grouping of the brackets indicate that you can specify CATALOG alone, or CATALOG followed either by a program name only or by a program name and a library ID; however, you cannot specify a library ID if you do not also specify a program name.