texdoc

Texdoc - Encontre e veja a documentação no Tex Live

Informações gerais

• Site: https://www.tug.org/texdoc/
• Repositório: https://github.com/tex-live/texdoc/
• Lista de correspondência: [email protected]

Usando o texdoc

O Texdoc faz parte da distribuição Tex Live. Geralmente, você não precisa instalá -lo sozinho.

Se você quiser tentar/testar a versão de desenvolvimento, consulte abaixo.

Como instalar a versão desenvolver

Usando Bundler

A maneira mais fácil de instalar a versão desenvolver do TexDoc é usar o Bundler e o Rake:

bundle install
rake install

Se você deseja desinstalar a versão desenvolver (para usar a versão Tex Live), tente:

rake uninstall

Instalando manualmente

Aqui, $TEXDOC significa o caminho para as fontes de dev texdoc que você clonou (ou baixou) e $TEXMFHOME indica sua árvore pessoal texmf (você pode obter sua localização com kpsewhich --var-value TEXMFHOME ).

• O comando. Symlink ou copie $TEXDOC/script como $TEXMFHOME/scripts/texdoc .
• O arquivo de configuração. SyMlink ou cópia $TEXDOC/texdoc.cnf como $TEXMFHOME/texdoc/texdoc-dist.cnf (observe a parte -dist ). Ele substituirá completamente os outros arquivos de configuração, exceto $TEXMFHOME/texdoc/texdoc.cnf que você ainda pode usar para suas configurações pessoais.

Você pode garantir que os arquivos certos sejam usados ​​executando texdoc --files : a primeira linha contém o caminho completo para a versão do texdoclib.tlu usado, e o restante lista os arquivos de configuração em uso.

Arquivos neste repositório

• doc/ contém a documentação,
• script/ contém o código -fonte,
• spec/ é um diretório para testar scripts e
• texdoc.cnf é o arquivo de configuração padrão.

Construção e teste

Muitas tarefas de construção são definidas como tarefas de rake.

Gerando toda a documentação

O seguinte gerará o PDF e a mangueira no doc/ Diretório.

rake doc

Gerando um arquivo de cache pré-hashed

A seguir, gerará um script/Data.tlpdb.lua . Esta tarefa deve ser realizada sob uma configuração ao vivo do TEX com o TLPDB.

rake gen_datafile

Testes de execução

O seguinte executará todos os testes no spec/ Diretório.

rake test

Como alternativa, você pode fornecer nomes de especificações com a opção --list ( -l ) para esta tarefa. Por exemplo, a seguir executará apenas spec/action/help_spec.rb e spec/mode/list_spec.rb :

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

Mostrando todas as tarefas disponíveis

A seguir, mostrará todas as tarefas disponíveis com uma breve descrição.

rake -T

Além disso, para opções disponíveis, por exemplo, rake test e rake run_texdoc , você pode obter informações de opções com -h opção para cada tarefa:

rake test -- -h

Mais informações

Informações mais específicas, como a lista TODO deste projeto e algumas informações para distribuidores, podem ser encontradas no wiki do nosso repositório do GitHub. Visite:

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

Direitos autorais e licença

Copyright 2008-2024 Manuel Pégourié-Gonnard, Takuto Asakura, a equipe Tex Live.

Este pacote é distribuído sob os termos da licença pública geral da GNU, conforme publicado pela Free Software Foundation, versão 3 da licença ou (por sua opção) qualquer versão posterior.

Trabalho anterior (Programa Texdoc) no domínio público:

• Contribuições de Reinhard Kotucha (2008).
• Primeiras versões Texlua de Frank Küster (2007).
• Script de Shell original de Thomas Esser, David Aspinall e Simon Wilkinson.