1.2. Общие сведения о man-страницах

Проблема

Вы пытаетесь использовать какую-нибудь программу, но никак не можете заставить её сделать то, что требуется. Следуя стандартному совету «RTFM» (Read The Fine Man page), вы находите нужные страницы, читаете их... и ничего не можете понять.

Решение

Разберитесь в структуре man-страниц; изучите условные обозначения команд и их параметры, и вы поймёте, что man-страницы на самом деле очень полезны.

С точки зрения Linux все man-страницы в системе являются частью единого руководства. Это руководство состоит из следующих разделов:

• 1 — исполняемые программы или команды оболочки;
• 2 — системные функции;
• 3 — библиотечные функции;
• 4 — специальные файлы (обычно находящиеся в /dev);
• 5 — форматы файлов и соглашения;
• 6 — игры;
• 7 — разное;
• 8 — команды системного администрирования;
• 9 — нестандартные функции ядра;
• n — новая документация, которая позднее может быть перемещена;
• 1 — локальная документация, специфическая для вашей системы.

Каждая программа, утилита или функция представлена в этом руководстве отдельной страницей. Поиск страницы для программы или команды обычно сводится к вводу команды man foo, где foo — имя программы.

Вероятно, вам также попадались нумерованные ссылки на man-страницы вида grep(1). Такая ссылка обозначает страницу man для команды grep из раздела 1. Она вызывается следующим образом:

$ man 1 grep

Некоторые man-страницы входят в несколько разделов. Команда man foo отобразит только первую из них. Для получения полного списка следует указать ключ -f:

$ man -f man
man (1) — an interface to the online reference manuals
man (7) — macros to format man pages

Каждая man-страница делится на секции. Имена секций бывают разными, но чаще всего встречаются следующие: NAME, SYNOPSIS, DESCRIPTION, OPTIONS, FILES, EXAMPLES, SEE ALSO, BUGS, AUTHOR.

Описание синтаксиса команды находится в секции SYNOPSIS man-страницы и выглядит следующим образом:

имя_команды [необязательные ключи] обязательные_элементы

При описании ключей команды используются следующие обозначения:

• Жирный шрифт — вводится точно так, как показано;
• Курсив — обозначает аргумент, заменяемый конкретным значением. В зависимости от программы просмотра вместо курсива может использоваться подчеркивание текста или жирный шрифт;
• [-abc] — все ключи в квадратных скобках являются необязательными и их можно комбинировать друг с другом;
• [-a|-b|-c] — ключи, разделённые символом «|» (вертикальная черта), не могут комбинироваться друг с другом;
• аргумент... — многоточие означает, что в данной позиции допускается перечисление нескольких аргументов. Элементы списка обычно разделяются пробелами, но иногда вместо них используются запятые;
• [выражение]... — многоточие означает, что в данной позиции допускается перечисление нескольких выражений.

Короткие ключи могут вводиться в двух форматах:

-abc

или

-a -b -c

Длинные ключи всегда перечисляются по отдельности и обозначаются двойными дефисами:

--option1 --option2 --option3

Длинные ключи особенно полезны в сценариях; их содержательные имена помогают вспомнить, что делает сценарий. Большую часть объёма man-страницы занимает список ключей.

См. также

man(1).