Синтаксис
man [-adfhkotw] [-m архитектура[:машина]] [-p строка] [-M путь] [-P pager] [-S список] [раздел] название ...
Описание
Программа man форматирует и выводит пользователю страницы информационного руководства. Для определения путей поиска страниц, используются переменные окружения MANPATH и PAGER, это позволяет определить свой набор страниц руководства и программу для просмотра отформатированных страниц, которая вам понравится. С помощью опций программы man и переменные окружения, можно задать поиск по разделам руководства и используемые препроцессоры, для форматирования страниц. Так-же можно настроить сжатие страниц с помощью команды "/usr/bin/gzip -c".
Можно использовать следующие опции:
-M путь Альтернативный путь для поиска страниц руководства.
По-умолчанию, для определения пуьт поиска страниц, программа man, использует команду manpath, встроенную в бинарник man .
У данной опции приоритет выше, чем переменная окружения MANPATH.
-P pager Выбор программы для постраничного просмотра.
По-умолчанию, "more -s". Приоритет опции, выше переменной окружения PAGER.
-S список Разделенный двоеточиями, список разделов руководства в которых будет производиться поиск. Приоритет опции выше переменной MANSECT.
-a По-умолчанию программа man выводит только первую найденную страницу. Данная опция указывает, выводить все найденные страницы, соответствующие аргументу название.
-d Вместо страниц руководства, вывести отладочную информацию.
-f Аналог запуска программы whatis.
-h Краткая справка по программе man.
-k Аналог запуска программы apropos.
-m архитектура[:машина]
Поскольку многие страницы руководства касаются только конкретной архитектуры, внутри каждой директории, где man будет искать страницы, он будет производить поиск внутри поддиректорий, имена которых совпадают с архитектурой и типом текущей машины. Сначала производится поиск по типу машины, затем по архитектуре и затем кроссплатформенный поиск. Для определённых архитектур и типов машин, внутри каждого каталога, где man осуществляет поиск страниц, он также будет искать внутри подкаталогов, имена которых совпадают с именем текущего типа машины и её архитектуры. Вначале проверяются области, относящиеся к типу машины, затем к архитектуре, затем машинно-независимые области. Например, для "i386:pc98" и 8-го раздела руководства, поиск будет производиться в следующих директориях и в таком порядке: man8/pc98, man8/i386, затем man8.
Тип машины можно переопределить с помощью данной опции или путем установки необходимого значения, переменной окружения MACHINE. Тоже самое касается и архитектуры машины, только переменная называется MACHINE_ARCH. Приоритет опции выше переменных окружения.
-o Поиск только нелокализованных страниц руководства.
По-умолчанию, программа man производит поиск локализованных страниц руководства в соответствующих поддиректориях каждого компонента, заданного с помощью manpath.
Имя локализации будет взято из переменных окружения LC_ALL, LC_CTYPE и LANG. Проверка происходит в приведенном порядке. Будет взято первое непустое значение. Если по каким-то причинам не удалось определить имя локализации, или значение имени не корректно, будет произведен поиск только нелокализованных страниц руководства.
Поиск осуществляется в следующих директориях и порядке:
[язык]_[страна].[кодировка]
[язык].[кодировка]
en.[кодировка]
Например, для локализации "ru_RU.KOI8-R", программа man будет искать в следующих подкаталогах компонента /usr/share/man:
/usr/share/man/ru_RU.KOI8-R
/usr/share/man/ru.KOI8-R
/usr/share/man/en.KOI8-R
В случае неудачи поиска в локализованной версии руководства, будет произведен поиск по стандартному пути /usr/share/man.
-p строка Список препроцессоров для запуска перед nroff(1) или troff(1).
Полный список препроцессоров может быть доступен не всегда.
Вот некоторые из препроцессоров и соответствующие им сокращения:
eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Приоритет опции выше переменной окружения MANROFFSEQ.
-t Использовать "/usr/bin/groff -S -man" для форматирования страниц руководства, выводя результат на экран. По-умолчанию, форматом вывода для команды groff(1) является Postscript.
На странице руководства groff(1) перечислены способы, для выбора альтернативного формата.
-w Вывести только местоположение файлов страницы руководства.
Сама страница при этом не выводится.
Переменные окружения
LC_ALL, LC_CTYPE, LANG
Предпочтительный язык для страниц руководства.
MACHINE Если данная переменная установлена, определяет текущий тип машины, использующийся для поиска машинно-зависимых подкаталогов со страницами справки.
MACHINE_ARCH Если установлена, определяет архитектуру, для поиска архитектурно-зависимых подкаталогов справки.
MANPATH Значение этой переменной используется как путь для поиска страниц руководства.
MANROFFSEQ Значение данной переменной определяет набора препроцессоров,запускаемых перед nroff(1) или troff(1).
По-умолчанию, перед запуском nroff(1), страницы руководства обрабатываются табличным препроцессор (tbl(1)).
MANSECT Определяет разделы справочного руководства, в которых будет производиться поиск.
PAGER В данной переменной определяется программа для пострпничного просмотре страниц руководства. По-умолчанию "more -s".
Примеры
Просто для получения информации о программе kill, можно использовать:
man kill
Для доступа ко второму разделу справки по команде kill, нужно использовать:
man 2 kill
Смотри так-же
apropos(1), groff(1), manpath(1), more(1), whatis(1), man(7), mdoc(7)