Как просмотреть документацию для установленной библиотеки?

Я установил doxygen и doxygen-doc. Страница справочника для doxygen говорит мне получать doxygen-документ для получения дополнительной информации. Я нашел doxygen-doc в моем usr/share/doc, но это - сжатый архив. Таким образом, как я могу получить доступ к нему удобно?

4
задан 25 November 2014 в 08:35

2 ответа

Вы не заявляете версию Ubuntu, который Вы используете, но для Надежного человека, существует руководство PDF в /usr/share/doc/doxygen/doxygen_manual.pdf.

здесь существует также документация HTML: /usr/share/doc/doxygen/html/index.html

я не могу разыскать сжатый архив помимо журнала изменений (/usr/share/doc/doxygen-doc/changelog.Debian.gz), что Вы посмотрели бы на использование zless.

2
ответ дан 17 November 2019 в 04:44

Нахождение Документации относительно человечности

1. Поиск с помощью наутилуса или браузера

Можно искать, как упомянуто выше в/usr/share/doc каталоге, но некоторые пакеты устанавливают его в своих/usr/share/package_name каталогах или даже других местоположениях. Здесь можно найти HTML и PDF docus, лучше всего с помощью наутилуса (используйте поисковую функцию наутилуса и откройте требуемый docu в браузере). Если Вы часто используете docu, не забывают отмечать Вашу ссылку.

2. Используя команду находки

Из Вашей командной строки можно использовать команду находки для поиска docu:

  • документация HTML:

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

  • pdf-documention:

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

Вызовите свой результат с, проявляют или Ваш браузер (в моем случае 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. Составьте список и ищите и вызовите с меньше

Я предпочитаю автоматизировать эту задачу и входить в список следующий путь:

  • для HTML:

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

  • для PDF:

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

Это создаст 2 файла в Вашем корневом каталоге (DocPdf.txt и DocHtml.txt). Просто откройте это с меньше

less ~/DocPdf.txt

или

less ~/DocHtml.txt

и нажмите и сопровождаемый с Вашей строкой поиска, например, doxygen. Теперь простое перемещение Ваша мышь по требуемому документу и нажатию ctrl и нажатию левой кнопки мышки откроет файл.

Можно также сделать сценарий удара и вызвать его через chron задание. Это автоматизирует задачу.

Вот простой сценарий удара, который может быть изменен. Поместите дополнительные каталоги, как описано в сценарий. Сохраните ниже сценария удара как makeDoc, chmod +x makeDoc изменения и вызовите его с./makeDoc. Отдых как выше:

#!/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

Основа документа пакета помогает разработчикам установить его корректным способом. Для просмотра этого, я знаю dhelp и центральный документом.

4.1 dhelp: веб-основной читатель документации.

Установите его с

sudo apt-get install dhelp

и откройте в своем браузере файл:

file:///usr/share/doc/HTML/Programming/Awk/index.html
  • документация хорошо индексируется
  • документация доступна через веб-браузер
  • индексная документация (в фоновом режиме)
  • не так удобный интерфейс командной строки.

4,2 центральных документом: веб-основной читатель документации.

Установите его с:

sudo apt-get install doc-central
  • документация хорошо индексируется
  • документация доступна через веб-браузер
  • индексная документация (в фоновом режиме)
  • не так удобный интерфейс командной строки
2
ответ дан 1 December 2019 в 09:49

Другие вопросы по тегам:

Похожие вопросы: