使用 MakeMaker 的手册页

Posted 2023-02-16

【中文标题】使用 MakeMaker 的手册页

【英文标题】：Man pages with MakeMaker

【发布时间】：2012-09-10 14:14:04

【问题描述】：

我写了一些我想从 MakeMaker 安装的手册页。

我想使用诸如INSTALLSITEMAN1DIR* 环境变量之类的环境变量来控制它们的安装位置。

我应该将 man 文件放在源代码树的哪个位置，或者我需要对 Makefile.PL 做些什么来告诉它有关它们的信息？

【参考方案1】：

您的联机帮助页是什么格式的？您不应该提供完全编译的联机帮助页，因为每个目标主机都需要根据需要使用自己的 groff 或 troff 或其他版本对其进行格式化。

如果您以 POD 格式编写联机帮助页，MakeMaker 会自动选择它们并将它们放在正确的位置。

只需将文件命名为末尾.pod， 将它们放在您的lib 目录中，然后 将它们格式化为 Perl 的 Plain Old Documentation (POD) 格式。

如果您需要以其他格式发布您的联机帮助页，我不知道协议是什么。您可能必须自定义ExtUtils::MakeMaker 生成的Makefile。此时，您可能需要查看Module::Build、Module::Install 或Dist::Zilla，因为它们更容易定制。

【讨论】：

啊——我是根据我正在查看的其他手册页写的，但我不确定是什么。我认为语法有点太糟糕了，无法做正确的事情:)