texdoc

TEXDOC - Find and View Documentation in Tex Live

Informations générales

• Site Web: https://www.tug.org/texdoc/
• Référentiel: https://github.com/tex-live/texdoc/
• Liste de diffusion: [email protected]

Utilisation de Texdoc

Texdoc fait partie de la distribution Tex Live. Généralement, vous n'avez pas à l'installer vous-même.

Si vous souhaitez essayer / tester la version Développer, veuillez consulter ci-dessous.

Comment installer la version de développement

Utilisation de Bundler

La façon la plus simple d'installer la version en développement de Texdoc est d'utiliser Bundler et Rake:

bundle install
rake install

Si vous souhaitez désinstaller la version de développement (pour utiliser la version Tex Live), essayez simplement:

rake uninstall

Installation manuellement

Ici, $TEXDOC signifie le chemin vers les sources de développement texdoc que vous avez clonées (ou téléchargées), et $TEXMFHOME désigne votre arbre Texmf personnel (vous pouvez obtenir son emplacement avec kpsewhich --var-value TEXMFHOME ).

• La commande. SymLink ou copier $TEXDOC/script sous le nom de $TEXMFHOME/scripts/texdoc .
• Le fichier de configuration. SymLink ou copier $TEXDOC/texdoc.cnf en tant que $TEXMFHOME/texdoc/texdoc-dist.cnf (remarquez la partie -dist ). Il remplacera complètement les autres fichiers de configuration à l'exception $TEXMFHOME/texdoc/texdoc.cnf que vous pouvez toujours utiliser pour vos paramètres personnels.

Vous pouvez vous assurer que les bons fichiers sont utilisés en exécutant texdoc --files : la première ligne contient le chemin complet vers la version de texdoclib.tlu usagée, et le reste répertorie les fichiers de configuration utilisés.

Fichiers dans ce référentiel

• doc/ contient la documentation,
• script/ contient le code source,
• spec/ est un répertoire pour tester les scripts, et
• texdoc.cnf est le fichier de configuration par défaut.

Bâtiment et test

De nombreuses tâches de construction sont définies comme des tâches de râteau.

Génération de toutes les documents

Ce qui suit générera à la fois le PDF et la page Man dans doc/ Directory.

rake doc

Génération d'un fichier de cache précoce

Ce qui suit générera un script/Data.tlpdb.lua . Cette tâche doit être effectuée sous une configuration Tex Live avec TLPDB.

rake gen_datafile

Tests en cours d'exécution

Les éléments suivants exécuteront tous les tests dans spec/ Directory.

rake test

Alternativement, vous pouvez donner des noms de spécifications avec l'option --list ( -l ) pour cette tâche. Par exemple, le suivi exécutera uniquement spec/action/help_spec.rb et spec/mode/list_spec.rb :

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

Affichage de toutes les tâches disponibles

Ce suivant affichera toutes les tâches disponibles avec une courte description.

rake -T

En plus de cela, pour les tâches disponibles, par exemple, rake test et rake run_texdoc , vous pouvez obtenir des informations d'options avec l'option -h pour chaque tâche:

rake test -- -h

Plus d'informations

Des informations plus spécifiques, telles que la liste TODO de ce projet et certaines informations pour les distributeurs, peuvent être trouvées dans le wiki de notre référentiel GitHub. Veuillez visiter:

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

Copyright et licence

Copyright 2008-2024 Manuel Pégourié-Gonnard, Takuto Asakura, l'équipe Tex Live.

Ce package est distribué en vertu des termes de la licence publique générale GNU publiée par la Free Software Foundation, soit la version 3 de la licence, soit (à votre option) toute version ultérieure.

Travaux antérieurs (programme Texdoc) dans le domaine public:

• Contributions de Reinhard Kotucha (2008).
• Premières versions Texlua par Frank Küster (2007).
• Script de shell original de Thomas Esser, David Aspinall et Simon Wilkinson.