Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Documentation Conventions

These sections describe the notice icons and text and syntax conventions used in the documentation.

Notice Icons

We use the following notice icons in documentation:

Note:

You might find this information helpful in a particular situation, or you might overlook this important information if it was not highlighted in a Note.
CAUTION:

You need to observe the specified guidelines to prevent minor injury or discomfort to you or severe damage to the device.
Warning:

This symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry, and familiarize yourself with standard practices for preventing accidents.
Laser Warning:

This symbol alerts you to the risk of personal injury from a laser.
Tip:

Indicates helpful information.
Best Practice:

Alerts you to a recommended use or implementation.

Text and Syntax Conventions

We use the following text and syntax conventions in documentation:

Convention Description Examples

Bold text like this

Represents text that you type.

To enter configuration mode, type the configure command: 

user@host> configure

Italic text like this

  • Introduces or emphasizes important new terms.

  • Identifies guide names.

  • Identifies RFC and Internet draft titles.

  • A policy term is a named structure that defines match conditions and actions.

  • Junos OS CLI User Guide

  • RFC 1997, BGP Communities Attribute

Italic text like this

Represents variables (options for which you substitute a value) in commands or configuration statements.

  • Configure the machine's domain name:

    [edit]
root@# set system domain-name domain-name

  • For the loops number statement, you can configure 1 through 10.

Text like this

Represents names of configuration statements, commands, files, directories, and configuration hierarchy levels.

To configure a stub area, include the stub statement at the [edit protocols ospf area area-id] hierarchy level.

< > (angle brackets)

Encloses optional keywords or variables.

 stub <default-metric metric>;

| (pipe symbol)

Indicates a choice between the mutually exclusive keywords or variables on either side of the symbol. The set of choices is often enclosed in parentheses for clarity.

  • broadcast | multicast

  • (string1 | string2 | string3)

[ ] (square brackets)

Encloses a variable for which you can substitute one or more values.

community name members [ community-ids ]

CLI Conventions

> (right angle bracket)

Indicates that you are in operational mode. 

user@R1> show version

# (pound sign)

  • Indicates that you are in configuration mode.

  • Indicates a comment specified on the same line as the configuration statement to which it applies.

 
  • user@R1# set type external

  • rsvp { # Required for dynamic MPLS only

[ ] (square brackets)

Identifies where you are in the configuration hierarchy.

 
[edit routing-options]
static {
   route default {
      nexthop address;
      retain;
   }
}

Indention and braces ( { } )

Identifies a level in the configuration hierarchy.

; (semicolon)

Identifies a leaf statement at a configuration hierarchy level.

 
Fixed-width text like this

Represents output that appears on the terminal screen.

 
user@host> show chassis alarms
No alarms currently active.

GUI and Hardware Label Conventions

Bold text like this

Represents graphical user interface (GUI) items you click or select or labels on hardware components.

  • In the Logical Interfaces box, select All Interfaces.

  • To cancel the configuration, click Cancel.

  • The console port is labeled CONSOLE.

> (bold right angle bracket)

Separates levels in a hierarchy of GUI menu selections.

In the configuration editor hierarchy, select Protocols > OSPF.