9. 润色您的 man 手册页

以下是一些增加文档可靠性、可读性和“可格式化性”的指南。

• 测试示例以确保它们可以工作（使用剪切和粘贴将 man 手册页中的确切措辞提供给您的 shell）。将命令的输出复制到您的 man 手册页中，不要只是键入您认为您的程序会打印的内容。

• 校对、使用 ispell 进行拼写检查，并让其他人阅读它，特别是如果您的母语不是英语。您正在阅读的 HOWTO 已经通过了后一项测试（特别感谢 Michael Miller 的英勇贡献！所有剩余的粗糙之处完全是我的错误）。 随时欢迎更多的志愿者。

• 测试您的 man 手册页：groff在您格式化您的 man 手册页时会报错吗？最好将groff命令行放在注释中。man(1) 命令在您调用man yourprog时会报错吗？ 它是否产生预期的结果？xman(1x) 和tkman(1tk) 可以处理您的手册吗？ XFree86 3.1 拥有 xman 3.1.6 - X11R6，它将尝试使用以下命令解压缩：gzip -c -d < %s > %s zcat < %s > %s

• makewhatis(8) 能够从 NAME 部分提取单行描述吗？使用

• rman将您的 man 手册页翻译成 HTML 格式，该工具来自 http://polyglotman.sourceforge.net/，并使用一组 Web 浏览器（netscape, mozilla, opera, lynx, ...）查看结果。检查您的 man 手册页之间的交叉引用在生成的 HTML 中是否作为超链接工作。如果您的软件包有一个网站，请将您的 man 手册页发布在那里，并保持它们是最新的。该

• 实用程序还可以将 man 手册页翻译成 LaTeX、RTF、SGML 和其他格式；如果您想将 man 手册页整合到书籍或其他更大的文档中，请查看这些格式。将您的 man 手册页翻译成 HTML 格式，该工具来自 http://polyglotman.sourceforge.net/，并使用一组 Web 浏览器（netscape, mozilla, opera, lynx, ...）查看结果。检查您的 man 手册页之间的交叉引用在生成的 HTML 中是否作为超链接工作。如果您的软件包有一个网站，请将您的 man 手册页发布在那里，并保持它们是最新的。尝试使用

• man2html将您的 man 手册页翻译成 HTML，自 man-1.4 以来，它一直是 Linux man 包的一部分。该实用程序是一个不如将您的 man 手册页翻译成 HTML，自 man-1.4 以来，它一直是 Linux man 包的一部分。该rman将您的 man 手册页翻译成 HTML 格式，该工具来自 http://polyglotman.sourceforge.net/，并使用一组 Web 浏览器（netscape, mozilla, opera, lynx, ...）查看结果。检查您的 man 手册页之间的交叉引用在生成的 HTML 中是否作为超链接工作。如果您的软件包有一个网站，请将您的 man 手册页发布在那里，并保持它们是最新的。那么雄心勃勃的翻译器，但几乎每个 Linux 用户都已经拥有它，因此值得确保将您的 man 手册页翻译成 HTML，自 man-1.4 以来，它一直是 Linux man 包的一部分。该man2html