Как просмотреть документацию для установленной библиотеки?
Я установил doxygen
а также doxygen-doc
, Страница man для doxygen говорит мне получить doxygen-doc для получения дополнительной информации. Я нашел doxygen-doc
в моем usr/share/doc
, но это сжатый архив. Так как я могу получить к нему удобный доступ?
2 ответа
Вы не указываете версию Ubuntu, которую используете, но для Trusty есть руководство в формате 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
,
Поиск документации по Ubuntu
1. Поиск с использованием наутилуса или браузера
Вы можете искать, как указано выше, в каталоге / usr / share / doc, но некоторые пакеты устанавливают его в свои каталоги / usr / share / package_name или даже в другие места. Здесь вы можете найти html и pdf docus, лучше всего использовать nautilus (используйте функцию поиска nautilus и откройте запрошенный вами документ в вашем браузере). Если вы часто используете документ, не забудьте добавить в закладки вашу ссылку.
2. Используя команду find
Из командной строки вы можете использовать команду find для поиска вашего документа:
HTML-документы:
find /usr/share -type f -name index.html | grep doxy
PDF-справка о:
find /usr/share/ -type f -name *.pdf | grep doxy
Вызвать свой результат с помощью evince или браузера (в моем случае 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, и щелчок левой кнопкой мыши откроет файл.
Вы также можете создать скрипт bash и вызывать его через задание chron. Это автоматизирует задачу.
Вот простой скрипт bash, который можно изменить. Поместите дополнительные каталоги, как описано в скрипте. Сохраните приведенный ниже скрипт bash как 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
Пакет doc-base помогает разработчикам правильно его установить. Для просмотра я знаю dhelp и doc-central.
4.1 dhelp: читатель документации веб-базы.
Установите его с
sudo apt-get install dhelp
и откройте в вашем браузере файл:
file:///usr/share/doc/HTML/Programming/Awk/index.html
- документация хорошо проиндексирована
- документация доступна через веб-браузер
- Документация по индексам (в фоновом режиме)
- Не очень удобный интерфейс командной строки.
4.2 doc-central: читатель документации веб-базы.
Установите его с помощью:
sudo apt-get install doc-central
- документация хорошо проиндексирована
- документация доступна через веб-браузер
- Документация по индексам (в фоновом режиме)
- не очень удобный интерфейс командной строки