我正在尝试编写一些规范以在一个小团队之间共享,并对我放入一些命令列表的格式变得挑剔。手册页的 SYNOPSIS 部分中使用的语法是否有任何正式定义?
来自 Wikimedia Commons,这是我正在谈论的 SYNOPSIS 部分的手册页示例,其中列出了命令及其理解的必需参数和可选参数。
最佳答案
任何地方都没有对联机帮助页的正式定义,甚至在 POSIX 标准中也没有。 man(1)
您示例中的联机帮助页非常典型:您可以使用 []
写出程序的各种使用方式(通常只有一种)。表示可选的粗体(或带有 mdoc
宏的打字机字体)表示文字命令行输入,斜体表示变量。
联机帮助页 man(7)
和 mdoc(7)
将解释最重要的约定。 man(7)
用于旧式 Unix 联机帮助页,并且在 Linux 上仍然很流行(参见 man-pages(7)
); mdoc(7)
来自 4.4BSD 并在其衍生产品中流行。后者保持了更严格的内容和演示分离,并且可以生成(恕我直言)更漂亮的 PDF/HTML 输出
关于syntax - 手册页的 SYNOPSIS 部分是否有规范?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8716047/