
Ich habe doxygen
und installiert doxygen-doc
. Die Manpage für Doxygen sagt mir, ich solle mir für weitere Informationen doxygen-doc herunterladen. Ich habe das doxygen-doc
in meinem gefunden usr/share/doc
, aber es ist ein komprimiertes Archiv. Wie kann ich also bequem darauf zugreifen?
Antwort1
Sie geben nicht an, welche Ubuntu-Version Sie verwenden, aber für Trusty gibt es ein PDF-Handbuch in /usr/share/doc/doxygen/doxygen_manual.pdf
.
Hier gibt es auch eine HTML-Dokumentation:/usr/share/doc/doxygen/html/index.html
Ich kann außer dem Änderungsprotokoll () kein komprimiertes Archiv entdecken, /usr/share/doc/doxygen-doc/changelog.Debian.gz
das Sie sich ansehen würden zless
.
Antwort2
Dokumentation zu Ubuntu finden
1. Suche mit Nautilus oder Browser
Sie können wie oben beschrieben suchen im/usr/share/docVerzeichnis, aber einige Pakete installieren es in ihrem/usr/share/paketnameVerzeichnisse oder sogar andere Orte. Hier finden Sie diehtmlUndpdfDokus, am besten mitNautilus(nutzen Sie die Suchfunktion von Nautilus und öffnen Sie das gewünschte Dokument in IhremBrowser). Wenn Sie die Dokumentation häufig verwenden, vergessen Sie nicht, den Link als Lesezeichen zu speichern.
2. Verwenden des Befehls „Find“
Von Ihrer Kommandozeile aus können Sie denfindenBefehl zum Suchen nach Ihrem Dokument:
html-Dokumentation:
find /usr/share -type f -name index.html | grep doxy
pdf-Dokumentation:
find /usr/share/ -type f -name *.pdf | grep doxy
Rufen Sie Ihr Ergebnis mit evince oder Ihrem Browser auf (in meinem Fall 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. Erstellen Sie eine Liste und suchen und rufen Sie mit weniger
Ich bevorzuge es, diese Aufgabe zu automatisieren und eine Liste folgendermaßen zu erstellen:
für html:
find /usr/share/ -type f -name index.html | sort -k1 | awk '{ print "file://" $0;}' > ~/DocHtml.txt
für pdf:
find /usr/share/ -type f -name *.pdf | sort -k1 | awk '{ print "file://" $0;}' > ~/DocPdf.txt
Dadurch werden 2 Dateien in Ihrem Home-Verzeichnis erstellt (DocPdf.txtUndDocHtml.txt). Öffnen Sie diese einfach mitweniger
less ~/DocPdf.txt
oder
less ~/DocHtml.txt
und drücken Sie, &gefolgt von Ihrem Suchbegriff, z. B. doxygen. Bewegen Sie nun einfach Ihre Maus über das gewünschte Dokument und drücken Sie ctrlundLinksklicköffnet die Datei.
Sie können auch ein Bash-Skript erstellen und es über einen Chron-Job aufrufen. Dadurch wird die Aufgabe automatisiert.
Hier ist ein einfaches Bash-Skript, das geändert werden kann. Fügen Sie zusätzliche Verzeichnisse hinzu, wie im Skript beschrieben. Speichern Sie das folgende Bash-Skript alsDoc erstellen, ändernchmod +x makeDocund rufe es auf mit./doc erstellen. Rest wie oben:
#!/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-Paketlösung
Das Paketdoc-basishilft Entwicklern, es richtig zu installieren. Um dies anzuzeigen, weiß ichHilfeUnddoc-zentral.
4.1 dhilfe: webbasierter Dokumentationsleser.
Installieren Sie es mit
sudo apt-get install dhelp
und öffnen Sie die Datei in Ihrem Browser:
file:///usr/share/doc/HTML/Programming/Awk/index.html
- Dokumentation ist gut indiziert
- Die Dokumentation ist über einen Webbrowser verfügbar
- Indizes Dokumentation (im Hintergrund)
- nicht so praktische Befehlszeilenschnittstelle.
4.2 doc-zentral: webbasierter Dokumentationsleser.
Installieren Sie es mit:
sudo apt-get install doc-central
- Dokumentation ist gut indiziert
- Die Dokumentation ist über einen Webbrowser verfügbar
- Indizes Dokumentation (im Hintergrund)
- nicht so praktische Befehlszeilenschnittstelle