编写可移植的手册页

Question

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

Answer 1

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

• THE LINUX MAN-PAGE-HOWTO Jens Schweikhardt
• Writing Effective Manual Pages by 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 包的一部分。