texdoc

TEXDOC - Buscar y ver la documentación en Tex Live

Información general

• Sitio web: https://www.tug.org/texdoc/
• Repositorio: https://github.com/tex-live/texdoc/
• Lista de correo: [email protected]

Usando texdoc

Texdoc es parte de la distribución de Tex Live. En general, no tiene que instalarlo usted mismo.

Si desea probar/probar la versión para desarrollar, consulte a continuación.

Cómo instalar la versión para desarrollar

Usando Bundler

La forma más fácil de instalar la versión de desarrollo de TexDoc es usar Bundler and Rake:

bundle install
rake install

Si desea desinstalar la versión para desarrollar (para usar la versión Tex Live), solo intente:

rake uninstall

Instalación manualmente

Aquí, $TEXDOC significa la ruta a las fuentes de desarrollo de Texdoc que clonó (o descargó), y $TEXMFHOME denota su árbol de texmf personal (puede obtener su ubicación con kpsewhich --var-value TEXMFHOME ).

• El comando. Symlink o copiar $TEXDOC/script como $TEXMFHOME/scripts/texdoc .
• El archivo de configuración. Symlink o copiar $TEXDOC/texdoc.cnf como $TEXMFHOME/texdoc/texdoc-dist.cnf (observe la parte -dist ). Anulará completamente los otros archivos de configuración, excepto $TEXMFHOME/texdoc/texdoc.cnf que aún puede usar para su configuración personal.

Puede asegurarse de que los archivos correctos se usen ejecutando texdoc --files : la primera línea contiene la ruta completa a la versión de texdoclib.tlu usado, y el resto enumera los archivos de configuración en uso.

Archivos en este repositorio

• doc/ contiene la documentación,
• script/ contiene el código fuente,
• spec/ es un directorio para probar scripts, y
• texdoc.cnf es el archivo de configuración predeterminado.

Construcción y prueba

Muchas tareas de construcción se definen como tareas de rastrillo.

Generando toda la documentación

Lo siguiente generará tanto el PDF como la mano de la mano en doc/ Directorio.

rake doc

Generar un archivo de caché previo a la persiana

Lo siguiente generará un archivo de caché de caché preciso script/Data.tlpdb.lua . Esta tarea debe hacerse bajo una configuración de Tex Live con TLPDB.

rake gen_datafile

Pruebas de ejecución

Lo siguiente ejecutará todas las pruebas en spec/ Directory.

rake test

Alternativamente, puede dar nombres de especificaciones con la opción --list ( -l ) para esta tarea. Por ejemplo, lo siguiente solo ejecutará spec/action/help_spec.rb y spec/mode/list_spec.rb :

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

Mostrando todas las tareas disponibles

A continuación, mostrará todas las tareas disponibles con una breve descripción.

rake -T

Además de eso, para las opciones disponibles de las tareas, por ejemplo, rake test y rake run_texdoc , puede obtener información de opciones con -h opción para cada tarea:

rake test -- -h

Más información

Se puede encontrar información más específica, como la lista de TODO de este proyecto y cierta información para los distribuidores, en el wiki de nuestro repositorio de GitHub. Visite:

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

Derechos de autor y licencia

Copyright 2008-2024 Manuel Pégourié-Gonnard, Takuto Asakura, el equipo de Tex Live.

Este paquete se distribuye bajo los términos de la Licencia Pública General de GNU publicada por Free Software Foundation, ya sea la versión 3 de la licencia, o (a su opción) cualquier versión posterior.

Trabajo anterior (programa TexDoc) en el dominio público:

• Contribuciones de Reinhard Kotucha (2008).
• Primeras versiones de Texlua de Frank Küster (2007).
• Script de Shell original de Thomas Esser, David Aspinall y Simon Wilkinson.