Система справки KDE

Система справки KDE задумана так, чтобы сделать доступ к обычным системам справки Unix (man и info) столь же простым, как к системе документации KDE (HTML).

Использование справки KDE

Система справки может быть вызвана указанием URL нужного файла, например:

kdehelp file:/usr/local/src/qt/html/index.html

URL-ссылки также были добавлены для info и man, например:

kdehelp info:"(gcc)G++ and GCC"

kdehelp man:strcpy

Если параметры командной строки не указаны, то показывается индекс (на данный момент он содержит только ссылки на каталоги с man и info, но в будущем добавятся ссылки на справочную документацию к различным приложениям KDE). Кроме того, файл или URL можно открыть используя меню или перетаскивая его из файл-менеджера KDE -- kfm.

Как осуществлять навигацию в системе справки

Навигация внутри системы справки осуществляется щелканьем по ссылкам внутри документов, использованием пунктов меню Идти и панели инструментов.

Содержание

Если система справки запускается без указания в командной строке местоположения начального документа, показывается Содержание. Первый раздел его состоит из общей информации о проекте KDE. Во втором разделе приведены ссылки на документацию к отдельным приложениям/командам. Документация по приложениям и системе разделена на три части:

Индекс справки к приложениям KDE
Собственно документация к приложениям KDE. Все приложения KDE имеют документацию, написанную в HTML. Этот раздел дает список всех приложений KDE c коротким описанием и ссылкой на полную документацию к приложению.
Страницы руководств "man"
UNIX man-страницы -- это традиционный интерактивный формат документации, принятый в системах Unix. Большинство программ вашей системы будут иметь страницу man. Кроме того, man-страницы существуют для программных функций и форматов файлов.
Система Info
Документация в формате TeXinfo используется для многих приложений GNU, включая gcc (компилятор C/C++), emacs, и многих других.

В любой момент вы можете вернуться к Содержанию, выбрав пункт Содержание в меню Идти или на панели инструментов.

"Назад" и "Вперед"

Это команды истории. Назад переведет вас на предыдущую страницу, в то время как Вперед переместит вас следующую страницу, из посещенных вами. Список истории на данный момент помнит 50 адресов, но в будущем, возможно, этот параметр можно будет настраивать.

"Предыдущий", "Следующий", "Верх", "Вверх"

Вы распознаете эти команды, если вы когда-либо использовали систему info. Документы info имеют иерархию, в которой каждая страница называется "узел". Все документы info имеют Верхний узел, то есть заглавную страницу. Вы можете вернуться к Верхнему узлу щелчком по пункту меню "Верх".

Предыдущий и Следующий используются для перемещения на предыдущую/следующую страницу на текущем уровне иерархии.

Щелчок по пункту меню внутри документа переводит вас на более низкий уровень в иерархии. Вы можете вернуться на более высокий уровень щелчком по пункту меню Вверх.

"Man" страницы обрабатываются аналогично страницам "info", при этом раздел индексации является Верхним узлом, а каждая страница man находится уровнем ниже.

Поиск

Вы можете вести поиск страниц man, используя пункт Искать... в меню Файл. При щелчке на этот пункт появляется страница поиска и предлагает вам ввести строку поиска. Вы можете искать в любой системе справки из трех по выбору: KDE, man, или info. Щелчок по кнопке "Начать поиск" (Submit Search) показывает список найденных страниц для каждой категории, из выбранных вами. Строки списка отсортированы по лучшему совпадению с заданной строкой. Совпавшие с поиском страницы man перечисляются в порядке, заданном командой apropos.

Поиск документов info пока не сделан.