Linux shell命令帮助格式

2017-06-08  本文已影响15人  ifeelok0319

转载

没有任何修饰符参数 : 原生参数
<>  : 占位参数
[]  : 可选组合
()  : 必选组合
|   : 互斥参数
... : 可重复指定前一个参数
--  : 标记后续参数类型

原生参数

说明文档里的字符即为命令需要使用的字符
git reset
这种参数在使用时必需指定,且和说明文档里的一致

占位参数

表示方式: <>
和原生参数类似,都是必需指定的,只不过占位参数的实际字符是在使用时指定的,同时为了方便阅读会用一个描述词汇来表示,并以<>包围,比如
<paths>
表示路径,使用时可以指定为具体的路径,而paths只是起一个说明作用,有些帮助说明里也会用大写来表示占位参数,比如将以上参数说明写成PATHS

可选组合

表示方式: []
括号里的参数为可选参数,比如usage第二个里面的[-q],则-q为可选参数
可选项和占位参数也可以同时使用,如
[<commit>]
表示该参数可以指定某次提交,也可以不指定

必选组合

表示方式: ()
括号里的参数必需指定,通常里面会是一些互斥参数,比如
(--patch | -p)
表示--patch-p这两个参数必需指定一个

互斥参数

表示方式: |
互斥参数一般都在()[]里,表示该参数只能指定其中一个,比如
[--mixed | --soft | --hard | --merge | --keep]

重复参数

表示方式: ...
表示前一个参数可以被指定多个,比如
<paths>...
<paths>是一个占位参数,使用时必需指定为路径,...并表示可以指定多个路径。重复参数的一个典型使用场景就是移动文件,将多个文件移动到一个目录下,比如如下命令
git mv [<options>] <source>... <destination>
我们可以这样使用
git mv -f a.cpp b.py dir
此时options对应为-f参数,source对应为a.cpp b.py,destination对应为dir

标记后续参数类型

表示方式: --
表示后续参数的某种类型,比如这里如果使用如下命令
git reset -p -- xx
对比第一个命令,这里的xx对应的应该是<paths>参数,当我们指定--之后,则git会认为xx就是一个路径,那怕它是特殊符号或者路径并不存在。这是shell命令的一个通用方式,比如我们有一个文件名为-h,如果想删除这个文件,执行
rm -h
肯定是无法删除的,因为这时-h会被认为是rm的一个参数选项,应该使用
rm -- -h
这时shell会将-h解释为一个文件名传递给rm命令

上一篇下一篇

猜你喜欢

热点阅读