对技术提示和其他内容使用格式约定

简介

本文档介绍Cisco技术提示和内容中使用的文本、图像和命令约定的格式。

一般规则

必须遵循以下一般约定：

• 文本
• 警报和图标
• Cisco IOS®软件命令
• 配置示例
• IP地址（请在此处谨慎。）
• 代码块中的注释

文本

• 粗体表示用户必须输入或选择的文本，例如菜单项、按钮和命令。

• 斜体表示强调。

• 前尖括号(>)表示用户在图形用户界面(GUI)中必须选择的菜单选择的顺序，例如“文件”(File)>“打印”(Print)。

• Cisco设备的输出示例以Courier字体显示；例如（命令以粗体显示，请勿使用黑色以外的颜色）：

3524xl# show running-config
Building configuration...

Current configuration:

!
version 12.0
no service pad
service timestamps debug uptime
service timestamps log uptime
no service password-encryption
!

• 来自思科设备的系统错误消息以Courier字体显示；例如：

• 使用reload命令重新启动的路由器会显示System returned to ROM by reload消息。

警报消息和图标

注意：表示读者需要注意。注释包含有用的建议或文档未涵盖的材料的引用。建议您阅读本文中的任何说明。

提示：表示此信息可帮助您解决问题。提示信息不能作为故障排除信息或操作的建议方法，但可能是有用的信息。提示是可选的读数。

注意：表示读者要小心。在这种情况下，您的操作可能会导致设备损坏或数据丢失。必须阅读警告声明。

警告：警告意味着危险。在这种情况下，您的身体可能会受到伤害。在使用任何设备之前，您必须了解与电路相关的危险。您必须熟悉预防事故的标准实践。要查看警告的翻译版本，请参阅设备随附的合规性和安全文档。 您必须阅读警告声明。

退出图标  显示您即将退出思科网站。此图像显示在指向Cisco.com外部网站的链接末尾，并在单独的浏览器窗口中打开。 思科对其他网站的内容不承担任何责任。 

Cisco IOS®^软件命令

Cisco IOS命令的后续约定也用于命令参考指南中。有关Cisco IOS文档中的规则的详细信息，请参阅Cisco技术内容样式指南。 

• 竖线 ( |)单独的互斥替代参数。示例：req-qos {best-effort | controlled-load | guaranteed-delay}

• 方括号 ([]) 表示可选元素。示例： [no] ip route-cache [cbus]

• 大括号 ({ }) 表示必需的选项。示例：访问列表编号[{permit | deny}]

• 方括号中的大括号 ([{}]) 表示可选元素中的必需选项。

• 尖括号 (< >) 在不允许斜体的上下文中表示参数，并且在一些示例中表示用户输入的但不在屏幕上显示的字符串（例如，口令）。

• 粗体表示命令和关键字。

• 斜体表示用户变量。

配置示例

在配置示例中使用了通用路由器名称、主机名、用户名、口令和 IP 地址。这些密码必须替换为适合您公司的名称、密码和地址。

注意：请勿在配置中使用用户名cisco或密码cisco。使用cisco作为密码或用户名，或使用任何简单密码，存在安全风险。另请注意，建议不要在文章标题中包括Cisco。

• 路由器名称：RouterX、nasX等。

• 电话号码：555nnn

IP 地址

注意:IP地址符合RFC 1918专用网络地址的定义。请参阅下图。由于Cisco.com文章中公开的一个客户端IP地址，最近发生了漏洞。将IP地址包括在文章中的任何位置时，请谨慎判断。检查映像中是否存在可能违反此规则的IP地址。

Internet 地址分配机构 (IANA) 预留了三个 IP 地址块用于专用 Internet：

• 范围：10.0.0.0 - 10.255.255.255（10/8前缀）

• 范围：172.16.0.0 - 172.31.255.255（172.16/12前缀）

• 范围：192.168.0.0 - 192.168.255.255（192.168/16前缀）

IP地址参考

为公共文档保留的IP地址

代码块中的注释

通常会在配置示例中包括注释。注释以斜体显示。它们必须仅显示为黑色文本；颜色不可接受，除非它们出现在屏幕截图中。它们提供了有关配置输出和使用的命令的详细信息。显示的配置注释类似于以下内容：

!--- Define IPSec traffic of interest. 
!--- This line covers traffic between the LAN segment behind two PIXes. 
!--- It also covers the SNMP/syslog traffic between the SNMP/syslog server 
!--- and the network devices located on the Ethernet segment behind PIX 515.

access-list 101 permit ip 172.18.124.0 255.255.255.0 10.99.99.0 255.255.255.0 

注：建议您缩短编解码器锁示例，以便示例末尾不显示滑块。

相关信息

• RFC 1918
• 思科技术内容风格指南
• 思科技术支持和下载