是否有编写命令概要的标准?

Tor*_*yst 17 command-line man

在我看来,对于如何为最终用户编写描述命令使用概要,每个人都有自己的想法。

例如,这是来自的格式man grep

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]
Run Code Online (Sandbox Code Playgroud)

现在这有一些出现在其他联机帮助页中的语法。 []被认为是可选的,并且...作为相同输入的倍数有意义。

但是人们使用|or/为 OR ,还有其他人会颠倒什么[]意思。或者他们没有给出任何关于去哪里的迹象[OPTIONS]

我想遵循我写的东西的标准,但我看到的每个网站都会告诉我一些不同的东西。

是否有编写概要的实际标准方式,或者惯例只是人们一直在做的事情?

Mar*_*ick 9

这方面的经典标准来自 POSIX,Utility Argument Syntax(感谢 @illuminÉ 提供更新的链接)。它描述了手册页中使用的语法,例如

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]
Run Code Online (Sandbox Code Playgroud)

作为经典,它建议使用单字符选项,-W建议供应商使用,这就是多字符选项的适应方式(例如,参见gcc 选项摘要)。

GNU 软件引入了以--. 可以在help2man 参考中找到一些来自 GNU 的使用这些选项格式化手册页的指南