1 Typographic Conventions
Table 1 lists the typographic conventions used in the documents in this library.
|
Convention |
Description |
Example |
|---|---|---|
|
Code Examples |
Code examples are shown in monospaced font. |
path=/usr/bin: |
|
The arrow symbol (⇒) is used when the code lines are too long to fit on the page. |
static char* months[] = ⇒ | |
|
Command Syntax |
Optional items are shown in square brackets. |
list [sorted] |
|
Mandatory items are shown in braces. |
delete {number} | |
|
Possible additional items are indicated by an ellipsis. |
connect param1 [param2 …] | |
|
A choice of mandatory items is indicated by a vertical line. |
set {first | last | all} | |
|
Document Titles |
References to document titles are shown in italics. |
For more information, refer to the System Administrator Guide. |
|
GUI Objects |
GUI objects, such as menus, fields, and buttons are shown in bold font. |
The Open dialog box is displayed. |
|
A greater than sign (>) is used to show GUI selection. |
Select File > New. | |
|
Key Combinations |
The plus sign (+) indicates that you must press the keys simultaneously. |
Press Ctrl+X to delete the selected value. |
|
Spaces indicate that you must press the keys consecutively. |
Press Esc A N. | |
|
Output Information |
Text displayed by the system is shown in monospaced font. |
System awaiting input |
|
System Elements |
Command and parameter names, program names, path names, directory names, and so on, are shown in monospaced font. |
The files are located in E:\Test. The files are located in etc/opt/ericsson/bin. |
|
User Input |
A command that must be entered in a Command-Line Interface (CLI) exactly as written is shown in bold monospaced font. |
cd $HOME |
|
Input variables are shown in italic monospaced font and enclosed in angle brackets. |
<home_directory> |