Documentation Conventions

Table 1 defines the notice icons used in this guide. Table 2 defines text conventions used throughout this documentation.

Table 1: Notice Icons

Icon

Meaning

Description

Informational note

Indicates important features or instructions.

Caution

Indicates a situation that might result in loss of data or hardware damage.

Warning

Alerts you to the risk of personal injury or death.

Laser warning

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.

Table 2: Text Conventions

ConventionDescriptionExamples

Bold text like this

  • Represents keywords, scripts, and tools in text.
  • Represents a GUI element that the user selects, clicks, checks, or clears.
  • Specify the keyword exp-msg.
  • Run the install.sh script.
  • Use the pkgadd tool.
  • To cancel the configuration, click Cancel.

Bold text like this

Represents text that the user must type.

user@host# set cache-entry-age cache-entry-age

Fixed-width text like this

Represents information as displayed on your terminal’s screen, such as CLI commands in output displays.

nic-locators {
   login {
      resolution {
         resolver-name /realms/
login/A1; key-type LoginName; value-type SaeId; }

Regular sans serif typeface

  • Represents configuration statements.
  • Indicates SRC CLI commands and options in text.
  • Represents examples in procedures.
  • Represents URLs.
  • system ldap server{
    stand-alone;
  • Use the request sae modify device failover command with the force option
  • user@host# . . .
  • https://www.juniper.net/techpubs/software/ management/src/api-index.html

Italic sans serif typeface

Represents variables in SRC CLI commands.

user@host# set local-address local-address

Angle brackets

In text descriptions, indicate optional keywords or variables.

Another runtime variable is <gfwif>.

Key name

Indicates the name of a key on the keyboard.

Press Enter.

Key names linked with a plus sign (+)

Indicates that you must press two or more keys simultaneously.

Press Ctrl + b.

Italic typeface

  • Emphasizes words.
  • Identifies book names.
  • Identifies distinguished names.
  • Identifies files, directories, and paths in text but not in command examples.
  • There are two levels of access: user and privileged.
  • SRC PE Getting Started Guide
  • o=Users, o=UMC
  • The /etc/default.properties file.

Backslash

At the end of a line, indicates that the text wraps to the next line.

Plugin.radiusAcct-1.class=\ net.juniper.smgt.sae.plugin\ RadiusTrackingPluginEvent

Words separated by the | symbol

Represent a choice to select one keyword or variable to the left or right of this symbol. (The keyword or variable may be either optional or required.)

diagnostic | line