我们为什么要编写文档？ 这个问题很傻。 因为我们希望其他人能够使用我们的程序、库函数或者我们编写并提供的任何东西。 但是编写文档并非全部
文档必须是可访问的。 如果它隐藏在一些非标准的位置，文档相关工具无法找到它 -- 它怎么能达到其目的呢？
文档必须是可靠和准确的。 没有什么比程序行为和文档不一致更令人恼火的了。 用户会诅咒你，给你发仇恨邮件，并将你的工作扔进垃圾桶，并坚决不再安装那个混蛋写的任何东西。
在 UNIX 上访问文档的历史悠久且众所周知的方式是通过 man(1) 命令。 本 HOWTO 描述了您必须做什么才能编写一个 man 手册页，该手册页将被文档相关工具正确处理。 这些工具中最重要的是man(1), xman(1x),apropos(1), makewhatis(8) 和catman(8)。 信息的可靠性和准确性当然取决于您。 但即使在这方面，您也会在下面找到一些想法，帮助您避免一些常见的故障。