Conventions

Notation "vr SP s", vrs, or vr: When used in this documentation, the notation "vr SP s", vrs, or vr stands for the relevant version, release, and system maintenance level numbers. For further information on product versions, see version in the Glossary.

This document covers the following topics:

Syntax Conventions

The following table describes the conventions used in syntax diagrams of Entire Net-Work statements.

Convention Description Example
uppercase, bold Syntax elements appearing in uppercase and bold font are keywords. When specified, these keywords must be entered exactly as shown.

graphics/wcpsy_k.png

The syntax elements DRIVER, TCPI, and DRVCHAR are Entire Net-Work keywords.

lowercase, italic, normal font Syntax elements appearing in lowercase and normal, italic font identify items that you must supply.

graphics/wcpsy_k.png

The syntax element driver-char identifies and describes the kind of value you must supply. In this instance, you must supply the special character used to designate that an operator command is directed to the TCP/IP line driver, rather than to a specific link.

underlining

Underlining is used for two purposes:

  1. To identify default values, wherever appropriate. Otherwise, the defaults are explained in the accompanying parameter descriptions.

  2. To identify the short form of a keyword.

graphics/wcpsy_k.png

In the example above, # is the default that will be used for the DRVCHAR parameter if no other record buffer length is specified.

Also in the example above, the short version of the DRVCHAR parameter is D.

vertical bars (|) Vertical bars are used to separate mutually exclusive choices.

Note:
In more complex syntax involving the use of large brackets or braces, mutually exclusive choices are stacked instead.

graphics/wcpsy_ch.png

In the example above, you must select BS2, CNS, EZA, HPS, or OES for the API parameter. There are no defaults.

brackets ([ ]) Brackets are used to identify optional elements. When multiple elements are stacked or separated by vertical bars within brackets, only one of the elements may be supplied.

graphics/wcpsy_k.png

In this example, the DRVCHAR parameter is optional.
braces ({ }) Braces are used to identify required elements. When multiple elements are stacked or separated by vertical bars within braces, one and only one of the elements must be supplied.

graphics/wcpsy_ch.png

In this example, one of the following values is required for the API parameter: BS2, CNS, EZA, HPS, or OES.

other punctuation and symbols All other punctuation and symbols must be entered exactly as shown.

graphics/wcpsy_p.png

In this example, the periods must be specified in the IP address.

In addition, options must be separated by commas and dashes should be used as needed to indicate that parameter settings continue on the next line.

Syntax Rules

The following rules apply when specifying Entire Net-Work parameter statements:

  • Each Entire Net-Work parameter statement occupies positions 1 - 72 of at least one line.

  • The statement type (NODE, LINK, TRANSDEF, or DRIVER) must be specified as the first nonblank item on the statement.

  • The node name, driver name, translation definition function, or link name follows the statement type, separated by at least one blank (space).

  • Keyword parameters may be specified following either the node name on NODE statements or the driver name on DRIVER and LINK statements. Keyword parameters are separated from their arguments by an equal (=) sign, and from other keyword parameters by at least one blank (space) or a comma (,).

  • When the acceptable values for a parameter are Y and N (yes and no), any other value is treated as an N, unless there is a documented default, and processing continues without any warning.

  • When the acceptable values for a parameter fall within a range (e.g., 1 - 2147483647) and a value outside the range is specified, the value is automatically reset to the maximum value within the range, unless documented otherwise for the parameter. Processing continues without any warning.

  • A statement can be continued beginning in any column of the next line by specifying a dash (-) as the last nonblank character in any column of the current line, before column 73.

  • Comment lines begin with an asterisk (*) in position 1 and can be inserted anywhere in the statement sequence.

  • Some keywords may require a list of subparameters separated by commas; the list must be enclosed in parentheses ( ) unless only the first subparameter is to be entered. Omitted ("defaulted") subparameters must be represented by placeholder commas if subsequent parameters are to be entered. The following are examples of correct subparameter strings: 

    KEYWORD=(value1,value2,value3)
KEYWORD=(value1,,value3)
KEYWORD=(,,value3)
KEYWORD=(,value2)
KEYWORD=value1

  • Hexadecimal keyword values can be entered by prefixing the value with an "X". For example: 

    LINK . . . ADJID=X0064, . . .