Dell Brocade 6520 Fabric OS Troubleshooting and Diagnostics Guide v7.1.0 - Page 13

Document conventions, Text formatting, Command syntax conventions, Command examples

Get Dell Brocade 6520 PDF manuals and user guides View all Dell Brocade 6520 manuals
Add to My Manuals
Save this manual to your list of manuals

Page 13 highlights

Document conventions This section describes text formatting conventions and important notice formats used in this document. TEXT FORMATTING The narrative-text formatting conventions that are used are as follows: bold text Identifies command names Identifies the names of user-manipulated GUI elements Identifies keywords and operands Identifies text to enter at the GUI or CLI italic text Provides emphasis Identifies variables Identifies paths and Internet addresses Identifies document titles code text Identifies CLI output Identifies command syntax examples COMMAND SYNTAX CONVENTIONS For readability, command names in the narrative portions of this guide are presented in mixed lettercase: for example, switchShow. In actual examples, command lettercase is often all lowercase. Otherwise, this manual specifically notes those cases in which a command is case sensitive. Command syntax in this manual follows these conventions: command --option, option -argument, arg [ ] variable ... value | Commands are printed in bold. Command options are printed in bold. Arguments. Optional element. Variables are printed in italics. In the help pages, values are underlined or enclosed in angled brackets < >. Repeat the previous element, for example "member[;member...]" Fixed values following arguments are printed in plain font. For example, --show WWN Boolean. Elements are exclusive. Example: --show -mode egress | ingress COMMAND EXAMPLES This book describes how to perform configuration tasks using the Fabric OS command line interface, but does not describe the commands in detail. For complete descriptions of all Fabric OS commands, including syntax, operand description, and sample output, refer to the Fabric OS Command Reference. Fabric OS Troubleshooting and Diagnostics Guide xiii 53-1002751-01

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
Fabric OS Troubleshooting and Diagnostics Guide
xiii
53-1002751-01
Document conventions
This section describes text formatting conventions and important notice formats used in this
document.
TEXT FORMATTING
The narrative-text formatting conventions that are used are as follows:
bold
text
Identifies command names
Identifies the names of user-manipulated GUI elements
Identifies keywords and operands
Identifies text to enter at the GUI or CLI
italic
text
Provides emphasis
Identifies variables
Identifies paths and Internet addresses
Identifies document titles
code
text
Identifies CLI output
Identifies command syntax examples
COMMAND SYNTAX CONVENTIONS
For readability, command names in the narrative portions of this guide are presented in mixed
lettercase: for example,
switchShow
. In actual examples, command lettercase is often all
lowercase. Otherwise, this manual specifically notes those cases in which a command is case
sensitive. Command syntax in this manual follows these conventions:
COMMAND EXAMPLES
This book describes how to perform configuration tasks using the Fabric OS command line
interface, but does not describe the commands in detail. For complete descriptions of all Fabric OS
commands, including syntax, operand description, and sample output, refer to the
Fabric OS
Command Reference
.
command
Commands are printed in bold.
--
option, option
Command options are printed in bold.
-
argument,
arg
Arguments.
[ ]
Optional element.
variable
Variables are printed in italics. In the help pages, values are underlined
or
enclosed in angled brackets < >.
...
Repeat the previous element, for example “member[;member...]”
value
Fixed values following arguments are printed in plain font. For example,
--
show
WWN
|
Boolean. Elements are exclusive. Example:
--
show
-
mode
egress | ingress