Command-Line

是否有編寫命令概要的標準?

  • April 5, 2022

在我看來,每個人對於如何為最終使用者編寫描述命令用法的**概要都有自己的想法。

例如,這是來自的格式man grep

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

現在這有一些出現在其他手冊頁中的語法。 []被認為是可選的,並且...作為相同輸入的倍數是有意義的。

但是人們使用|or/表示 OR 並且還有其他人會反轉什麼[]意思。或者他們沒有給出去向的任何指示[OPTIONS]

我想為我的寫作遵循一個標準,但我看到的每個網站都會告訴我一些不同的東西。

是否有編寫概要的實際標準方式,或者約定只是人們長期以來一直在做的事情?

這方面的經典標準來自 POSIX,Utility Argument Syntax(感謝 @illuminÉ 提供更新的連結)。它描述了要在手冊頁中使用的語法,例如

utility_name[-a][-b][-c option_argument]
   [-d|-e][-f[option_argument]][operand...]

作為經典,它建議使用單字元選項,並-W建議供應商使用,這就是多字元選項的適應方式(例如,參見gcc 選項摘要)。

GNU 軟體引入了以 . 開頭的多字元選項--。可以在help2man 參考中找到一些來自 GNU 的使用這些選項格式化手冊頁的指南。

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