Conventions

Typographical conventions

The following table shows the typographical conventions used in the IBM Open SDK for Rust on AIX 1.96 information.

Table 1. Typographical conventions
Typeface Indicates Example
bold Lowercase commands, executable names, compiler options, and directives.

The default file name for the executable program is a.out.
italics Parameters or variables whose actual names or values are to be supplied by the user. Italics are also used to introduce new terms. Make sure that you update the size parameter if you return more than the size requested.
monospace Programming keywords and library functions, compiler builtins, examples of program code, command strings, or user-defined names. To compile and optimize myprogram.rs, enter rustc myprogram.c -C opt-level=3

Syntax diagrams

Throughout this information, diagrams illustrate IBM Open SDK for Rust on AIX 1.96 syntax. This section helps you to interpret and use those diagrams.

  • Read syntax diagrams in reading order, following the line path:

  • The >>− symbol indicates the beginning of a command, directive, or statement.

    The −> symbol indicates that the command, directive, or statement syntax is continued on the next line.

    The >− symbol indicates that a command, directive, or statement is continued from the previous line.

    The −>< symbol indicates the end of a command, directive, or statement.

    Fragments, which are diagrams of syntactical units other than complete commands, directives, or statements, start with the | − symbol and end with the − | symbol.

  • Required items are shown on the horizontal line (the main path):
    Read syntax diagramSkip visual syntax diagram keyword required_argument
  • Optional items are shown below the main path:
    Read syntax diagramSkip visual syntax diagram keyword optional_argument
  • If you can choose from two or more items, they are shown vertically, in a stack.

    If you must choose one of the items, one item of the stack is shown on the main path.

    Read syntax diagramSkip visual syntax diagram keyword required_argument1required_argument2
    If choosing one of the items is optional, the entire stack is shown below the main path.
    Read syntax diagramSkip visual syntax diagram keyword optional_argument1optional_argument2
  • A repeat arrow above the main line indicates that you can select more than one option from the stacked items or repeat an item. If a separator other than a blank space is used, it is also shown:
    Read syntax diagramSkip visual syntax diagram keyword ,repeatable_argument
  • The default item is indicated on the main path.
    Read syntax diagramSkip visual syntax diagram keyword default_argumentalternate_argument
  • Keywords are shown in non-italic letters and should be entered exactly as shown.
  • Variables are shown in italicized lowercase letters. They represent user-supplied names or values.
  • If punctuation marks, parentheses, arithmetic operators, or other such symbols are shown, you must enter them as part of the syntax.
The following is an example of a syntax diagram with an interpretation:
Read syntax diagramSkip visual syntax diagram EXAMPLE1 char_constant abcd,e name_list
Notes:
  • 1 IBM extension
Interpret the diagram as follows:
  • Enter the keyword EXAMPLE.
  • EXAMPLE is an IBM extension.
  • Enter a value for char_constant.
  • Enter a value for a or b, but not for both.
  • Optionally, enter a value for c or d.
  • Enter at least one value for e. If you enter more than one value, you must put a comma between each.
  • Enter the value of at least one name for name_list. If you enter more than one value, you must put a comma between each. (The _list syntax is equivalent to the previous syntax for e.)

How to read syntax statements

Syntax statements are read in reading order:
  • Individual required arguments are shown with no special notation.
  • When you must make a choice between a set of alternatives, they are enclosed by { and } symbols.
  • Optional arguments are enclosed by [ and ] symbols.
  • When you can select from a group of choices, they are separated by | characters.
  • Arguments that you can repeat are followed by ellipses (…).

Example of a syntax statement

EXAMPLE char_constant {a|b}[c|d]e[,e]... name_list{name_list}...

The following list explains the syntax statement:

  • Enter the keyword EXAMPLE.
  • Enter a value for char_constant.
  • Enter a value for a or b, but not for both.
  • Optionally, enter a value for c or d.
  • Enter at least one value for e. If you enter more than one value, you must put a comma between each.
  • Optionally, enter the value of at least one name for name_list. If you enter more than one value, you must put a comma between each name.
Note: The same example is used in both the syntax-statement and syntax-diagram representations.

Examples in this information

The examples in this information, except where otherwise noted, are coded in a simple style that does not try to conserve storage, check for errors, achieve fast performance, or demonstrate all possible methods to achieve a specific result.

The examples for installation information are labeled as either Example or Basic example. Basic examples are intended to document a procedure as it would be performed during a default installation; these need minor or no modification.

Notes on the terminology used

Some of the terminology in this information is shortened as follows:
  • The term free source form format often appears as free source form.
  • The term fixed source form format often appears as fixed source form.