下一节: , 上一节: , 上级: 文档   [目录][索引]


6.9 手册页

在 GNU 项目中,手册页是次要的。并非每个 GNU 程序都必须或期望拥有手册页,但有些程序确实有。是否在程序中包含手册页由您自己决定。

在您做出决定时,请考虑支持手册页需要每次程序更改时都要持续付出努力。您在手册页上花费的时间是从更有用的工作中挤出来的。

对于一个几乎没有变化的简单程序,更新手册页可能是一件小事。那么,如果您有一个手册页,就没有什么理由不包含它。

对于一个变化很大的大型程序,更新手册页可能是一个相当大的负担。如果用户主动捐赠手册页,您可能会发现接受这份礼物代价高昂。最好拒绝手册页,除非同一个人同意承担维护它的全部责任——这样您就可以完全置身事外。如果这位志愿者后来停止工作,那么不要觉得有义务自己接手;最好将手册页从发行版中撤回,直到有人同意更新它为止。

当程序仅发生少量更改时,您可能会觉得差异很小,手册页在不更新的情况下仍然有用。如果是这样,请在手册页的开头附近放置一个醒目的注释,说明您不维护它,并且 Texinfo 手册更权威。注释应说明如何访问 Texinfo 文档。

请确保手册页包含版权声明和自由许可证。简单的全许可许可证适用于简单的手册页(请参阅GNU维护者信息中的其他文件的许可证声明)。

对于较长的手册页,其中包含足够的解释和文档,可以将其视为真正的手册,请使用 GFDL(请参阅手册的许可证)。

最后,GNU help2man 程序(https://gnu.ac.cn/software/help2man/)是一种自动化生成手册页的方法,在这种情况下,是从 --help 输出生成。这在许多情况下都足够了。


下一节: , 上一节: , 上级: 文档   [目录][索引]