Typographical Conventions - Mellanox Technologies Mellanox SX1018 Command Reference Manual

Documentation Conventions

Typographical Conventions

Table 3 - Typographical Conventions
Description
File names
Directory names
Commands and their parameters
Required item
Optional item
Mutually exclusive parameters
Optional mutually exclusive parame-
ters
Prompt of a command in Standard
mode
Prompt of a command in Enable mode
Prompt of a command in Config mode
Comments to explain command
examples
Variables for which users supply spe-
cific values
Emphasized words
Note
Warning
Convention
file.extension
directory
command param1
< >
[ ]
{p1, p2, p3} or {p1 | p2 |
p3}
[p1 | p2 | p3]
hostname >
hostname #
hostname (config) #
//
Italic font
Italic font
<text>
<text>
Example
sx10xx-1 > show hosts
sx10xx-1 >
sx10xx-1 #
sx10xx-1 (config) #
// This is a comment
enable
These are emphasized words
This is a note.
Make sure to connect to the
RS-232 RJ-45 port of the
switch and not to the MGT
port.
Mellanox Technologies
Rev 1.6.2
14