Использование справочных ресурсов

Справочные страницы онлайн-руководства (так называемые man-страницы, поскольку их можно просмотреть с помощью команды man) составляют традиционную “интерактивную” документацию. Эти материалы в основном инсталлируются вместе с ОС, а справочные страницы отдельных программ – вместе с соответствующим пакетом.

Интерактивное руководство содержит краткое описание отдельных команд, драйверов, форматов файлов и библиотечных функций.

Во всех ОС справочные страницы обычно делятся на разделы, при этом возможны небольшие вариации на тему принципов такого разделения.

Некоторые разделы делятся на подразделы. Точная структура разделов не так уж важна, поскольку команда man находит соответствующую страницу в большинстве случаев. При этом в нескольких разделах может быть одно и то же имя: в этом случае важно указать нужный раздел. Например, passwd – это и команда, и файл конфигурации, поэтому необходимые статьи есть в соответствующих разделах.

Команда man

Команда:

man раздел заголовок

вызывает справочную страницу из указанного раздела. Например, команда man sync вызывает справочную страницу для команды sync, а команда man 2 sync для системного вызова sync.

Команда man -k ключевoe_слово или apropos ключевое_слово выводит список справочных страниц, в строке пояснений к которым имеется указанное ключевое слово.

man -k translate
objcopy (1) copy and translate object files
dcgettext (3) translate message
tr (1) translate or delete characters
snmptranslate (1) translate SNMP OID values into more useful information
tr (lp) translate characters

База данных ключевых слов может устаревать. При добавлении новых справочных страниц к ОС, возможно, придется перестроить (перекомпоновать) БД с помощью команды makewhatis.

Хранение страниц интерактивного руководства

Неформатированная информация для справочных страниц (входные данные команды nroff) обычно хранится в подкаталогах каталога /usr/share/man. В целях экономии места на диске ОС сжимает страницы с помощью утилиты Gzip (команда man может очень быстро разархивировать их). Команда man поддерживает кеш отформатированных страниц в каталогах /var/cache/man или /usr/share/man, если соответствующие каталоги доступны для записи, но эти операции рискованны с точки зрения безопасности.

Команда man ищет страницы в ряде каталогов. В ОС выяснить путь поиска позволяет команда manpath:

manpath
/usr/local/man:/usr/local/Share/man:/usr/Share/man

Эта установка хранится в переменной среды MANPATH, и в случае необходимости ее можно изменить.

export MANPATH=/home/Share/localman:/usr/Share/man

Команда TLDR

В качестве альтернативы для получения справочной информации используют утилиту tldr ("Too long; didn't read") для лаконичности документации в консоли.

Утилита tldr доступна из репозитория ОС и устанавливается командой:

sudo dnf in tldr -y

Например, для получения tldr-справки по tar выполняется команда:

tldr tar

Вывод команды содержит минимальное описание назначения утилиты и компактный список из самых частых команд (Рисунок 1).

Рисунок 1 - Справка по tar