前言
linux shell命令通常可以通過-h
或--help
來打印幫助說明,或者通過man
命令來查看幫助,有時(shí)候我們也會給自己的程序?qū)懞唵蔚膸椭f明,其實(shí)幫助說明格式是有規(guī)律可循的
幫助示例
下面是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>]
對于命令和參數(shù)大致有如下幾種類型
- 沒有任何修飾符參數(shù) : 原生參數(shù)
- > : 占位參數(shù)
- [] : 可選組合
- () : 必選組合
- | : 互斥參數(shù)
- ... : 可重復(fù)指定前一個(gè)參數(shù)
- -- : 標(biāo)記后續(xù)參數(shù)類型
下面來一一介紹
參數(shù)類型解讀
原生參數(shù)
說明文檔里的字符即為命令需要使用的字符,比如以上命令的
這種參數(shù)在使用時(shí)必需指定,且和說明文檔里的一致
占位參數(shù)
表示方式: >
和原生參數(shù)類似,都是必需指定的,只不過占位參數(shù)的實(shí)際字符是在使用時(shí)指定的,同時(shí)為了方便閱讀會用一個(gè)描述詞匯來表示,并以>
包圍,比如
表示路徑,使用時(shí)可以指定為具體的路徑,而paths
只是起一個(gè)說明作用,有些幫助說明里也會用大寫來表示占位參數(shù),比如將以上參數(shù)說明寫成PATHS
可選組合
表示方式: []
括號里的參數(shù)為可選參數(shù),比如usage
第二個(gè)里面的[-q]
,則-q
為可選參數(shù)
可選項(xiàng)和占位參數(shù)也可以同時(shí)使用,如
表示該參數(shù)可以指定某次提交,也可以不指定
必選組合
表示方式: ()
括號里的參數(shù)必需指定,通常里面會是一些互斥參數(shù),比如
表示--patch
和-p
這兩個(gè)參數(shù)必需指定一個(gè)
互斥參數(shù)
表示方式: |
互斥參數(shù)一般都在()
和[]
里,表示該參數(shù)只能指定其中一個(gè),比如
[--mixed | --soft | --hard | --merge | --keep]
重復(fù)參數(shù)
表示方式: ...
表示前一個(gè)參數(shù)可以被指定多個(gè),比如
paths>
是一個(gè)占位參數(shù),使用時(shí)必需指定為路徑,...并表示可以指定多個(gè)路徑。重復(fù)參數(shù)的一個(gè)典型使用場景就是移動文件,將多個(gè)文件移動到一個(gè)目錄下,比如如下命令
git mv [options>] source>... destination>
我們可以這樣使用
此時(shí)options對應(yīng)為-f
參數(shù),source對應(yīng)為a.cpp b.py
,destination對應(yīng)為dir
標(biāo)記后續(xù)參數(shù)類型
表示方式: --
表示后續(xù)參數(shù)的某種類型,比如這里如果使用如下命令
對比第一個(gè)命令,這里的xx對應(yīng)的應(yīng)該是paths>
參數(shù),當(dāng)我們指定--
之后,則git會認(rèn)為xx就是一個(gè)路徑,那怕它是特殊符號或者路徑并不存在。這是shell命令的一個(gè)通用方式,比如我們有一個(gè)文件名為-h
,如果想刪除這個(gè)文件,執(zhí)行
肯定是無法刪除的,因?yàn)檫@時(shí)-h會被認(rèn)為是rm的一個(gè)參數(shù)選項(xiàng),應(yīng)該使用
這時(shí)shell會將-h
解釋為一個(gè)文件名傳遞給rm
命令
解讀實(shí)戰(zhàn)
最后來解釋一個(gè)比較復(fù)雜的幫助說明
git cat-file (-t [--allow-unknown-type]|-s [--allow-unknown-type]|-e|-p|type>|--textconv) object>
該命令參數(shù)由四個(gè)部分,其中git
和cat-file
為原生參數(shù),()
里的為可選組合, object>
為占位參數(shù)
組合又由6部分組成,為互斥關(guān)系
-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>
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作能帶來一定的幫助,如果有疑問大家可以留言交流。
您可能感興趣的文章:- linux touch,chattr指令詳解及用法
- php在linux中可能用到的命令(推薦)
- 詳解Linux命令修改文件的三個(gè)時(shí)間
- Linux C字符串替換函數(shù)實(shí)例詳解
- linux 詳解useradd 命令基本用法
- Linux shell tr 命令詳解
- 淺談Linux 腳本 sh 和 ./ 的區(qū)別
- Linux監(jiān)視進(jìn)程之ps命令詳解
- linux指令man page之rm,mv詳解