С точки зрения Linux все man-страницы в системе являются частью единого руководства, состоящего из следующих разделов:
- 1 — исполняемые программы или команды оболочки;
- 2 — системные функции;
- 3 — библиотечные функции;
- 4 — специальные файлы (обычно находящиеся в /dev);
- 5 — форматы файлов и соглашения;
- 6 — игры;
- 7 — разное;
- 8 — команды системного администрирования;
- 9 — нестандартные функции ядра;
- n — новая документация, которая позднее может быть перемещена;
- l — локальная документация, специфическая для вашей системы.
Каждая отдельная программа, утилита или функция представлена в этом руководстве отдельной страницей. Поиск страницы для программы или команды обычно сводится к вводу команды man foo, где foo — имя программы.
Попадаются, также, и нумерованные ссылки на man-страницы вида cvs(l). Такая ссылка обозначает страницу man cvs из раздела 1. Она вызывается следующим образом:
$ man 1 cvs
Некоторые man-страницы входят в несколько секций. Команда man cvs, например, отобразит только первую из них. Для получения полного списка следует указать ключ -f:
$ man -f cvs
cvs (1) - Concurrent Versions System
cvs (5) - Concurrent Versions System support files
Каждая man-страница делится на секции. Имена секций бывают разными, но чаще всего встречаются следующие: NAME, SYNOPSIS, DESCRIPTION, OPTIONS, FILES, EXAMPLES, SEE ALSO, BUGS and AUTHOR.
Описание синтаксиса команды находится в секции SYNOPSISman-страницы и выглядит следующим образом: имя_команды [необязательные ключи] обязательные_элементы.
При описании ключей команды используются следующие обозначения:
- жирный шрифт — вводится точно так, как показано;
- курсив — обозначает аргумент, заменяемый конкретным значением. В зависимости от используемой программы просмотра вместо курсива может использоваться подчеркивание текста или жирный шрифт;
- [-abc] — все ключи в квадратных скобках являются необязательными и их можно комбинировать друг с другом;
- [-a|-b|-c] — ключи, разделенные символом “|” (вертикальная черта), не могут комбинироваться друг с другом;
- аргумент... — многоточие означает, что в данной позиции допускается перечисление нескольких аргументов. Элементы списка обычно разделяются пробелами, но иногда вместо них используются запятые;
- [выражение]... — многоточие означает, что в данной позиции допускается перечисление нескольких выражений.
Короткие ключи могут вводиться в двух форматах: -abc или -a -b -c. Длинные ключи всегда перечисляются по отдельности и обозначаются двойными дефисами: --optionl --option2 --option3. Длинные ключи особенно полезны в сценариях; их содержательные имена помогают вспомнить, что делает сценарий.
Список ключей занимает большую часть объема man-страницы.