上一级: Web 页面上的手册   [目录][索引]


13.3.1 调用 gendocs.sh

脚本 gendocs.sh 简化了为您上面的 Web 页面部分生成 Texinfo 文档输出的任务。它有一个配套的模板文件,用作 HTML 索引页面的基础。两者都可以从 Gnulib 开发中获得。

https://git.savannah.gnu.org/cgit/gnulib.git/tree/build-aux/gendocs.sh
https://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/gendocs_template

还有一个极简模板,可从以下位置获取:

https://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/gendocs_template_min

在包含 Texinfo 源文件的目录中,像这样调用该脚本:

gendocs.sh --email yourbuglist yourmanual "GNU yourmanual manual"

其中 yourmanual 是您的软件包的简称,yourbuglist 是错误报告的电子邮件地址(应为 bug-package@gnu.org)。该脚本处理文件 yourmanual.texinfo(或 .texi.txi)。例如:

cd .../texinfo/doc
# download gendocs.sh and gendocs_template
gendocs.sh --email [email protected] texinfo "GNU Texinfo manual"

gendocs.sh 创建一个子目录 manual/,其中包含以所有标准输出格式生成的手册:Info、HTML、DVI 等,以及 Texinfo 源文件。然后,您需要将所有这些文件(保留子目录)移动到您的软件包的 Web 页面中。

您可以指定选项 -o outdir 来覆盖名称 manualoutdir 的任何先前内容都将被删除。

第二个参数(带有描述)作为 HTML <title> 的一部分包含在整个 manual/index.html 文件中。它应包含被记录的软件包的名称,如所示。manual/index.html 是通过从文件 gendocs_template 替换而创建的。(您可以随意修改通用模板以满足您自己的目的。)

如果您有多个手册,则需要使用不同的参数多次运行此脚本,每次都使用 -o 指定不同的输出目录,并将所有输出移动到您的 Web 页面。然后(手动)编写一个整体 index.html,其中包含指向它们的链接。例如:

cd .../texinfo/doc
gendocs.sh --email [email protected] -o texinfo texinfo "GNU Texinfo manual"
gendocs.sh --email [email protected] -o info info "GNU Info manual"
gendocs.sh --email [email protected] -o info-stnd info-stnd "GNU info-stnd manual"

默认情况下,该脚本使用 makeinfo 生成 HTML 输出。如果您更喜欢使用 texi2html,请使用 --texi2html 命令行选项,例如:

gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual"

模板文件将自动为 texi2html 生成的其他 HTML 输出生成条目(即,按节和章分割)。

您可以设置环境变量 MAKEINFOTEXI2DVI 等来控制要执行的程序,并设置 GENDOCS_TEMPLATE_DIR 来控制 gendocs_template 文件的查找位置。

像往常一样,运行 ‘gendocs.sh --help’ 以获取所有选项、环境变量和更多信息的描述。

请将有关 gendocs 的错误报告、增强请求或其他信件发送至 [email protected]


上一级: Web 页面上的手册   [目录][索引]