Использование команды man
Для вызова интересующей документации требуется дать команду man с аргументами -- номером группы и именем man-страницы, например:
$ man 1 ls
Причём номер группы необходим только в том случае, если одноимённые документы имеются в разных группах. Для пользовательских команд он обычно не нужен, так как все равно просмотр групповых каталогов идёт сначала в man1, затем -- в man8, и только потом -- во всех остальных (в порядке возрастания номеров).
Например, в группе 1 имеется man-страница tty (1) (к слову сказать -- ссылаться на man-страницы принято именно так -- с указанием номера группы в скобках), посвященная одноименной команде, а в группе 4 -- man-страница tty (4), описывающая драйвер для устройства /dev/tty. Поэтому пользователь, нуждающийся в помощи по указанной команде, может ограничиться формой
$ man tty
Если же ему требуется получить сведения о драйвере устройства /dev/tty, номер группы должен быть указан в явном виде:
$ man 4 tty
Однако, повторяю, в данный момент нас интересуют только команды. Так что для получения информации, например, по команде ls достаточно ввести следующее:
$ man ls
после чего можно будет лицезреть примерно такую картину:
LS(1) FSF LS(1) NAME ls -- list directory contents SYNOPSIS ls [OPTION]... [FILE]... DESCRIPTION List information about the FILEs (the current directory by default). Sort entries alphabetically if none of -cftuSUX nor --sort.
То есть в начале man-страницы даются имя команды, которую она описывает (ls), ее групповая принадлежность (1 -- пользовательские команды) и авторство (в данном случае -- FSF, Free Software Foundations), или название системы. После чего обычно дается обобщенный формат вызова (SYNOPSIS) и краткое описание.
Следующая, основная, часть man-страницы -- описание опций команды, и условия их применения. Далее иногда (но, к сожалению, не всегда) следуют примеры использования команды (Examples) в разных типичных ситуациях. В заключении, как правило, даются сведения о найденных ошибках (Bug Report) и приведен список man-страниц, тематически связанных с данной (See also), с указанием номера группы, к которой они принадлежат, иногда -- историческая справка, а также указываются данные об авторе.