texdoc

Texdoc - Dokumentation in Tex Live finden und anzeigen

Allgemeine Informationen

• Website: https://www.tug.org/texdoc/
• Repository: https://github.com/tex-live/texdoc/
• Mailingliste: [email protected]

Verwenden von Texdoc

Texdoc ist Teil der Tex Live Distribution. Im Allgemeinen müssen Sie es nicht selbst installieren.

Wenn Sie die Entwicklungsversion ausprobieren/testen möchten, lesen Sie bitte unten.

So installieren Sie die Entwicklungsversion

Mit Bundler

Der einfachste Weg, um die Entwicklungsversion von TexDOC zu installieren, ist die Verwendung von Bundler und Rake:

bundle install
rake install

Wenn Sie die Entwicklungsversion (zur Verwendung der Tex Live -Version) deinstallieren möchten, versuchen Sie es einfach:

rake uninstall

Manuell installieren

Hier bezeichnet $TEXDOC den Weg zu den von Ihnen klonierten (oder heruntergeladenen) Texdoc-Dev-Quellen, und $TEXMFHOME bezeichnet Ihren persönlichen Texmf-Baum (Sie können seinen Standort mit kpsewhich --var-value TEXMFHOME erhalten).

• Der Befehl. Symlink oder kopieren $TEXDOC/script $TEXMFHOME/scripts/texdoc .
• Die Konfigurationsdatei. Symlink oder Copy $TEXDOC/texdoc.cnf als $TEXMFHOME/texdoc/texdoc-dist.cnf (beachten Sie den Teil -dist ). Die anderen Konfigurationsdateien außer $TEXMFHOME/texdoc/texdoc.cnf werden Sie weiterhin für Ihre persönlichen Einstellungen verwenden.

Sie können sicherstellen, dass die richtigen Dateien durch Ausführen texdoc --files : Die erste Zeile verwendet werden, enthält den vollständigen Pfad zur Version der gebrauchten texdoclib.tlu , und in den Rest listet die verwendeten Konfigurationsdateien auf.

Dateien in diesem Repository

• doc/ enthält die Dokumentation,
• script/ enthält den Quellcode,
• spec/ ist ein Verzeichnis zum Testen von Skripten und
• texdoc.cnf ist die Standardkonfigurationsdatei.

Gebäude und Test

Viele Gebäudeaufgaben werden als Rake -Aufgaben definiert.

Alle Dokumentation generieren

Im Folgenden werden sowohl die PDF als auch die Manpage im doc/ Verzeichnis erzeugt.

rake doc

Generieren einer vorgehassten Cache-Datei

Im Folgenden werden ein vorgeschütztes Cache- script/Data.tlpdb.lua generiert. Diese Aufgabe muss unter einem Tex Live -Setup mit TLPDB erledigt werden.

rake gen_datafile

Auslauftests

Im Folgenden werden alle Tests in spec/ Verzeichnis ausgeführt.

rake test

Alternativ können Sie für diese Aufgabe Spezifikationsnamen mit der Option --list ( -l ) angeben. Z. B. wird folgt nur spec/action/help_spec.rb und spec/mode/list_spec.rb ausgeführt:

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

Alle verfügbaren Aufgaben zeigen

Im Folgenden werden alle verfügbaren Aufgaben mit einer kurzen Beschreibung angezeigt.

rake -T

Zusätzlich dazu können Sie für Optionen verfügbare Aufgaben, z. B. rake test und rake run_texdoc Optioneninformationen mit -h -Option für jede Aufgabe erhalten:

rake test -- -h

Weitere Informationen

Genauere Informationen wie die Todo -Liste dieses Projekts und einige Informationen für Distributoren finden Sie im Wiki unseres Github -Repositorys. Bitte besuchen Sie:

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

Urheberrecht und Lizenz

Copyright 2008-2024 Manuel Pégourié-Gonnard, Takuto Asakura, das Tex Live-Team.

Dieses Paket wird gemäß den Bestimmungen der GNU General Public Lizenz verteilt, die von der Free Software Foundation entweder Version 3 der Lizenz oder (nach Ihrer Option) eine spätere Version veröffentlicht wurde.

Frühere Arbeiten (Texdoc -Programm) im öffentlichen Bereich:

• Beiträge von Reinhard Kotucha (2008).
• Erste Texlua -Versionen von Frank Küster (2007).
• Original -Shell -Skript von Thomas Esser, David Aspinall und Simon Wilkinson.