Conventions
This section describes the conventions used in this documentation set.
I. Command conventions
Convention
Description
Boldface
Bold
text represents commands and keywords that you enter
literally as shown.
Italic
Italic
text represents arguments that you replace with actual values.
[ ]
Square brackets enclose syntax choices (keywords or arguments)
that are optional.
{ x | y | ... }
Braces enclose a set of required syntax choices separated by
vertical bars, from which you select one.
[ x | y | ... ]
Square brackets enclose a set of optional syntax choices
separated by vertical bars, from which you select one or none.
{ x | y | ... } *
Asterisk marked braces enclose a set of required syntax choices
separated by vertical bars, from which you select at least one.
[ x | y | ... ] *
Asterisk marked square brackets enclose optional syntax choices
separated by vertical bars, from which you select one choice,
multiple choices, or none.
&<1-n>
The argument or keyword and argument combination before the
ampersand (&) sign can be entered 1 to n times.
#
A line that starts with a pound (#) sign is comments.
II. GUI conventions
Convention
Description
< >
Button names are inside angle brackets. For example, click
<OK>.
[ ]
Window names, menu items, data table and field names are
inside square brackets. For example, pop up the [New User]
window.
/
Multi-level menus are separated by forward slashes. For
example, [File/Create/Folder].
III. Keyboard Operations
Convention
Description
<KEY>
Push the KEY of keyboard. For example, <Enter> is push the
Enter key.
<KEY1 + KEY2>
Push some KEYs of keyboard. For example, <Ctrl+Alt+A> is
push the Ctrl key, the Alt key and the A key at the same time.
<KEY1, KEY2>
Push in turn some KEYs of keyboard. For example, <Alt,A> is
push the Alt key then push the A key.
