Typographic conventions

This Help uses the following typographic conventions:

Convention

Description

Bold

In a procedure, indicates text on a window or dialog box, including window or dialog box names, menus, menu options, buttons, fields, and labels. Example: Click OK.

Italic

Indicates a variable, which is a placeholder for actual text provided by the user or system. Example: copy source-file target-file

Note: Angled brackets (< >) are also used to indicate variables.

monospace

Indicates text that is displayed on screen or entered by the user. Example: # pairdisplay -g oradb

< > angled brackets

Indicates a variable, which is a placeholder for actual text provided by the user or system. Example:

# pairdisplay -g <group>

Italic font is also used to indicate variables.

[ ] square brackets

Indicates optional values. Example: [ a | b ] indicates that you can choose a, b, or nothing.

{ } braces

When items in braces are set off with vertical bars: indicates required or expected values. Example:

{ a | b } indicates that you must choose either a or b.

When items in braces are enclosed by square brackets: indicates one or more items can be specified. Example:

{ [ -A ][ -B ][ -C ]} indicates that you can specify one or more items from A, B, or C.

| vertical bar

Indicates that you have a choice between two or more options or arguments. Examples:

[ a | b ] indicates that you can choose a, b, or nothing.

{ a | b } indicates that you must choose either a or b.