手册页的概要部分有规范吗？
我正在尝试编写一些在小团队之间共享的规范，并对放置一些命令列表的格式很挑剔。 man 的概要部分中使用的语法是否有任何正式定义页数？
来自维基共享资源，这是一个手册页示例，其中包含我正在讨论的概要部分，其中列出了命令及其理解的必需参数和可选参数。
I'm trying to write some specifications to be shared between a small team and getting picky about the format I put some command listings in. Is there any formal definition of the syntax used in the SYNOPSIS section of man pages?
From the Wikimedia Commons, here's an example of a man page with the SYNOPSIS section I'm talking about, where the command is listed with the required and optional arguments it understands.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（3）
任何地方都没有联机帮助页的正式定义，甚至在 POSIX 标准中也没有。您示例中的
man(1)手册页非常典型：您写出程序使用的各种方式（通常只有一种），其中[]表示可选、粗体（或带有mdoc宏的打字机字体）表示文字命令行输入和斜体表示变量。手册页
man(7)和mdoc(7)将解释最重要的约定。man(7)用于旧式 Unix 联机帮助页，并且在 Linux 上仍然很流行（请参阅man-pages(7)）；mdoc(7)来自 4.4BSD，并在其衍生产品中很流行。后者保持内容和表示更严格的分离，并且可以生成（恕我直言）更漂亮的 PDF/HTML 输出There is no formal definition of a manpage anywhere, not even in the POSIX standard. The
man(1)manpage in your example is pretty typical: you write out the various ways a program can be used (often just one) with[]denoting optional, bold (or typewriter font with themdocmacros) denoting literal command line input and italics denoting variables.The manpages
man(7)andmdoc(7)will explain the most important conventions.man(7)is for old-style Unix manpages and is still popular on Linux (seeman-pages(7));mdoc(7)comes from 4.4BSD and is popular in its derivatives. The latter maintains a stricter separation of content and presentation and can produce (IMHO) prettier PDF/HTML output实用程序的实用程序约定记录在 第 12 章中。 IEEE Std 1003.1 的实用程序约定，2004年版。
此文档的较新版本位于此处
The utility conventions for utilities are documented in in Chapter 12. Utility conventions of the IEEE Std 1003.1, 2004 Edition.
A newer edition of this document exists here
man 7 手册页：
man 7 man-pages: