User Manual

Rev 1.4.1-
Mellanox Techologies
7
Documentation Conventions
Typographical Conventions
Common Abbreviations and Acronyms
Table 1 - Typographical Conventions
Description Convention Example
File names file.extension
Directory names directory
Commands and their parameters command param1
Optional items [ ]
Mutually exclusive parameters { p1 | p2 | p3 }
Optional mutually exclusive parameters [ p1 | p2 | p3 ]
Prompt of a user command under bash shell hostname$
Prompt of a root command under bash shell hostname#
Prompt of a user command under tcsh shell tcsh$
Environment variables VARIABLE
Code example if (a==b){};
Comment at the beginning of a code line !, #
Characters to be typed by users as-is bold font
Keywords bold font
Variables for which users supply specific val-
ues
Italic font
Emphasized words Italic font These are emphasized words
Pop-up menu sequences menu1 --> menu2 -->... --
> item
Note Note:
Warning Warning!
Table 2 - Abbreviations and Acronyms (Sheet 1 of 2)
Abbreviation / Acronym Whole Word / Description
B (Capital) ‘B’ is used to indicate size in bytes or multiples of bytes (e.g., 1KB
= 1024 bytes, and 1MB = 1048576 bytes)
b (Small) ‘b’ is used to indicate size in bits or multiples of bits (e.g., 1Kb =
1024 bits)
FW Firmware
Mellanox Technologies Confidential