Standard 命令行格式规范

发表于 | 分类于
字数统计:

命令行接口(Command Line Interface)的表示格式、选项格式及参数格式。

字符及格式说明

 
说明
空格(Space)
含义
分隔命令、选项、参数等

-
说明
减号(Minus sign)或者说连字符(Hyphen)
含义
表示选项,单字符缩写
连接短语

--
说明
连续两个连字符-
含义
表示选项,完整长选项

=
说明
等号(Equals sign)
含义
指定参数

[]
说明
中括号或者说方括号(Square brackets)
含义
表示数组、多项，占位提示，用于说明介绍

B
说明
加粗(Bold)
含义
表示固定及强调

I
说明
斜体(Italic)
含义
表示可变

命令行接口说明

样例

[command]
[command] [options]
[command] [arguments]
[command] [options] [arguments]
[command] [options]=[arguments]

含义

command 命令，加粗(可选)
options 选项，斜体(可选)
arguments 参数,斜体(可选)

命令举例

示例

1
2
3
4
5
6
 
cmmd
cmmd -h
cmmd /path/file.suffix
cmmd -xcvf /path/file.suffix
cmmd --help all
cmmd --help=all --color=auto

说明

cmmd 命令
-h 选项，缩写
/path/file.suffix 参数，示例内容为路径
-xcvf 选项，缩写，多条选项(-x -c -v -f)连写
--help 选项，完整
all 参数
--help=all 选项及值

0%