man

Section: Команда Русский ман (1)
Updated: (C) 1998
Index Return to Main Contents

НАЗВАНИЕ

man - форматирует и отображает страницы руководства (man pages)

manpath - определяет пользовательские пути поиска руководства

СИНТАКСИС

<code>man [-adfhkKtwW] [-m система] [-p строка] [-C файл_конфигурации] [-M путь] [-P программа_просмотра] [-S список_секций] [секция] имя ...</code>

ОПИСАНИЕ

Команда man форматирует страницы руководства. Текущая версия знает о переменных среды MANPATH и (MAN)PAGER, поэтому Вы можете установить свой собственный набор страниц руководства и свою собственную программу их просмотра. Если указана секция, то man ищет указанную страницу только в этой секции руководства. Вы также можете указать порядок поиска страниц по секциям, а также набор препроцессоров для обработки страниц, с помощью аргументов командной строки либо в переменных среды. Если имя содержит знак `/', то оно считается сначала именем файла, и Вы можете задавать командную строку в виде man ./foo.5 или даже man /cd/foo/bar.1.gz.

ОПЦИИ

-C файл_конфигурации

Указывает, какой из файлов конфигурации man.config использовать; по умолчанию /usr/lib/man.config. (См. man.config(5).)

-M путь

Указывает список директориев для поиска страниц руководства. Если эта опция не указана, то используется переменная среды MANPATH. Если такая переменная не определена, то списрк директориев поиска по умолчанию берется из /usr/lib/man.config. Пустая строка в переменной MANPATH также означает список по умолчанию.

-P программа_просмотра

Указывает используемую программу просмотра. Эта опция переопределяет переменную среды MANPAGER, которая, в свою очередь, переопределяет переменную PAGER. По умолчанию man использует /usr/bin/less -is.

-S список_секций

Список секций руководства, в которых производится поиск указанного имени, разделенных двоеточиями. Эта опция переопределяет переменную среды MANSECT.

-a

По умолчанию man завершает работу после показа первой найденной страницы руководства с указанным именем. При использовании этой опции man отображает все страницы, имеющие указанное имя, а не только первую.

-c

Переформатировать исходную страницу, даже если существует обновленная страница просмотра. Это может быть полезно в тех случаях, когда страница просмотра была отформатирована для экрана с отличным от текущего количеством столбцов.

-d

Не отображать страницу, а просто вывести отладочную информацию.

-D

Вывести и страницу, и отладочную информацию.

-f

Эквивалент whatis.

-h

Печатает одну строку помощи и завершается.

-k

Эквивалент apropos.

-K

Искать указанную строку во *всех* страницах руководства. Предупреждение: эта операция может длиться очень долго! Указание секции может ускорить ее. (Чтобы дать приблизительную оценку - на моей машине поиск длится около минуты на 500 страниц руководства.)

-m система

Указать другой набор страниц, в которых следует произвести поиск, основанный на имени заданной системы.

-p строка

Указать последовательность препроцессоров, запускаемых до nroff или troff. Не во всех операциоонных системах устанавливается полный набор препроцессоров. Вот список некоторых препроцессоров и первые их буквы, используемые для задания опции -p: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Эта опция переопределяет переменную среды MANROFFSEQ.

-t

Использовать для форматирования страниц команду /usr/bin/groff -Tps -mandoc и вывести результат на стандартный выход (stdout). Результат команды форматирования /usr/bin/groff -Tps -mandoc перед печатью может быть пропущен через те или иные специальные фильтры.

-w или --path

</tag> Не отображать страницы, а вывести полные имена файлов, которые будут форматированы или отображены. Если не дано имя искомой страницы: вывести (на стандартный вывод) список директориев, в которых проводит поиск man. Если команда manpath является ссылкой на man, то `manpath' эквивалентно `man --path'.

-W

То же, что и -w, но печатает по одному имени файла на строку, без дополнительной информации. Это бывает полезно в командах шелла вроде man -aW man | xargs ls -l

Страницы для просмотра (cat pages)

Man пытается сохранить отформатированные страницы для того, чтобы избежать повторного форматирования в следующий раз при вызове страницы. По традиции отформатированные страницы в DIR/manX сохраняются в DIR/catX, но в файле конфигурации /usr/lib/man.config можно задать иной способ. Если требуемый директорий для страниц просмотра не существует, то они и не сохраняются.

Возможно также установить для команды man бит suid с владельцем man. Тогда, если директорий для страниц просмотра имеет владельца man и права 0755 (записывать может только пользователь man), а страницы просмотра имеют права 0644 или 0444 (записывать может только пользователь man, либо вообще никто не может изменять страницы просмотра), никакой другой (обычный) пользователь не сможет изменить страницы просмотра либо положить какие-либо файлы в соответствующий директорий. Если man не является suid-программой, то для обеспечения возможности создания любым пользователем страниц просмотра соответствующие директории должны иметь права 0777.

С опцией -c man переформатирует исходную страницу, даже если существует свежая страница просмотра.

ОКРУЖЕНИЕ

MANPATH

Если переменная MANPATH установлена, то ее значение используется как список путей поиска страниц руководства.

MANROFFSEQ

Если переменная MANROFFSEQ установлена, то ее значение используется как последовательность вызова препроцессоров перед запуском nroff или troff. По умолчанию исходные страницы пропускаются через табличный препроцессор перед nroff.

MANSECT

Если переменная MANSECT установлена, то ее значение используется как список секций руководства, в которых следует производить поиск.

MANWIDTH

Если переменная MANWIDTH установлена, то ее значение используется как ширина отображения страниц руководства. В противном случае страницы отображаются на всю ширину экрана.

MANPAGER

Если переменная MANPAGER установлена, то ее значение используется как имя программы просмотра отформатированных страниц руководства. В противном случае используется переменная PAGER. Если ни та, ни другая переменная не установлены, то используется команда /usr/bin/less -is.

LANG

Если переменная LANG установлена, то ее значение используется как имя поддиректория, в котором man производит поиск страниц руководства. Так, команда `LANG=dk man 1 foo' приведет к тому, что man будет искать страницу foo сначала в .../dk/man1/foo.1; если же страница не будет найдена, то man продолжит поиск в .../man1/foo.1 (здесь `...' - один из путей поиска, указанных в переменной MANPATH, либо опцией -M).

NLSPATH, LC_MESSAGES, LANG

Переменные NLSPATH и LC_MESSAGES (или LANG, когда последняя не определена) используются для определения директория с файлом сообщений. (Однако сообщения на английском языке влинкованы в команду man, и в этом случае подобный директорий не требуется.) Заметьте, что команды вроде col(1), вызываемые man'ом, также используют, например, LC_CTYPE.

PATH

Переменная PATH также используется в определении путей поиска страниц руководства по умолчанию.

SYSTEM

Переменная SYSTEM используется для определения имени системы по умолчанию (совместно с опцией -m).

СМ. ТАКЖЕ

apropos(1) , whatis(1) , less(1) , groff(1) .

ОШИБКИ

Опция -t работает только при установленной troff-подобной программе.

Если на экране видны мигающие символы \255 или <AD> вместо переносов, добавьте в окружение строку `LESSCHARSET=latin1'.