Como visualizar a documentação de uma biblioteca instalada?

Question

Eu instalei doxygen e doxygen-doc . A página man do doxygen diz-me para obter o doxygen-doc para mais informações. Eu encontrei o doxygen-doc no meu usr/share/doc , mas é um arquivo compactado. Então, como posso acessá-lo convenientemente?

    

Answer 1

Você não indica a versão do Ubuntu que você usa, mas, para a Trusty, há um manual em PDF em /usr/share/doc/doxygen/doxygen_manual.pdf .

Também há documentação em HTML aqui: /usr/share/doc/doxygen/html/index.html

Não consigo localizar um arquivo compactado além do log de alterações ( /usr/share/doc/doxygen-doc/changelog.Debian.gz ) que você usaria usando zless .

    

Answer 2

Encontrando Documentação no Ubuntu

1. Pesquise usando nautilus ou navegador

Você pode pesquisar como mencionado acima no diretório / usr / share / doc , mas alguns pacotes o instalam em seus diretórios / usr / share / package_name ou até mesmo em outros Localizações. Aqui você pode encontrar o docus html e pdf , usando melhor nautilus (use a função de busca do nautilus e abra o seu documento solicitado no seu > navegador ). Se você costuma usar o documento, não se esqueça de marcar seu link como favorito.

2. Usando o comando find

Na sua linha de comando, você pode usar o comando find para procurar pelo seu documento:

• html-documentation:

  find /usr/share -type f -name index.html | grep doxy

• pdf-documention:

  find /usr/share/ -type f -name *.pdf | grep doxy

Invoque seu resultado com o evince ou seu navegador (no meu caso, google-chrome)

• html:

  google-chrome /usr/share/doc/doxygen/html/index.html

• pdf:

  google-chrome /usr/share/doc/doxygen_manual.pdf

  evince /usr/share/doc/doxygen_manual.pdf

3. Faça uma lista, pesquise e invoque com menos

Eu prefiro automatizar essa tarefa e fazer uma lista da seguinte maneira:

• para html:

  find /usr/share/ -type f -name index.html | sort -k1 | awk '{ print "file://" $0;}' > ~/DocHtml.txt

• para pdf:

  find /usr/share/ -type f -name *.pdf | sort -k1 | awk '{ print "file://" $0;}' > ~/DocPdf.txt

Isto irá criar 2 arquivos em seu diretório home ( DocPdf.txt e DocHtml.txt ). Simplesmente abra isto com menos

less ~/DocPdf.txt

ou

less ~/DocHtml.txt

e pressione & amp; seguido de sua string de pesquisa, por exemplo doxygen. Agora, basta mover o mouse sobre o documento solicitado e pressionar ctrl e o clique com o botão esquerdo do mouse abrirá o arquivo.

Você também pode criar um script bash e invocá-lo por meio de um trabalho crônico. Isso automatizará a tarefa.

Aqui está um script simples que pode ser modificado. Coloque diretórios adicionais conforme descrito no script. Salve o script abaixo como makeDoc , altere chmod + x makeDoc e invoque-o com ./ makeDoc . Descanse como acima:

#!/bin/bash
# Author: abu
# Description: script creates two files, DocPdf.txt and DocHtml.txt, 
#   which lists all pdf/html documents found by the find function.
#
#   You can include other search directories, e.g. Anaconda, 

declare -a DocDirs=(
    "/usr/share/"
    "/opt/anaconda3/"       # you can put here additional  directories
#   "/path/to/other/dirs/"  # -""-     -""-    -""-
)

echo "DocHtml automatic generated!" > DocHtml.txt
echo "   File generated with" $0 >> DocHtml.txt
echo -e "   Date: " 'date' "\n\n" >> DocHtml.txt

echo "DocPdf automatic generated!" > DocPdf.txt
echo "   File generated with" $0 >> DocPdf.txt
echo -e "   Date: " 'date' "\n\n" >> DocPdf.txt

for i in "${DocDirs[@]}"
do
    find $i -type f -name index.html | sort -k1 | awk '{ print "file://" $0;}' >> ~/DocHtml.txt
    find $i -type f -name *.pdf | sort -k1 | awk '{ print "file://" $0;}' >> ~/DocPdf.txt
done

4. Solução de pacote APT

O pacote doc-base ajuda os desenvolvedores a instalá-lo da maneira correta. Para ver isso, eu sei dhelp e doc-central .

4.1 dhelp : leitor de documentação da base da web.

Instale-o com

sudo apt-get install dhelp

e abra no seu navegador o arquivo:

file:///usr/share/doc/HTML/Programming/Awk/index.html

• a documentação está bem indexada
A documentação
• está disponível por meio de um navegador da web
Documentação de índices
• (em segundo plano)
• interface de linha de comando não tão conveniente .

4.2 doc-central : leitor de documentação da web.

Instale-o com:

sudo apt-get install doc-central

• a documentação está bem indexada
A documentação
• está disponível por meio de um navegador da web
Documentação de índices
• (em segundo plano)
• interface de linha de comando não tão conveniente