前言

linux shell命令通常可以通過-h或--help來打印幫助說明，或者通過man命令來查看幫助，有時候我們也會給自己的程序?qū)懞唵蔚膸椭f明，其實幫助說明格式是有規(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ù)

說明文檔里的字符即為命令需要使用的字符，比如以上命令的

git reset

這種參數(shù)在使用時必需指定，且和說明文檔里的一致

占位參數(shù)

表示方式： <>

和原生參數(shù)類似，都是必需指定的，只不過占位參數(shù)的實際字符是在使用時指定的，同時為了方便閱讀會用一個描述詞匯來表示，并以<>包圍，比如

<paths>

表示路徑，使用時可以指定為具體的路徑，而paths只是起一個說明作用，有些幫助說明里也會用大寫來表示占位參數(shù)，比如將以上參數(shù)說明寫成PATHS

可選組合

表示方式：  []

括號里的參數(shù)為可選參數(shù)，比如usage第二個里面的[-q] ，則-q為可選參數(shù)

可選項和占位參數(shù)也可以同時使用，如

[<commit>]

表示該參數(shù)可以指定某次提交，也可以不指定

必選組合

表示方式:  ()

括號里的參數(shù)必需指定，通常里面會是一些互斥參數(shù)，比如

(--patch | -p)

表示--patch和-p這兩個參數(shù)必需指定一個

互斥參數(shù)

表示方式:  |

互斥參數(shù)一般都在()和[]里，表示該參數(shù)只能指定其中一個，比如

[--mixed | --soft | --hard | --merge | --keep]

重復(fù)參數(shù)

表示方式: ...

表示前一個參數(shù)可以被指定多個，比如

<paths>...

<paths>是一個占位參數(shù)，使用時必需指定為路徑，...并表示可以指定多個路徑。重復(fù)參數(shù)的一個典型使用場景就是移動文件，將多個文件移動到一個目錄下，比如如下命令

git mv [<options>] <source>... <destination>

我們可以這樣使用

git mv -f a.cpp b.py dir

此時options對應(yīng)為-f參數(shù)，source對應(yīng)為a.cpp b.py，destination對應(yīng)為dir

標(biāo)記后續(xù)參數(shù)類型

表示方式: