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

Проблема

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

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

Решение

Разберитесь в структуре man-страниц; изучите условные обозначения команд и их параметров, и вы поймете, что man-страницы на самом деле очень полезны.
Комментарии С точки зрения Linux все man-страницы в системе являются частью единого ру ководства. Это руководство состоит из следующих разделов: 1 — исполняемые программы или команды оболочки; 2 — системные функции; 3 — библиотечные функции; 4 — специальные файлы (обычно находящиеся в /dev); 5 — форматы файлов и соглашения; 6 — игры; 7 — разное; 8 — команды системного администрирования; 9 — нестандартные функции ядра; п — новая документация, которая позднее может быть перемещена; 1 — локальная документация, специфическая для вашей системы.
Каждая отдельная программа, утилита или функция представлена в этом ру ководстве отдельной страницей. Поиск страницы для программы или команды обычно сводится к вводу команды man foo, где foo — имя программы.
Вероятно, вам также попадались нумерованные ссылки на man-страницы вида grep(l). Такая ссылка обозначает страницу man grep из раздела 1. Она вызывается следующим образом: $ man I 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 and AUTHOR.
Описание синтаксиса команды находится в секции SYNOPSIS man-страницы и выглядит следующим образом: имя_команды [необязательные ключи] обязательные_элементы При описании ключей команды используются следующие обозначения: О жирный шрифт — вводится точно так, как показано; О курсив — обозначает аргумент, заменяемый конкретным значением. В зави симости от используемой программы просмотра вместо курсива может ис пользоваться подчеркивание текста или жирный шрифт; О [-abc] — все ключи в квадратных скобках являются необязательными и их можно комбинировать друг с другом; 22 Глава 1. Документация О [-а|-Ь|-с] — ключи, разделенные символом «|» (вертикальная черта), не могут комбинироваться друг с другом; О аргумент... — многоточие означает, что в данной позиции допускается пере числение нескольких аргументов. Элементы списка обычно разделяются про белами, но иногда вместо них используются запятые; О [выражение]... — многоточие означает, что в данной позиции допускается пе речисление нескольких выражений.
Короткие ключи могут вводиться в двух форматах: -abc или -а -ь -с Длинные ключи всегда перечисляются по отдельности и обозначаются двойны ми дефисами: --optionl --option2 --option3 Длинные ключи особенно полезны в сценариях; их содержательные имена по могают вспомнить, что делает сценарий.
Большую часть объема man-страницы занимает список ключей.
См. также man(l).