主页 / unix / 问题 / 698037
Accepted
U. Windl
Asked: 2022-04-06 01:09:02 +0800 CST

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

  • 772

我想知道：使用宏包编写 UNIX 手册页man有.SH（节标题）和.SS（子节）。但是，如果我想有“子小节”怎么办？

有这样的标准吗？我想我已经看到一些页面摆弄了字体大小（troff至少）.SS，但我想知道是否真的有一些（准）标准。

man

2 个回答

  1. Best Answer

    我相信简短的回答是“不”——手册页中的小节没有标准。

    去年 9 月，该问题出现在linux-man邮件列表中，其中整理了大量man材料，没有人知道这样做的任何公认习语。

    我要强调的一点是：“如果您需要手册页中的子小节，[那么] 整个页面的讨论水平太粗糙了。” 没有法律禁止将手册页分成多个文档。groff 和 Perl 就是这样做的。

    甚至最初man的宏包自己的手册页（1979）也被淘汰了，SS甚至没有记录分段宏。

    对我来说，这种（故意的？）疏忽似乎与手册页作为“简洁”文档的原始概念一致。

    如果您必须这样做，我不会编写自己的宏或滥用线程TP中讨论的内容。linux-man我可能只会使用“run-in-header”。换句话说，以斜体或粗体的标题开始一个段落。

    .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

  2. Perl 的 POD 文档格式可以翻译成各种格式，也可以翻译成使用pod2man. 这就是 Perl 的Pod::Man模块所做的（不声称它是某种标准）：

    • =head1被翻译成.SH, 使用.IX Header "...."
    • =head2被翻译成.SS, 使用.IX Subsection "...."
    • =head3被翻译成斜体字体，使用.IX Subsection "...."
    • =head4被翻译成纯文本，使用.IX Subsection "...."

    =head3和的标题文本=head4被.PPs 包围，如下所示：

    .PP
title text
.IX Subsection "title text"
.PP
    • 0

相关问题