Documentation Conventions
The following documentation conventions are used throughout the BEA Tuxedo Release 9.0 documentation.
Convention | Item |
---|---|
boldface text |
Indicates terms defined in the glossary. |
Ctrl+Tab |
Indicates that you must press two or more keys simultaneously. |
italics |
Indicates emphasis or book titles. |
monospace text |
Indicates code samples, commands and their options, data structures and their members, data types, directories, and filenames and their extensions. Monospace text also indicates text that you must enter from the keyboard. Examples: #include <iostream.h> void main ( ) the pointer psz chmod u+w * \tux\data\ap .doc tux.doc BITMAP float |
monospace boldface text |
Identifies significant words in code. Example: void commit( ) |
monospace italic text |
Identifies variables in code. Example: String expr |
UPPERCASE TEXT |
Indicates device names, environment variables, and logical operators. Examples: LPT1 SIGNON OR |
{ } |
Indicates a set of choices in a syntax line. The braces themselves should never be typed. |
[ ] |
Indicates optional items in a syntax line. The brackets themselves should never be typed. Example: buildobjclient [-v] [-o name ] [-f file-list ]... [-l file-list ]... |
| |
Separates mutually exclusive choices in a syntax line. The symbol itself should never be typed. |
... |
Indicates one of the following in a command line:
The ellipsis itself should never be typed. Example: buildobjclient [-v] [-o name ] [-f file-list ]... [-l file-list ]... |
. |
Indicates the omission of items from a code example or from a syntax line. The vertical ellipsis itself should never be typed. |