Контекстная справка по команде
Многие команды являются самодокументированными и отображают справку по использованию при вызове команды с опцией --help, например,
ls --help
Использование страниц руководства
Основным источником получения справки являются так называемые страницы руководства — manual pages (John Eaton, 1990). Для отображения справочной страницы по заданному ключевому слову следует исполнить команду
man номер_раздела ключевое_слово
Справочная страница содержит следующие типовые разделы
| # | Описание | Название |
|---|---|---|
| 1 | Имя команды (или объекта, для которого вызвана справка) | NAME |
| 2 | Синтаксис вызова с перечнем допустимых опций | SYNOPSIS |
| 3 | Подробное описание команды | DESCRIPTION |
| 4 | Перечень и описание допустимых опций | OPTIONS |
| 5 | Аспекты взаимодействия со средой, окружением | ENVIRONMENT |
| 6 | Ссылки на смежные страницы | SEE ALSO |
| 7 | Сведения об авторах программы | AUTHORS |
| 8 | Известные проблемы и обнаруженные ошибки | BUGS |
Страницы сгруппированы по разделам. Если номер раздела не указан, то man выводит страницу с меньшим найденным номером. Для вывода всех страниц по заданному клчевому слову следует воспользоваться опцией -a.
| # | Описание | Примечание |
|---|---|---|
| 1 | Команды shell и утилиты | |
| 2 | Системные вызовы ОС | Функции ядра системы |
| 3 | Библиотечные вызовы | В том числе стандартная библиотека Си |
| 4 | Специальные файлы | Преимущественно из каталога /dev |
| 5 | Соглашения о форматах файлов | Например, /etc/passwd |
| 6 | Игровые программы | |
| 7 | Разное | В основном макропакеты |
| 8 | Административные утилиты | Доступные пользователю root |
| 9 | Документация по ядру | Не стандартизовано |
Пользователь может осуществлять поиск по man-странице, команда /выражение — поиск в прямом направлении, ?выражение — в обратном, n — поиск следующего вхождения в прямом направлении, N — поиск следующего вхождения в обратном направлении. Выйти из справочника можно командой q. Краткое описание команды можно получить с помощью whatis. Поиск по базе данных whatis осуществляется с помощью команды apropos.
Справочная система info
В последние годы все большую популярность завоевывает гипертекстовая справочная система info. Организация справочной системы info — иерархическая, вся документация сведена в единое дерево, в котором документы (так называемые ноды) являются узлами. Текст каждой ноды может содержать гиперссылки на другие ноды. Пользователь может перемещаться по дереву справочника с помощью команд:
| # | Описание | На клавиатуре |
|---|---|---|
| 1 | Пролистать текст узла на страницу вниз | PgDn |
| 2 | Пролистать текст узла на страницу вверх | PgUp |
| 3 | Перейти по ссылке под курсором | Enter |
| 4 | Перейти к заданной именем ноде | g |
| 5 | Перейти на следующий узел того же родителя | n |
| 6 | Перейти на предыдущий узел того же родителя | p |
| 7 | Перейти на родительский узел | u |
| 8 | Перейти на предыдущий посещенный узел | l |
| 9 | Выбор пункта меню | m |
| 10 | Перейти по указанной ссылке | f |
| 11 | Перейти на локальный корневой узел | t |
| 12 | Перейти на абсолютный корневой узел | d |
| 13 | Поиск по текущему узлу | s |
| 14 | Выход из справочника | q |
