Typographical conventions
Convention Example Description
italic text in a command line
-o filename
place-holder for mandatory user-supplied arguments
square brackets, []
.macro name [list]
encloses optional commands, terms, or arguments
square brackets [] around boldface word "default"
Specifies char as signed. [default]
command or option is the default
menu > item > sub-item...
File > Open...
menu bar, menu items, sub-menu items...
Enter something
Enter cc800 -S hi.c
Type something AND press the Enter key. Compare with "Type something" below.
Type something
Type foo.c and press Edit
Type something WITHOUT pressing the Enter key. Compare with "Enter something" above.

For example, in the command description:

gcc [-processor] filename

the command gcc should be entered as given, the word processor may optionally be substituted with an appropriate option, and the word filename must be replaced with an appropriate file name.

Related topic:


Previous

Next



Copyright © 1999, Green Hills Software. All rights reserved.