Документация UNIX

Основным источником информации почти по любому вопросу в UNIX являются страницы экранной документации – manual pages, которые можно просмотреть с помощью команды man.

Использование команды man

Для отображения информации на экране программа man использует т.н. пейджер (pager) more или less. Соответственно, при просмотре информации (для навигации по справочной странице, поиске и т.д.) используются команды запущенного пейджера. Получить помощь по этим командам всегда можно, нажав клавишу h. Выход из пейджера осуществляется с помощью команды q. Поиск информации осуществляется с помощью команд / (вперед) и ? (назад), после которых указывается шаблон для поиска.

Для получения более подробной справки по встроенной документации в UNIX используйте команду man man

Разделы man страниц

Справочная информация делится на разделы. Вот список разделов, характерный для системы FreeBSD 7.2:

1 FreeBSD General Commands Manual
2 FreeBSD System Calls Manual
3 FreeBSD Library Functions Manual
4 FreeBSD Kernel Interfaces Manual
5 FreeBSD File Formats Manual
6 FreeBSD Games Manual
7 FreeBSD Miscellaneous Information Manual
8 FreeBSD System Manager's Manual
9 FreeBSD Kernel Developer's Manual

Иногда страницы с одинаковыми именами могут располагаться в нескольких разделах. В этом случае для получения нужной информации необходимо указывать номер нужного раздела. Пример:

man passwd
man 5 passwd

Секции man страниц

Страницы справки поделены на секции, каждая из которых имеет название и содержит соответствующую информацию. На разных справочных страницах состав секций может быть различным, при этом три секции являются обязательными (NAME, SYNOPSIS и DESCRIPTION). Ниже приведены наиболее часто встречающиеся секции:

NAME – имя страницы с очень кратким описанием предмета (одна строка)
SYNOPSIS – синопсис, краткий обзор
DESCRIPTION – полное описание предмета справки
ENVIRONMENT – используемые переменные окружения
EXIT STATUS – коды возврата программ
EXAMPLES – примеры использования
SEE ALSO – рекомендуемые man страницы для получения дополнительной информации

Поиск man страниц

Для поиска нужной страницы справочного руководства используются команды whatis (аналог man f) и apropos (аналог man k). Обе команды производят поиск по индексу, составленнму из секций NAME всех справочных страниц. При этом команда whatis ищет целое слово, переданное в качестве параметра, а apropos – использует параметр как шаблон для поиска (расширенное регулярное выражение) и игнорирует границы слов. Для построения нового индекса (например, при изменении состава man страниц) используется команда makewhatis.