☰

Encontrando documentação no Ubuntu

tag-icon • tag-icon shared-library documentation
Encontrando documentação no Ubuntu

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

Responder1

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

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

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

Responder2

Encontrando documentação no Ubuntu

1. Pesquise usando o nautilus ou navegador

Você pode pesquisar conforme mencionado acima no/usr/compartilhar/docdiretório, mas alguns pacotes o instalam em seu/usr/share/nome_do_pacotediretórios ou até mesmo outros locais. Aqui você pode encontrar oHTMLepdfdocus, melhor usarnáutilo(use a função de pesquisa do nautilus e abra o documento solicitado em seunavegador). Se você usa o documento com frequência, não se esqueça de adicionar seu link aos favoritos.

2. Usando o comando localizar

Na sua linha de comando você pode usar oencontrarcomando para procurar seu documento:

  • documentação html:

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

  • documentação em pdf:

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

Invoque seu resultado com 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 e pesquise e invoque com menos

Prefiro automatizar essa tarefa e fazer uma lista da seguinte forma:

  • 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

Isso criará 2 arquivos em seu diretório inicial (DocPdf.txteDocHtml.txt). Basta abrir isto commenos

less ~/DocPdf.txt

ou

less ~/DocHtml.txt

e pressione &seguido da string de pesquisa, por exemplo, doxygen. Agora basta passar o mouse sobre o documento solicitado e pressionar ctrleclique com o botão esquerdo do mouseirá abrir o arquivo.

Você também pode criar um script bash e invocá-lo por meio de um cron job. Isso automatizará a tarefa.

Aqui está um script bash simples que pode ser modificado. Coloque diretórios adicionais conforme descrito no script. Salve o script bash abaixo comofazerDoc, mudarchmod +x makeDoce invocá-lo 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 pacotebase de documentosajuda os desenvolvedores a instalá-lo da maneira correta. Para ver isso eu seiajudaedoc-central.

4.1 ajuda: leitor de documentação da base 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 através 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 base web.

Instale-o com:

sudo apt-get install doc-central
  • a documentação está bem indexada
  • a documentação está disponível através de um navegador da web
  • documentação de índices (em segundo plano)
  • interface de linha de comando não tão conveniente

informação relacionada