MAN(1) Справочник основных команд FreeBSD MAN(1)
НАЗВАНИЕ
man -- отформатировать и отобразить страницы справочникаСИНТАКСИС
man [-adfhkotw] [-m архитектура[:машина]] [-p строка] [-M путь]
[-P pager] [-S список] [раздел] название ...
ОПИСАНИЕ
Утилита man форматирует и отображает страницы справочника. Эта версия
использует переменные окружения MANPATH и PAGER, так что вы можете
использовать собственный набор справочных страниц и выбрать любую понра-
вившуюся вам программу для просмотра отформатированных страниц. Если
указан раздел, то man будет искать только в этом разделе справочника.
Через опции командной строки и переменные окружения вы также можете
задать порядок поиска по разделам и используемые для форматирования
исходных файлов препроцессоры. Системный администратор также может вклю-
чить режим, когда для экономии дискового пространства отформатированные
страницы справочника будут сжиматься командой ``/usr/bin/gzip -c''.
Имеются следующие опции:
-M путь Задаёт альтернативный маршрут поиска страниц справочника. По
умолчанию для определения маршрута поиска man использует
manpath(1) (который встроен в исполняемый файл man). Эта
опция имеет приоритет выше, чем переменная окружения MANPATH.
-P pager Задаёт программу для постраничного просмотра. По умолчанию
man использует ``more -s''. Эта опция имеет приоритет выше,
чем переменная окружения PAGER.
-S список Здесь список - это разделённый двоеточиями список разделов
справочника, в которых будет производиться поиск. Эта опция
имеет приоритет выше, чем переменная окружения MANSECT.
-a По умолчанию программа man прекратит свою работу после вывода
первой найденной страницы. Использование этой опции застав-
ляет man выводить все справочные страницы, которые соответ-
ствуют значению аргумента название, а не только первую найден-
ную страницу.
-d Не показывать на самом деле справочные страницы, но вывести
массу отладочной информации.
-f Эквивалентно запуску whatis.
-h Вывести подсказку и завершить работу.
-k Эквивалентно запуску apropos.
-m архитектура[:машина]
Поскольку некоторые страницы справочника предназначены только
для определённых архитектур и типов машин, внутри каждого
каталога, где man осуществляет поиск страниц, он также будет
искать внутри подкаталогов, имена которых совпадают с именем
текущего типа машины и её архитектуры. Вначале проверяются
области, относящиеся к типу машины, затем к архитектуре, затем
машинно-независимые области. Например, для ``i386:pc98'' и
8-го раздела справочника, поиск будет осуществляться в следую-
щих каталогах и в таком порядке: man8/pc98, man8/i386, затем
man8.
Используемый тип машины может быть переопределен либо с помо-
щью этой опции, либо указанием желаемого типа машины в пере-
менной окружения MACHINE. Используемая архитектура может быть
переопределена либо с помощью этой опции, либо указанием жела-
емой архитектуры в переменной окружения MACHINE_ARCH. Эта
опция имеет приоритет выше, чем переменные окружения MACHINE и
MACHINE_ARCH. Компонент машина, если не указан, принимает
значение по умолчанию, равное архитектура.
-o Искать только оригинальные, нелокализованные страницы справоч-
ника.
По умолчанию man ищет локализованные страницы справочника в
соответствующих подкаталогах каждого компонента, заданного
через manpath(1).
Имя локализации берётся из первой из трёх переменных окружения
с непустым значением, в таком порядке: LC_ALL, LC_CTYPE или
LANG.
Если значение не может быть определено, или оно не является
корректным значением имени локализации, то будут искаться
только нелокализованные страницы справочника.
В противном случае man будет осуществлять поиск в следующих
подкаталогах, в порядке их перечисления:
<язык>_<страна>.<кодировка>
<язык>.<кодировка>
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
Эти переменные задают предпочтительный язык справочных
страниц. (См. опцию -o выше.)
MACHINE Если MACHINE установлена, её значение переопределяет теку-
щий тип машины, использующийся для поиска машинно-зависимых
подкаталогов справочника.
MACHINE_ARCH Если MACHINE_ARCH установлена, её значение переопределяет
текущую архитектуру, использующуюся для поиска архитек-
турно-зависимых подкаталогов справочника.
MANPATH Если установлена переменная MANPATH, то её значение исполь-
зуется в качестве пути поиска страниц справочника.
MANROFFSEQ Если установлена переменная MANROFFSEQ, то её значение
используется для определения набора препроцессоров, запус-
каемых перед nroff(1) или troff(1). По умолчанию перед
запуском nroff(1) страницы справки пропускаются через
табличный препроцессор (tbl(1)).
MANSECT Если установлена переменная MANSECT, то её значение исполь-
зуется для определения разделов справочника, в которых
будет осуществляться поиск.
PAGER Если установлена переменная PAGER, то её значение использу-
ется в качестве имени программы, используемой для постра-
ничного просмотра страницы справочника. По умолчанию
используется ``more -s''.
ПРИМЕРЫ
Как правило, для просмотра справочной информации, относящейся к
``getopt'', вы бы использовали такую команду:
man getopt
Однако при обращении к конкретному разделу справочника, такому, как
getopt(3), вы должны использовать такую команду:
man 3 getopt
СМОТРИ ТАКЖЕ
apropos(1), groff(1), manpath(1), more(1), whatis(1), man(7), mdoc(7)ПРОБЛЕМЫ
Опция -t работает лишь в том случае, если в системе установлена
troff(1)-подобная программа.
FreeBSD 6.2 3 декабря 2005 FreeBSD 6.2
