Documentation Conventions

This section contains the following information:

• General Conventions
• Conventions for Software Commands and Statements
• User Interface Elements

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:

    > 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>; 

• 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;

        }

    }

}

User Interface Elements

When describing dialog box elements, this manual uses the following terminology:

• Check box—A square box within a dialog box that you can select or clear to turn an option on or off.
• Command button—A rectangular button that starts an operation. A command button with ellipsis (. . .) means that another dialog box will appear with additional information that you must select before the operation can be completed.
• Dialog box—A software user interface element that contains buttons and other elements to let you provide the information required to perform an operation.
• Display box—A type of dialog box that displays the contents of a file or the differences between the contents of two files.
• Display field—An area in a dialog box that displays information necessary to perform a an operation or a command.
• Drop-down list box—A closed version of a list box with a down arrow. Click the down arrow to display the list items.
• Text box—An area within a dialog box where you can type text or numbers required to perform an operation or a command.
• Option button—A round button that lets you select one item from a group of items. You can select only one button from a group of option buttons.
• Table—Items of information that are arranged by rows and columns.
• Window—The software user interface display area or page layout. A window can be divided into panes or boxes to display different information.
• Wizard—A series of dialog boxes that enable you to complete a process. For instance, the agenda wizard in MS Word will prompt you to fill in the blanks until your agenda is complete.