因此,我一直在考虑为一个项目编写联机帮助页,并最终找到了mdoc 手册页。其中,它描述了联机帮助页的常见布局,包括:
.\" .Sh CONTEXT
.\" For section 9 functions only.
.\" .Sh IMPLEMENTATION NOTES
.\" Not used in OpenBSD.
.\" .Sh RETURN VALUES
.\" For sections 2, 3, and 9 function return values only.
.\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only.
但是我不明白这1、6、7、8这几节到底指的是什么?我最好的猜测是手册的页面(例如系统调用的第 2 页),但这没有多大意义,为什么返回值不在第 1 页上?
答案1
注意引用的手册页实际上是怎样的文档(7)。这意味着它来自手册页集合的第 7 节,即“各种各样的”。如果所有手册页都是整本书,则将这些部分视为章节。
这意味着您应该记录RETURN VALUES
是否要编写要放置在第 2、3 或 9 节中的手册页。
典型命令可在第 1 节中找到,例如LS(1)和杜(1)(两者都随操作系统一起提供)。但外部项目通常使用相同的映射,例如postgres(1)和mysql(1)。后者是一个不太好的手册页示例,因为它没有引用相关页面。然后你最终在网上寻找页面。不要成为那样的人!
看13.2.部分用于类别的枚举。
完整的(和简短的)第 13 章手册页可能会提供更高级的介绍而不是手册页。
人们经常错过的另一个高级页面是简介(7)。我认为这是该书的第一页人“书”。每个部分都有一个介绍描述每个部分的页面:
编号 类别