是否有手册页的SYNOPSIS部分的规范？

Question

我正在尝试编写一些规范，以便在一个小团队之间共享，并对我放入一些命令列表的格式感到挑剔。是否有任何形式定义SYNOPSIS中使用的语法手册部分？

来自Wikimedia Commons，这里是一个手册的例子，其中包含我正在讨论的SYNOPSIS部分，其中列出的命令包含它理解的必需和可选参数。

Answer 1

在任何地方都没有正式的手册页定义，甚至在POSIX标准中也没有。您的示例中的man(1)联机帮助页非常典型：您可以编写程序可以使用的各种方式（通常只有一个）[]表示可选的粗体（或{{3}的打字机字体表示文字命令行输入和表示变量的斜体。

联机帮助页man(7)和mdoc(7)将解释最重要的约定。 man(7)用于旧式Unix手册，在Linux上仍然很受欢迎（参见man-pages(7)）; mdoc(7)来自4.4BSD，在其衍生产品中很受欢迎。后者保持更严格的内容和表现分离，可以产生（恕我直言）更漂亮的PDF / HTML输出

Answer 2

man 7 man-pages：

  

简要描述命令或功能的界面。对于命令，   这显示了命令及其参数的语法（包括   选项）; 粗体用于原样文本，斜体用于   表示可替换的参数。托架（[]）环绕可选   参数，竖线（|）分开选择，省略号（...）可以   重复。对于函数，它显示任何所需的数据声明   或#include指令，后跟函数声明。

Answer 3

实用程序的实用程序约定记录在Chapter 12. Utility conventions of the IEEE Std 1003.1, 2004 Edition。

中

此文档的较新版本存在here