The following table explains the typographical conventions used in the IBM® XL C/C++ for Linux®, V11.1 information.
| Typeface | Indicates | Example |
|---|---|---|
| bold | Lowercase commands, executable names, compiler options, and directives. | The compiler provides basic invocation commands, xlc and xlC (xlc++), along with several other compiler invocation commands to support various C/C++ language levels and compilation environments. |
| 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. |
| underlining | The default setting of a parameter of a compiler option or directive. | nomaf | maf |
| monospace | Programming keywords and library functions, compiler builtins, examples of program code, command strings, or user-defined names. | To compile and optimize myprogram.c, enter: xlc myprogram.c -O3. |
Most features described in this information apply to both C and C++ languages. In descriptions of language elements where a feature is exclusive to one language, or where functionality differs between languages, this information uses icons to delineate segments of text as follows:
| Qualifier/Icon | Meaning |
|---|---|
C only, or C only begins![]() ![]() |
The text describes a feature that is supported in the C language only; or describes behavior that is specific to the C language. |
C++ only, or C++ only begins![]() ![]() |
The text describes a feature that is supported in the C++ language only; or describes behavior that is specific to the C++ language. |
IBM extension
begins![]() ![]() |
The text describes a feature that is an IBM extension to the standard language specifications. |
C++0x, or C++0x begins![]() ![]() |
The text describes a feature that is introduced into standard C++ as part of C++0x. |
Throughout this information, diagrams illustrate XL C/C++ syntax. This section will help you to interpret and use those diagrams.
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.
>>-keyword--required_argument----------------------------------><
>>-keyword--+-------------------+------------------------------>< '-optional_argument-'
If you must choose one of the items, one item of the stack is shown on the main path.
>>-keyword--+-required_argument1-+----------------------------->< '-required_argument2-'
.-,-------------------. V | >>-keyword----repeatable_argument-+----------------------------><
.-default_argument---. >>-keyword--+-alternate_argument-+-----------------------------><
Sample syntax diagram
(1) (2) (3) (4) (5) (9) (10) >>-------#------pragma------comment------(------+-compiler-----------------------------------------------+--)---------->< +-date---------------------------------------------------+ +-timestamp----------------------------------------------+ | (6) | '-+-copyright-+------+---------------------------------+-' '-user------' | (7) (8) | '-,------"--token_sequence--"-----'
#pragma comment(date) #pragma comment(user) #pragma comment(copyright,"This text will appear in the module")
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 labelled as either Example or Basic example. Basic examples are intended to document a procedure as it would be performed during a basic, or default, installation; these need little or no modification.