☰

在 UNIX 手册页中添加“子小节”是否有任何准标准？

tag-icon • tag-icon man
在 UNIX 手册页中添加“子小节”是否有任何准标准？

我想知道：使用宏包编写 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

相关内容