對技術提示和其他內容使用格式約定

簡介

本檔案介紹思科技術提示和內容中使用的文本、影象和命令慣例格式。

一般慣例

必須遵循以下一般慣例：

• 文字
• 警報和圖示
• Cisco IOS®軟體命令
• 組態範例
• IP地址（請在此處謹慎。）
• 代碼塊中的註釋

文字

• 粗體表示使用者必須輸入或選擇的文本，如選單項、按鈕和命令。

• 斜體表示強調。

• 前角括弧(>)表示使用者必須在圖形使用者介面(GUI)中選擇的選單選項的順序，如「檔案」(File)>「列印」(Print)。

• 思科裝置的輸出示例以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
!

• 來自Cisco裝置的系統錯誤消息以Courier字型顯示；例如：

• 使用reload命令重新啟動的路由器會顯示以重新載入方式返回到ROM的消息。

警報消息和圖示

註：表示讀者需要注意。註釋包含有用的建議或文檔未涵蓋的材料的引用。建議您閱讀本文中的任何說明。

提示：表示此資訊可幫助您解決問題。提示資訊不能作為資訊或操作的建議故障排除方法，但可能是有用的資訊。提示是可選的讀數。

注意：表示讀者要小心。在這種情況下，您的操作可能會導致裝置損壞或資料丟失。必須閱讀警告宣告。

警告：警告意味著危險。你現在的處境可能導致身體傷害。在使用任何裝置之前，您必須瞭解與電路相關的危險。您必須熟悉事故預防的標準方法。要檢視該警告的翻譯版本，請參閱裝置附帶的合規性和安全文檔。 您必須閱讀警告宣告。

退出圖示  顯示您即將退出思科網站。此影象顯示在指向Cisco.com外部網站的連結末尾，並在單獨的瀏覽器視窗中開啟。 思科對其他網站的內容不承擔責任。 

Cisco IOS®^軟體命令

Cisco IOS命令的後續約定也用於命令參考指南中。有關Cisco IOS文檔中慣例的詳細資訊，請參閱思科技術內容樣式指南。 

• 豎線( |)獨立的可替代的、互斥的引數。示例： req-qos {best-effort | controlled-load | guaranteed-delay}

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

• 大括弧({ })表示所需的選擇。示例： access-list number [{permit | deny}]

• 方括弧([{ }])中的大括弧表示可選元素中的必需選項。

• 尖括弧(< >)表示不允許使用斜體的上下文中的引數，而在示例中表示使用者輸入的不會顯示在螢幕上的字串（例如密碼）。

• 粗體表示命令和關鍵字。

• 斜體表示使用者變數。

組態範例

配置示例中使用的是通用路由器名稱、主機名、使用者名稱、口令和IP地址。這些密碼必須替換為適合貴公司的名稱、密碼和地址。

注意：請勿在配置中使用使用者名稱cisco或密碼cisco。使用cisco作為密碼或使用者名稱，或使用任何簡單密碼，存在安全風險。另請注意，建議不要在文章標題中包括Cisco。

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

• 電話號碼：555nnnn

IP地址

注意:IP地址符合RFC 1918專用網路地址定義。請參見下面的影象。由於Cisco.com文章中公開的客戶端IP地址，最近發生了入侵事件。當您在文章中的任何位置包含IP地址時，請謹慎判斷。檢查映像中是否存在可能違反此規則的IP地址。

Internet編號指派機構(IANA)為專用網保留了三個地址塊：

• 範圍：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
• 思科技術內容風格指南
• 思科技術支援與下載