Table of Contents

About This Manual

About This Manual

This section discusses the objectives, audience, organization, and conventions of the Router Products Command Reference publication.

Document Objectives

This publication provides an in-depth description of the commands necessary for configuring and maintaining your router. It describes tasks only in the context of using a particular command; it does not describe how the tasks interrelate or provide comprehensive configuration examples.You can use this publication as a standalone reference manual or in conjunction with the Router Products Configuration Guide. Not all of the debug commands are included in this publication, but you can find all of them in the Debug Command Reference publication.

How To Use This Manual

Use the Router Products Command Reference to do the following:


This publication is intended as a standalone document for experienced network administrators who will be configuring and maintaining routers and would like to reference commands. For less-experienced users who need to understand the tasks as well as the commands, it is intended as a companion guide to the Router Products Configuration Guide.

Document Organization

This publication is divided into six main parts. Each part comprises chapters describing related tasks or functions. The organization of parts and chapters in this publication matches the organization of parts and chapters in the Router Products Configuration Guide, except that this document contains appendixes. The parts in this publication are as follows:

The appendixes contain a list of references and recommended reading, Ethernet type codes, regular expressions, a table of the ASCII character set, switching information, and a description of IOS 11.0 features supported by specific router platforms.

Document Conventions

Software and hardware documentation uses the following conventions:

For example, the key combinations ^D and Ctrl-D are equivalent: Both mean hold down the Control key while you press the D key. Keys are indicated in capitals, but are not case sensitive.
For example, when setting an SNMP community string to "public," do not use quotation marks around the string; otherwise, the string will include the quotation marks.

Command descriptions use these conventions:

Examples use these conventions:

Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Note Means reader take note. Notes contain helpful suggestions or references to materials not contained in this manual.

The following illustration explains the fields of a typical command reference page.

Copyright 1989-1997 © Cisco Systems Inc.