Manual Part Organization

The parts in this manual typically contain the following chapters:

• Overview—Provides background information about and discusses concepts related to the software component described in the following chapters. For example, in the system management part, the overview chapter provides brief background information and concepts related to system management.
• Configuration statements—Lists all the configuration statements available to configure the software component. This list is designed to provide an overview of the configuration statement hierarchy for that software component.
• Configuration guidelines—Describes how to configure all the features of the software component. The first section of the configuration guidelines describes the minimum configuration for that component, listing the configuration statements you must include to enable the software component on the router with only the bare minimum functionality. The remaining sections in the configuration guidelines are generally arranged so that the most common features are near the beginning.
• Statement summary—A reference section that lists all configuration statements alphabetically and explains each statement and all its options. The explanation of each configuration statement consists of the following parts:
  • Syntax—Describes the full syntax of the configuration statement. For an explanation of how to read the syntax statements, see Documentation Conventions.
  • Hierarchy level—Tells where in the configuration statement hierarchy you include the statement.
  • Description—Describes the function of the configuration statement.
  • Options—Describes the configuration statement's options if there are any. For options with numeric values, the allowed range and default value, if any, are listed. For multiple options, if one option is the default, that fact is stated. If a configuration statement is at the top of a hierarchy of options that are other configuration statements, these options are generally explained separately in the statement summary section.
  • Usage guidelines—Points to the section or sections in the configuration guidelines section that describes how to use the configuration statement.
  • Required privilege level—Indicates the permissions that the user must have to view or modify the statement in the router configuration. For an explanation of the permissions, see Table 7.
  • See also—Indicates other configuration statements that might provide related or similar functionality.