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劇本。