本文遵守CLI开发指引中的语法约定,以命令TP-LINK(config) ip address {ip-addr} {mask} [gateway]为例:
- 命令关键字(命令中固定不变,必须原样输入的部分)以粗体方式出现。主要有两种情况:一种是命令节点(如ip和address);另一种是absolute类型的参数。下面另作介绍。
- 参数:变量以斜体出现,如ip-addr、mask和gateway。常量以正体出现(如枚举量)。
- 在中括号 [ ] 中的任何内容是可选的,如gateway可以给定也可以不给定。
- 模式 [ ]* 表示括号的内容可以出现多次。
- 在大括号 { } 中的任何内容是必选的,如ip-addr和mask必须给定。
- 如果选项不止一个,则使用竖线 “|”分隔每个选项。例如:speed {10|100|1000} 表示speed有三个选项:10、100、1000,三者选其一。
从上面也可以看出,一条CLI命令主要由命令节点和参数组成。