texdoc

Colaboração: Ricardo Nabinger Sanchez

Data de Publicação: 30 de Julho de 2005

O texdoc é um utilitário para auxiliar na busca e utilização da documentação do TeX, uma ferramenta muito poderosa para processamento de textos. A implementação mais madura e conhecida é a teTeX (http://www.tug.org/teTeX/).

Sua utilização no Unix (e semelhantes) é bastante simples, como mostra este exemplo:

  $ texdoc fullpage

O texdoc irá procurar a documentação relativa ao elemento desejado (pacote fullpage, neste caso), e, se encontrar algo, abrirá um programa relacionado com o formato da documentação encontrada. Ou seja, se o texdoc encontrar um HTML relacionado ao item procurado, ele abrirá a documentação no navegador.

Além de HTML, a documentação pode estar no formato DVI, PDF, PostScript ou mesmo texto puro. O texdoc abrirá por padrão, respectivamente, o xdvi, acroread, ghostview ou more no terminal (ou o paginador que estiver definido na variável $PAGER).

É possível apenas realizar uma busca, ao invés de disparar um programa de visualização assim que o texdoc encontrar algo, com o parâmetro -l:

  $ texdoc -l fullpage
  /usr/share/texmf/doc/latex/preprint/fullpage.dvi
  /usr/share/texmf/doc/help/Catalogue/entries/fullpage.html

Também é possível ver o comando usado para disparar o visualizador, com o parâmetro -v:

  $ texdoc -v fullpage
  xdvi /usr/share/texmf/doc/latex/preprint/fullpage.dvi &

É possível alterar os visualizadores que o texdoc executará, definindo valores adequados para as seguintes variáveis do shell: $TEXDOCVIEW_dvi, $TEXDOCVIEW_pdf, $TEXDOCVIEW_ps, $TEXDOCVIEW_html e $TEXDOCVIEW_txt, como mostra este exemplo para bash/zsh:

  $ export TEXDOCVIEW_ps="gv %s"

e para tcsh/csh:

  % setenv TEXDOCVIEW_ps "gv %s"

O %s será substituído pela referência ao arquivo da documentação, para que o visualizador possa abrí-lo. Dessa forma, quanto o texdoc encontrar uma documentação em formato PostScript, ele invocará o gv para a visualização.