☰

Encontrar documentación en ubuntu

tag-icon • tag-icon shared-library documentation
Encontrar documentación en ubuntu

Instalé doxygeny doxygen-doc. La página de manual de doxygen me dice que obtenga doxygen-doc para obtener más información. Encontré el doxygen-docen mi usr/share/doc, pero es un archivo comprimido. Entonces, ¿cómo puedo acceder cómodamente?

Respuesta1

No indicas la versión de Ubuntu que usas, pero para Trusty, hay un manual en PDF en formato /usr/share/doc/doxygen/doxygen_manual.pdf.

También hay documentación HTML aquí:/usr/share/doc/doxygen/html/index.html

No puedo detectar un archivo comprimido además del registro de cambios ( /usr/share/doc/doxygen-doc/changelog.Debian.gz) que mirarías usando zless.

Respuesta2

Encontrar documentación en ubuntu

1. Buscar usando nautilus o navegador

Puede buscar como se mencionó anteriormente en el/usr/compartir/docdirectorio, pero algunos paquetes lo instalan en su/usr/share/nombre_paquetedirectorios o incluso otras ubicaciones. Aquí puedes encontrar elHTMLypdfdocus, mejor usonautilo(use la función de búsqueda de nautilus y abra el documento solicitado en sunavegador). Si utiliza el documento con frecuencia, no olvide marcar su enlace como favorito.

2. Usando el comando buscar

Desde su línea de comando puede usar elencontrarcomando para buscar su documento:

  • documentación html:

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

  • documentación-pdf:

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

Invoca tu resultado con evince o tu navegador (en mi 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. Haz una lista y busca e invoca con menos

Prefiero automatizar esta tarea y hacer una lista de la siguiente manera:

  • 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

Esto creará 2 archivos en su directorio de inicio (DocumentoPdf.txtyDocHtml.txt). Simplemente abre esto conmenos

less ~/DocPdf.txt

o

less ~/DocHtml.txt

y presione &seguido con su cadena de búsqueda, por ejemplo, doxygen. Ahora simplemente mueva el mouse sobre el documento solicitado y presione ctrlyclic izquierdo del mouseabrirá el archivo.

También puedes crear un script bash e invocarlo mediante un trabajo cronológico. Esto automatizará la tarea.

Aquí hay un script bash simple que se puede modificar. Coloque directorios adicionales como se describe en el script. Guarde el siguiente script bash comohacerDoc, cambiarchmod +x crearDoce invocarlo con./makeDoc. Descanse como arriba:

#!/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. Solución de paquete APT

El paquetebase de documentosayuda a los desarrolladores a instalarlo de la forma correcta. Para ver esto lo séayudaydoc-central.

4.1 ayuda: lector de documentación base web.

instalarlo con

sudo apt-get install dhelp

y abre en tu navegador el archivo:

file:///usr/share/doc/HTML/Programming/Awk/index.html
  • La documentación está bien indexada.
  • La documentación está disponible a través de un navegador web.
  • documentación de índices (en segundo plano)
  • Interfaz de línea de comando no tan conveniente.

4.2 central de documentos: lector de documentación base web.

Instálalo con:

sudo apt-get install doc-central
  • La documentación está bien indexada.
  • La documentación está disponible a través de un navegador web.
  • documentación de índices (en segundo plano)
  • interfaz de línea de comando no tan conveniente

información relacionada