☰

Поиск документации по Ubuntu

tag-icon • tag-icon shared-library documentation
Поиск документации по Ubuntu

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

решение1

Вы не указали используемую вами версию Ubuntu, но для Trusty есть руководство в формате PDF в формате /usr/share/doc/doxygen/doxygen_manual.pdf.

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

Я не вижу сжатого архива, кроме changelog ( /usr/share/doc/doxygen-doc/changelog.Debian.gz), который можно просмотреть с помощью zless.

решение2

Поиск документации по Ubuntu

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

Вы можете выполнить поиск, как указано выше, в/usr/share/docкаталог, но некоторые пакеты устанавливают его в свой/usr/share/имя_пакетакаталоги или даже другие места. Здесь вы можете найтиhtmlиpdfdocus, лучшее использованиенаутилус(используйте функцию поиска Nautilus и откройте нужный вам документ в вашембраузер). Если вы часто пользуетесь этим документом, не забудьте добавить ссылку в закладки.

2. Использование команды 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 job. Это автоматизирует задачу.

Вот простой скрипт bash, который можно модифицировать. Добавьте дополнительные каталоги, как описано в скрипте. Сохраните скрипт bash ниже каксделатьDoc, изменять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-базапомогает разработчикам установить его правильным образом. Чтобы просмотреть это, я знаюdhelpиdoc-центральный.

4.1 помощь: средство чтения веб-документации.

Установите его с помощью

sudo apt-get install dhelp

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

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

4.2 doc-центральный: средство чтения веб-документации.

Установите его с помощью:

sudo apt-get install doc-central
  • документация хорошо индексируется
  • документация доступна через веб-браузер
  • индексирует документацию (в фоновом режиме)
  • не очень удобный интерфейс командной строки

Связанный контент