beautypg.com

Document conventions, Document advisories – Lucent Technologies Network Access Module User Manual

Page 14

background image

Document Conventions

xiv

INA Module Installation and Configuration Guide

Document Conventions

The following conventions are used in this guide:

Document Advisories

Note – means take note. Notes contain information of importance or special interest.

Caution – means be careful. You might do something—or fail to do something—that
results in equipment failure or loss of data.

Warning – means danger. You might do something—or fail to do something—that
results in personal injury or equipment damage.

Convention

Use

Examples

Bold font

Indicates a user
entry—a
command, menu
option, button, or
key—or the name
of a file, directory,
or utility, except
in code samples.

• Enter version to display the version

number.

• Press Enter.

• Open the permit_list file.

Italic font

Identifies a
command-line
placeholder.
Replace with a
real name or
value.

set Ether0 address Ipaddress

• Replace Area with the name of the

OSPF area.

Square brackets ([ ])

Enclose optional
keywords and
values in
command syntax.

set nameserver [2] Ipaddress

set S0 destination Ipaddress

[Ipmask]

Curly braces ({ })

Enclose a
required choice
between
keywords and/or
values in
command syntax.

set syslog Logtype {[disabled]
[Facility.Priority]}

Vertical bar (|)

Separates two or
more possible
options in
command syntax.

set S0|W1 ospf on|off

set S0 host

default|prompt|Ipaddress

!