web-dev-qa-db-fra.com

Comment afficher la documentation d'une bibliothèque installée?

J'ai installé doxygen et doxygen-doc. La page de manuel de doxygen me dit d’obtenir doxygen-doc pour plus d’informations. J'ai trouvé le doxygen-doc dans mon usr/share/doc, mais c'est une archive compressée. Alors, comment puis-je y accéder facilement?

shared-librarydocumentation
3
user10607

Vous n'indiquez pas la version d'Ubuntu que vous utilisez, mais pour Trusty, il existe un manuel PDF dans /usr/share/doc/doxygen/doxygen_manual.pdf.

Il y a aussi une documentation HTML ici: /usr/share/doc/doxygen/html/index.html

Je ne peux pas repérer une archive compressée en plus du journal des modifications (/usr/share/doc/doxygen-doc/changelog.Debian.gz) que vous utiliseriez avec zless.

2
Jan

Recherche de documentation sur Ubuntu

1. Recherche avec nautile ou navigateur

Vous pouvez effectuer une recherche comme indiqué ci-dessus dans le répertoire / usr/share/doc, mais certains paquets l'installent dans leurs répertoires / usr/share/nom_du_paquet ou même à d'autres emplacements. Ici vous pouvez trouver les html et pdf docus, utilisez de préférence nautilus (utilisez la fonction de recherche de nautilus et ouvrez le document que vous avez demandé dans - navigateur). Si vous utilisez souvent le document, n'oubliez pas de mettre votre lien en signet.

2. Utilisation de la commande find

À partir de votre ligne de commande, vous pouvez utiliser la commande find pour rechercher votre document:

  • documentation html:

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

  • documentation pdf:

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

Invoquez votre résultat avec evince ou votre navigateur (dans mon cas, 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. Faites une liste et recherchez et invoquez avec moins

Je préfère automatiser cette tâche et dresser une liste de la manière suivante:

  • pour html:

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

  • pour pdf:

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

Cela créera 2 fichiers dans votre répertoire personnel ( DocPdf.txt et DocHtml.txt ). Ouvrez simplement ceci avec moins

less ~/DocPdf.txt

ou

less ~/DocHtml.txt

et appuyez sur & suivi de votre chaîne de recherche, par exemple doxygen. Maintenant, déplacez simplement votre souris sur le document demandé et appuyez sur ctrl et clic gauche ouvrira le fichier.

Vous pouvez également créer un script bash et l'invoquer via un travail chron. Cela automatisera la tâche.

Voici un script bash simple qui peut être modifié. Mettez des répertoires supplémentaires comme décrit dans le script. Enregistrez le script bash ci-dessous sous le nom makeDoc, modifiez chmod + x makeDoc et appelez-le avec ./ makeDoc. Reste comme ci-dessus:

#!/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. APT Solution de package

Le paquetage doc-base aide les développeurs à l’installer correctement. Pour voir cela, je sais dhelp et doc-central.

4.1 dhelp: lecteur de documentation de base Web.

Installez-le avec

Sudo apt-get install dhelp

et ouvrez dans votre navigateur le fichier:

file:///usr/share/doc/HTML/Programming/Awk/index.html
  • la documentation est bien indexée
  • la documentation est disponible via un navigateur Web
  • indexe la documentation (en arrière plan)
  • interface de ligne de commande pas si pratique.

4.2 doc-central: lecteur de documentation de base Web.

Installez-le avec:

Sudo apt-get install doc-central
  • la documentation est bien indexée
  • la documentation est disponible via un navigateur Web
  • indexe la documentation (en arrière plan)
  • interface de ligne de commande pas très pratique
1
abu_bua