时间:2021-05-22
前言
linux shell命令通常可以通过-h或--help来打印帮助说明,或者通过man命令来查看帮助,有时候我们也会给自己的程序写简单的帮助说明,其实帮助说明格式是有规律可循的
帮助示例
下面是git reset命令的帮助说明,通过man git-reset可以查看
git reset [-q] [<tree-ish>] [--] <paths>...git reset (--patch | -p) [<tree-ish>] [--] [<paths>...]git reset [--soft | --mixed | --hard | --merge | --keep] [-q] [<commit>]对于命令和参数大致有如下几种类型
下面来一一介绍
参数类型解读
原生参数
说明文档里的字符即为命令需要使用的字符,比如以上命令的
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命令
解读实战
最后来解释一个比较复杂的帮助说明
git cat-file (-t [--allow-unknown-type]|-s [--allow-unknown-type]|-e|-p|<type>|--textconv) <object>该命令参数由四个部分,其中git和cat-file为原生参数,()里的为可选组合, <object>为占位参数
组合又由6部分组成,为互斥关系
-t [--allow-unknown-type]-s [--allow-unknown-type]-e-p<type>--textconv因此该命令的帮助说明可以拆分如下
git cat-file -t <object>git cat-file -t --allow-unknown-type <object>git cat-file -s <object>git cat-file -s --allow-unknown-type <object>git cat-file -e <object>git cat-file -p <object>git cat-file <type> <object>git cat-file --textconv <object>总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流。
声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。
Linux在Shell脚本中使用函数实例详解Shell的函数Shell程序也支持函数。函数能完成一特定的功能,可以重复调用这个函数。函数格式如下:函数名(){函
-h或者--help帮助命令的使用详解查看shell内置命令的帮助,可以使用-h或者--help复制代码代码如下:#wget--help或者为了方便查看,和le
linux下执行shell命令有两种方法在当前shell中执行shell命令在当前shell中产生一个subshell,在subshell中执行shell命令1
每一条Shell命令,不管是Bash内置命令(例如cd、echo),还是外部的Linux命令(例如ls、awk),还是自定义的Shell函数,当它退出(运行结束
详解Linux文本文件与WIN文本文件换行格式转换命令前言:有时在WIN下编辑好的脚本文件上传到LINUX服务器中不能正常执行,开始误认为是LINUX配置问题,