beautypg.com

1 – conventions followed – GarrettCom Magnum MNS-6K User Manual

Page 19

background image

Chapter

1

1 – Conventions Followed

Conventions followed in the manual…

o best use this document, please review some of the conventions followed in the
manual, including screen captures, interactions and commands with the switch,
etc.

T

Box shows interaction with the switch command line or screen captures from the
switch or computer for clarity

Commands typed by a user will be shown in a different color and this
font

Switch prompt – shown in Bold font, with a “# or >” at the end. For the
document we will use

Magnum6K25#

as the default prompt.

Syntax rules
Optional entries are shown in [square brackets]
Parameter values within are shown in < pointed brackets >
Optional parameter values are shown again in [square brackets]

Thus
Syntax command [parameter1=[, parameter2=]]
parameter3=

In the example above:
Parameter 1 and Parameter 2 are optional values
Parameter 2 can be used optionally only if Parameter 1 is specified
Parameter 3 is mandatory.

Parameter 1 has value1 = IP address
Parameter 2 has value2 = string
Parameter 3 has value3 or value4

18