Documentation Conventions

This section presents general text conventions used for statements, commands, and output. Also included are the details for providing documentation feedback and for contacting technical support.

General Conventions

This manual uses the following text conventions:

• Statements, commands, filenames, directory names, IP addresses, and configuration hierarchy levels are shown in a sans serif font. In the following example, stub is a statement name and [edit protocols ospf area area-id] is a configuration hierarchy level:

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

• In examples, text that you type literally is shown in bold. In the following example, you type the word show:

[edit protocols ospf area area-id]

cli# show

stub <default-metric metric>

• Examples of command output are generally shown in a fixed-width font to preserve the column alignment. For example:

    user@host> show interfaces terse

    Interface       Admin Link Proto Local             Remote

    at-1/3/0        up    up

    at-1/3/0.0      up    up   inet  1.0.0.1           --> 1.0.0.2

                              iso

    fxp0            up    up

    fxp0.0          up    up   inet  192.168.5.59/24

Conventions for Software Commands and Statements

When describing the JUNOS software, this manual uses the following type and presentation conventions:

• Statement or command names that you type literally are shown nonitalicized. In the following example, the statement name is area:

You configure all these routers by including the following area statement at the [edit protocols ospf] hierarchy level:

• Options, which are variable terms for which you substitute appropriate values, are shown in italics. In the following example, area-id is an option. When you type the area statement, you substitute a value for area-id.

area area-id;

• Optional portions of a configuration statement are enclosed in angle brackets. In the following example, the "default-metric metric" portion of the statement is optional:

stub <default-metric metric>; 

• For text strings separated by a pipe ( | ), you must specify either string1 or string2, but you cannot specify both or neither of them. Parentheses are sometimes used to group the strings.

string1 | string2

(string1 | string2) 

In the following example, you must specify either broadcast or multicast, but you cannot specify both:

broadcast | multicast

• For some statements, you can specify a set of values. The set must be enclosed in square brackets. For example:

community name members [ community-ids ] 

• The configuration examples in this manual are generally formatted in the way that they appear when you issue a show command. This format includes braces ({ }) and semicolons. When you type configuration statements in the CLI, you do not type the braces and semicolons. However, when you type configuration statements in an ASCII file, you must include the braces and semicolons. For example:

[edit]

cli# set routing-options static route default nexthop address retain

[edit]

cli# show

routing-options {

    static {

        route default {

            nexthop address;

            retain;

        }

    }

}

• Comments in the configuration examples are shown either preceding the lines that the comments apply to, or more often, they appear on the same line. When comments appear on the same line, they are preceded by a pound sign (#) to indicate where the comment starts. In an actual configuration, comments can only precede a line; they cannot be on the same line as a configuration statement. For example:

protocols {

    mpls { 

        interface (interface-name | all);                                                    # Required to enable MPLS on the 
interface

    }

    rsvp {                                                        # Required for dynamic MPLS only

        interface interface-name;

    }

}

• The general syntax descriptions provide no indication of the number of times you can specify a statement, option, or keyword. This information is provided in the text of the statement summary.