This section discusses the objectives, audience, organization, and conventions of the Communication Server Command Reference publication.
This publication provides an in-depth description of the commands necessary for configuring and maintaining your communcation server. 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. It can be used as a standalone reference manual or in conjunction with the Communication Server Configuration Guide.
See the Communication Server and Protocol Translator Connection Guide for information about making connections to communication servers.
This publication is intended as a standalone document for experienced users who will be configuring and maintaining communication server and just need 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 Communication Server Configuration Guide.
This publication is divided into seven main parts and appendixes. 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 Communication Server Configuration Guide, except that this document contains appendixes. The parts in this publication are as follows:
- Part 1, "Product Introduction," provides an overview of communication server functionality and hardware configuration options, and introduces you to the communication server user interface.
- Part 2, "System & Interface Configuration & Management," describes commands used to perform basic system and interface configuration, monitoring, and management tasks.
- Part 3, "Wide-Area Networking," describes commands used to configure dial-on-demand routing (DDR), X.25, SMDS, and Frame Relay WAN software.
- Part 4, "Terminal Services,"describes commands used to configure your communication server for terminal connections and terminal services, including Telnet, LAT, and TN3270.
- Part 5, "Telecommuting Services," describes commands used to configure your communication server to support telecommuting services, including SLIP, PPP, and XRemote.
- Part 6, "Routing Services," describes commands used to configure and manage the IP and IPX protocols for routing.
- Part 7, "Protocol Translation," describes commands used to configure your communication server to support protocol translation.
- "Appendixes" contains three appendixes including the ASCII character set, pattern matching, and a list of references and recommended reading.
Software and hardware documentation uses the following conventions:
- The symbol ^ represents the key labeled Control.
- For example, the key combination ^D means hold down the Control key while you press the
D key.
- A string is defined as a nonquoted set of characters. For example, when setting up a community string for SNMP to "public," do not use quotes around the string, or the string will include the quotation marks.
Command descriptions use these conventions:
- Commands and keywords are in boldface font.
- Arguments for which you supply values are in italic font.
- Elements in square brackets ([ ]) are optional.
- Alternative but required keywords are grouped in braces ({ }) and separated by vertical bars (|).
Examples use these conventions:
- Examples that contain system prompts denote interactive sessions, indicating that the user enters commands at the prompt. The system prompt indicates the current command mode. For example, the prompt
router(config)# indicates global configuration mode.
- Terminal sessions and information the system displays are in
screen font.
- Information you enter is in
boldface screen font.
- Nonprinting characters, such as passwords, are in angle brackets (< >).
- Default responses to system prompts are in square brackets ([ ]).
- Exclamation points (!) at the beginning of a line indicate a comment line.
 | Caution Means reader be careful. You are capable of doing something that might 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 fileds on a typical command reference page:
