编写便携式手册页

Question

如果我想编写可在不同类Unix系统之间移植的手册页，我应该使用哪种源语言标准？或者我可以简单地假设GNU troff（groff）随处可用吗？

Answer 1

如果您查看man下的https://www.troff.org/macros.html，它将列出两个编写手册页的指南。

• THE LINUX MAN-PAGE-HOWTO，作者：Jens Schweikhardt
• Writing Effective Manual Pages，作者Larry Kollar

通常，他们俩都建议避免使用额外的预处理器，例如tbl，pic或eqn，尤其是在您要最大程度地提高便携性的情况下。

手册页使用an宏程序包。这样做是为了在您使用-m宏选项调用它时显示为troff -man。要查找由an宏程序包定义的宏，您应该查找与tmac.an*（对于UNIX / BSD系统）或an*.tmac（对于Linux系统）匹配的文件。例如，在RHEL / CentOS上为：

/usr/share/groff/1.18.1.4/tmac/an.tmac which refers to
/usr/share/groff/1.18.1.4/tmac/andoc.tmac which refers to
/usr/share/groff/1.18.1.4/tmac/an-old.tmac which defines most of the macros

这些文件是groff软件包的一部分。