Man

在手冊頁中記錄可變長度選項的正確方法

  • May 12, 2014

有時我會看到使用資訊,例如

some_utility [arg [arg [...]]]

或者

some_utility [arg[, arg[...]]]

這表明您可以傳遞多個相同的參數。

我也看過像

some_utility [args]

或者

some_utility [arg][, arg][...]

有沒有標準的方法來做到這一點?

不,不是真的,但大多數時候它是相當一致的。大多數手冊會列出帶有方括號 ( [foo]) 的可選參數,帶有尖括號或根本不帶括號的強制性參數(<bar>, baz,後一個經常加下劃線)。

此外,在幾乎所有情況下,如果參數的數量是可變的,那麼您將擁有某種列表(如您所提到的,[quux ...]或者[quux[, quux[...]]]…),其中類似地,[quuz]大多數時候只表示一個參數。在極少數情況下,[quuz]也可能表示“一個或多個參數”,但大多數手冊符合列表形式的省略號。

這是一個準標準,但你不能絕對依賴它。但根據我的經驗,95% 的時候都可以。

關鍵是,那裡有數百家任何顏色的軟體供應商,不僅是“大玩家”,還有被證明是有用的由個人編寫的軟體。他們所有人(希望)都以某種個人方式編寫他們的聯機幫助頁……他們中的大多數人都知道足夠長的時間來處理常見的慣例,但也有一些人不關心或在風格品味等方面存在某種心理缺陷; )

引用自:https://unix.stackexchange.com/questions/129121