语法图
语法图使用一些符号来表示命令元素和指定这些元素的使用规则。
表 1 说明如何阅读表示命令行界面 (CLI) 命令的语法图。在此过程中,它定义了表示 CLI 命令元素的符号。
| 元素 | 语法 | 描述 |
|---|---|---|
| 主路径行 | >>><>() () () | 主路径行在左侧以双箭头开头:>>。主路径行在右侧以两个相对的箭头结尾:><。如果图的长度超过一行,那么要继续的每行都以单个箭头结尾,并且下一行以单个箭头开头:>沿着主路径行从左向右、从上向下阅读图。 |
| 关键字 | 表示命令、标志、参数或自变量的名称。关键字不采用斜体。关键字的拼写要完全与语法图中显示的一样。 | |
| 必需关键字 | 表明必须为命令指定的参数或自变量。必须将必需关键字写在主路径行上。不能一起使用的必需关键字采用垂直排列方式。 | |
| 可选关键字 | 表明可以选择为命令指定的参数或自变量。必须将可选关键字写到主路径行的下方。互斥的可选关键字将垂直堆叠。 | |
| 缺省值 | 必须将缺省值写在主路径行上方。 | |
| 可重复的关键字或值 | 表示可以多次指定的参数或自变量。可重复的关键字或值由关键字或值上方向左的箭头表示。 | |
| 变量 | 表示您需要为参数或自变量提供的值,如文件名、用户名或密码。变量采用斜体。 | |
| 空格分隔符 | 在主路径行上添加空白,以将关键字、参数、自变量或变量彼此分隔。 | |
| 引号定界符 | 指示包含多个值的参数或自变量的开头或结尾。针对特定参数或自变量的一个或多个名称/值对用一组双引号括起来。如果参数值或名称/值对包含空白或空格,那么用一组单引号将整个值括起来。 | |
| 等号运算符 | 将名称/值对中的名称与其值隔开。 | |
| 语法分段 | 分解太长、太复杂或重复的语法图。在主图中插入片段名称,并在主图下显示实际的片段。 |
