texdoc

Texdoc - 在Tex Live中查找并​​查看文档

一般信息

• 网站：https：//www.tug.org/texdoc/
• 存储库：https：//github.com/tex-live/texdoc/
• 邮件列表：[email protected]

使用Texdoc

Texdoc是Tex Live发行的一部分。通常，您不必自己安装。

如果您想尝试/测试开发版本，请参见下文。

如何安装开发版本

使用Bundler

安装开发版本Texdoc的最简单方法是使用Bundler和Rake：

bundle install
rake install

如果要卸载开发版本（使用Tex Live版本），请尝试：

rake uninstall

手动安装

在这里， $TEXDOC意思是您克隆（或下载）的Texdoc Dev来源的道路，而$TEXMFHOME表示您的个人Texmf树（您可以使用kpsewhich --var-value TEXMFHOME获得其位置）。

• 命令。 Symlink或$TEXDOC/script为$TEXMFHOME/scripts/texdoc 。
• 配置文件。 symlink或$TEXDOC/texdoc.cnf as $TEXMFHOME/texdoc/texdoc-dist.cnf （请注意-dist部分）。除$TEXMFHOME/texdoc/texdoc.cnf外，它将完全覆盖其他配置文件，您仍然可以用于您的个人设置。

您可以确保通过运行texdoc --files ：第一行）包含通往二手texdoclib.tlu版本的完整路径，而其余的列出了使用的配置文件。

此存储库中的文件

• doc/包含文档，
• script/包含源代码，
• spec/是用于测试脚本的目录，并且
• texdoc.cnf是默认配置文件。

建筑和测试

许多建筑任务被定义为耙任务。

生成所有文档

以下将在doc/ DIRECTORY中同时生成PDF和MANPAGE。

rake doc

生成预先用力的缓存文件

以下将生成预先使用的高速缓存文件script/Data.tlpdb.lua 。必须在用TLPDB的Tex实时设置下完成此任务。

rake gen_datafile

运行测试

以下将在spec/目录中运行所有测试。

rake test

另外，您可以为此任务提供--list （ -l ）选项的规格名称。例如，以下将仅运行spec/action/help_spec.rb和spec/mode/list_spec.rb ：

rake test -- -l action/help,mode/list

显示所有可用任务

以下将显示所有可用的任务，并具有简短的描述。

rake -T

除此之外，对于选项可用任务，例如， rake test和rake run_texdoc ，您可以在每个任务中获取带有-h选项的选项信息：

rake test -- -h

更多信息

可以在我们的github存储库的Wiki中找到更多具体信息，例如该项目的待办事项列表和一些分销商的信息。请访问：

• https://github.com/tex-live/texdoc/wiki

版权和许可

版权所有2008-2024ManuelPégourié-Gonnard，Takuto Asakura，Tex Live团队。

该软件包是根据自由软件基金会（自由软件基金会（Free Software Foundation）发表的，或者（您可以选择）的任何以后版本的版本发布的GNU通用公共许可证的条款分发。

公共领域的先前工作（TEXDOC计划）：

• Reinhard Kotucha（2008）的贡献。
• FrankKüster（2007年）的第一款Texlua版本。
• Thomas Esser，David Aspinall和Simon Wilkinson的原始Shell剧本。