是否有手册页的SYNOPSIS部分的规范？
我正在尝试编写一些规范,以便在一个小团队之间共享,并对我放入一些命令列表的格式感到挑剔.是否有人工页面的SYNOPSIS部分中使用的语法的正式定义？
来自Wikimedia Commons,这是一个手册的示例,其中包含我正在讨论的SYNOPSIS部分,其中列出的命令包含它理解的必需和可选参数.
Fre*_*Foo 19
在任何地方都没有正式的手册页定义,甚至在POSIX标准中也没有.man(1)您的示例中的联机帮助页非常典型:您可以编写程序可以使用的各种方式(通常只有一个),[]表示可选的粗体(或带mdoc宏的打字机字体)表示文字命令行输入和斜体表示变量.
该手册页man(7)和mdoc(7)将解释最重要的公约.man(7)用于旧式Unix手册,在Linux上仍然很受欢迎(参见参考资料man-pages(7)); mdoc(7)来自4.4BSD,在其衍生产品中很受欢迎.后者保持更严格的内容和表现分离,并可以产生(恕我直言)更漂亮的PDF/HTML输出
- 自从我在许多手册页中找到它们之后,{}和<>怎么样？ (5认同)
- 有一个关于这个的posix doc - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html (2认同)
- `{opt1 | opt2 | opt3}`语法似乎指示一个，并且只能使用其中一个选项，但是我找不到此文档。 (2认同)
Amo*_*rin 12
man 7 man-pages:
简要描述命令或功能的界面.对于命令,这显示了命令的语法及其参数(包括选项); 粗体用于原样文本,斜体用于表示可替换的参数.括号([])包围可选参数,垂直条(|)单独选择,椭圆(...)可以重复.对于函数,它显示任何所需的数据声明或#include指令,后跟函数声明.
- 看起来这是来自`man 7 man-pages`,而不是man(7). (2认同)