更新时间:2024-12-10 GMT+08:00
分享

文档约定

本节描述了本手册的内容、符号、和命令约定。

内容约定

所购买的产品、服务和特性以所签订的合同为准。本文档中描述的所有或部分的产品、服务和特性可不属于购买范围或使用范围。除非合同中另有约定,本文档中的所有陈述、信息和建议皆以“现状”的形式提供,不构成任何明示或暗示的担保、保证或陈述。

符号约定

在本文中可能出现下列标志,它们所代表的含义如下。

符号

说明

用于警示紧急的危险情形,若不避免,将会导致人员死亡或严重的人身伤害。

用于警示潜在的危险情形,若不避免,可能会导致人员死亡或严重的人身伤害。

用于警示潜在的危险情形,若不避免,可能会导致中度或轻微的人身伤害。

用于传递设备或环境安全警示信息,若不避免,可能会导致设备损坏、数据丢失、设备性能降低或其它不可预知的结果。

“注意”不涉及人身伤害。

用于突出重要/关键信息、最佳实践和小窍门等。

“说明”不是安全警示信息,不涉及人身、设备及环境伤害。

命令行格式约定

本手册中可能出现下列命令行格式约定,它们所代表的含义如下:

表1 命令行格式列表

格式

说明

粗体

命令行关键字(命令中保持不变、必须照输的部分)采用加粗字体表示。

斜体

命令行参数,路径,文件或文件夹采用斜体表示。

[ ]

表示用“[ ]”括起来的部分(关键词和参数)在命令配置时是可选的。

{ x | y | ... }

表示用“{}”分组选项,各选项之间以“|”分隔。从两个或多个选项中选取一个。

[ x | y | ... ]

表示用“[ ]”分组选项,各选项之间以“|”分隔。从两个或多个选项中选取一个或者不选。

{ x | y | ... }*

表示用“{}”分组选项,各选项之间以“|”分隔。从两个或多个选项中选取多个,最少选取一个,最多选取所有选项。

[ x | y | ... ]*

表示用“[ ]”分组选项,各选项之间以“|”分隔。从两个或多个选项中选取多个或者不选。

&<1-n>

表示&符号前的内容可重复1到n次。

#

表示注释。

相关文档