前言
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>
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流。
免责声明:本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除!
《魔兽世界》大逃杀!60人新游玩模式《强袭风暴》3月21日上线
暴雪近日发布了《魔兽世界》10.2.6 更新内容,新游玩模式《强袭风暴》即将于3月21 日在亚服上线,届时玩家将前往阿拉希高地展开一场 60 人大逃杀对战。
艾泽拉斯的冒险者已经征服了艾泽拉斯的大地及遥远的彼岸。他们在对抗世界上最致命的敌人时展现出过人的手腕,并且成功阻止终结宇宙等级的威胁。当他们在为即将于《魔兽世界》资料片《地心之战》中来袭的萨拉塔斯势力做战斗准备时,他们还需要在熟悉的阿拉希高地面对一个全新的敌人──那就是彼此。在《巨龙崛起》10.2.6 更新的《强袭风暴》中,玩家将会进入一个全新的海盗主题大逃杀式限时活动,其中包含极高的风险和史诗级的奖励。
《强袭风暴》不是普通的战场,作为一个独立于主游戏之外的活动,玩家可以用大逃杀的风格来体验《魔兽世界》,不分职业、不分装备(除了你在赛局中捡到的),光是技巧和战略的强弱之分就能决定出谁才是能坚持到最后的赢家。本次活动将会开放单人和双人模式,玩家在加入海盗主题的预赛大厅区域前,可以从强袭风暴角色画面新增好友。游玩游戏将可以累计名望轨迹,《巨龙崛起》和《魔兽世界:巫妖王之怒 经典版》的玩家都可以获得奖励。
更新日志
- 凤飞飞《我们的主题曲》飞跃制作[正版原抓WAV+CUE]
- 刘嘉亮《亮情歌2》[WAV+CUE][1G]
- 红馆40·谭咏麟《歌者恋歌浓情30年演唱会》3CD[低速原抓WAV+CUE][1.8G]
- 刘纬武《睡眠宝宝竖琴童谣 吉卜力工作室 白噪音安抚》[320K/MP3][193.25MB]
- 【轻音乐】曼托凡尼乐团《精选辑》2CD.1998[FLAC+CUE整轨]
- 邝美云《心中有爱》1989年香港DMIJP版1MTO东芝首版[WAV+CUE]
- 群星《情叹-发烧女声DSD》天籁女声发烧碟[WAV+CUE]
- 刘纬武《睡眠宝宝竖琴童谣 吉卜力工作室 白噪音安抚》[FLAC/分轨][748.03MB]
- 理想混蛋《Origin Sessions》[320K/MP3][37.47MB]
- 公馆青少年《我其实一点都不酷》[320K/MP3][78.78MB]
- 群星《情叹-发烧男声DSD》最值得珍藏的完美男声[WAV+CUE]
- 群星《国韵飘香·贵妃醉酒HQCD黑胶王》2CD[WAV]
- 卫兰《DAUGHTER》【低速原抓WAV+CUE】
- 公馆青少年《我其实一点都不酷》[FLAC/分轨][398.22MB]
- ZWEI《迟暮的花 (Explicit)》[320K/MP3][57.16MB]