HP 8/80 Access Gateway Administrator's Guide (53-1001760-01, June 2010) - Page 15

Document conventions, Text formatting, Command syntax conventions, Notes, cautions, and warnings

Page 15 highlights

Document conventions This section describes text formatting conventions and important notices formats. Text formatting The narrative-text formatting conventions that are used in this document 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 syntax examples 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. Command syntax conventions 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 Notes, cautions, and warnings The following notices appear in this document. NOTE A note provides a tip, emphasizes important information, or provides a reference to related information. Access Gateway Administrator's Guide xv 553-1001760-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

Access Gateway Administrator’s Guide
xv
553-1001760-01
Document conventions
This section describes text formatting conventions and important notices formats.
Text formatting
The narrative-text formatting conventions that are used in this document 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 syntax examples
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.
Command syntax conventions
Command syntax in this manual follows these conventions:
Notes, cautions, and warnings
The following notices appear in this document.
NOTE
A note provides a tip, emphasizes important information, or provides a reference to related
information.
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