![在 UNIX 手册页中添加“子小节”是否有任何准标准?](https://linux22.com/image/204436/%E5%9C%A8%20UNIX%20%E6%89%8B%E5%86%8C%E9%A1%B5%E4%B8%AD%E6%B7%BB%E5%8A%A0%E2%80%9C%E5%AD%90%E5%B0%8F%E8%8A%82%E2%80%9D%E6%98%AF%E5%90%A6%E6%9C%89%E4%BB%BB%E4%BD%95%E5%87%86%E6%A0%87%E5%87%86%EF%BC%9F.png)
我想知道:使用宏包编写 UNIX 手册页man
有.SH
(章节标题)和.SS
(小节)。但是如果我想要有“子小节”怎么办?
有这样的标准吗?我想我已经看到一些页面在 中修改了字体大小(至少troff
).SS
,但我想知道是否确实有一些(准)标准。
答案1
我相信简短的答案是“不”——手册页中的小节没有标准。
这个问题于去年九月出现邮件linux-man
列表,其中策划了大量man
材料,但没有人知道这样做有任何公认的习惯用法。
我要强调的一点是:“如果你需要在一个手册页,[那么]整个页面的讨论水平太粗略了。”没有法律禁止将手册页分解为多个文档。groff 和 Perl 就是这样做的。
甚至原始man
宏包自己的手册页(1979)甚至在没有记录分段宏的情况下就出门了SS
。
对我来说,这种(故意的?)监督似乎与手册页作为“简洁”文档的最初概念是一致的。
如果你必须这样做,我不会编写自己的宏,也不会TP
像线程中讨论的那样滥用linux-man
。我可能只会使用“导入标题”。换句话说,以斜体或粗体标题开头的段落。
.P
.B Error handling.
The Z language does not support an exception mechanism.
Therefore you have to check return values at every point blah blah blah
答案2
Perl 的 POD 文档格式可以转换为各种格式,也可以转换为使用pod2man
.这就是 PerlPod::Man
模块的作用(不声称它是某种标准):
=head1
被翻译成.SH
,使用.IX Header "...."
=head2
被翻译成.SS
,使用.IX Subsection "...."
=head3
被翻译为斜体字体,使用.IX Subsection "...."
=head4
被翻译为纯文本,使用.IX Subsection "...."
=head3
和的标题文本=head4
被 s 包围,.PP
如下所示:
.PP
title text
.IX Subsection "title text"
.PP