MAN(1)

НАЗВАНИЕ
man - доступ к справочным страницам

СИНТАКСИС
man [-C файл] [-d] [-D] [--warnings[=предупреждения]] [-R кодировка] [-L локаль] [-m система[,...]] [-M путь] [-S список разделов] [-e доп.расширение] [-i|-I] [--regex|--wildcard] [--names-only] [-a] [-u] [--no-subpages] [-P пейджер] [-r приглашение] [-7] [-E кодировка] [--no-hyphenation] [--no-justification] [-p строка] [-t] [-T[устройство]] [-H[браузер]] [-X[dpi]] [-Z] [[раздел] страница ...] ...
man -k [apropos параметры] регвыр ...
man -K [-w|-W] [-S список] [-i|-I] [--regex] [раздел] термин ...
man -f [whatis параметры] страница ...
man -l [-C файл] [-d] [-D] [--warnings[=предупреждения]] [-R кодировка] [-L локаль] [-P пейджер] [-r приглашение] [-7] [-E кодировка] [-p строка] [-t] [-T[устройство]] [-H[браузер]] [-X[dpi]] [-Z] файл ...
man -w|-W [-C файл] [-d] [-D] страница ...
man -c [-C файл] [-d] [-D] страница ...
man [-?V]

ОПИСАНИЕ
man — это пейджер справочных страниц системы. Каждый параметр страница, переданный man, обычно является названием программы, утилиты или функции. По каждому из этих параметров выполняется поиск и вывод связанной с ним справочной страницы. Если указан параметр раздел, то это заставляет man выполнять поиск только в этом справочном разделе. Действием по умолчанию является поиск во всех доступных разделах в заранее определённом порядке (по умолчанию в «1 n l 8 3 2 3posix 3pm 3perl 5 4 9 6 7», если не изменено директивой SECTION в /etc/manpath.config) и показ только первой найденной страницы, даже если существуют страницы в нескольких разделах. В таблице ниже показаны номера справочных разделов и описание их содержимого.
1
Исполняемые программы или команды оболочки (shell)
2
Системные вызовы (функции, предоставляемые ядром)
3
Библиотечные вызовы (функции, предоставляемые программными библиотеками)
4
Специальные файлы (обычно находящиеся в каталоге /dev)
5
Форматы файлов и соглашения, например о /etc/passwd
6
Игры
7
Разное (включает пакеты макросов и соглашения), например man(7), groff(7)
8
Команды администрирования системы (обычно, запускаемые только суперпользователем)
9
Процедуры ядра [нестандартный раздел]
Справочная страница состоит из нескольких разделов. Стандартные имена разделов: НАЗВАНИЕ (NAME), СИНТАКСИС (SYNOPSIS), НАСТРОЙКИ (CONFIGURATION), ОПИСАНИЕ (DESCRIPTION), ПАРАМЕТРЫ (OPTIONS), КОД ВЫХОДА (EXIT STATUS), ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ (RETURN VALUE), ОШИБКИ (ERRORS), ОКРУЖЕНИЕ (ENVIRONMENT), ФАЙЛЫ (FILES), ВЕРСИИ (VERSIONS), СОГЛАСУЕТСЯ С (CONFORMING TO), ЗАМЕЧАНИЯ (NOTES), ОШИБКИ (BUGS), ПРИМЕР (EXAMPLE), АВТОРЫ (AUTHORS) и СМОТРИТЕ ТАКЖЕ (SEE ALSO). В разделе СИНТАКСИС используются следующие соглашения (которые также могут быть использованы в качестве основы для других разделов).
текст жирным шрифтом
набирать точно как показано.
текст курсивным шрифтом
заменить соответствующим значением.
[-abc]
любой или все параметры внутри [ ] необязательны.
-a|-b
параметры, разделённые |, не могут указываться одновременно.
параметр ...
повторяющийся параметр.
[выражение] ...
всё выражение внутри [ ] может вводиться несколько раз.
Точная отрисовка может отличаться на разных устройствах вывода. Например, man, обычно, не способна вывести курсив в терминале, и вместо него выведет текст подчёркнутым или цветным. При объяснении команды или функции должен применяться шаблон, который точно описывает все возможные варианты вызова. В некоторых случаях рекомендуется показать несколько уникальных вызовов, как показано в разделе СИНТАКСИС этой справочной страницы.

ПРИМЕРЫ

man ls
    Показать справочную страницу для параметра (программы) ls.

man -a intro
    Показать подряд все доступные справочные страницы по intro. В перерыве между показами можно пропустить следующую справочную страницу или закончить просмотр.

man -t alias | lpr -Pps
    Отформатировать справочную страницу по `alias' (обычно это справочная страница для оболочки командной строки) в формат по умолчанию troff или groff, и передать её по каналу на принтер с именем ps. Обычно, форматом вывода groff по умолчанию является PostScript. По команде man --help можно посмотреть какой процессор используется с параметром -t.

man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
    Эта команда расжимает и форматирует справочную страницу в формате nroff ./foo.1x.gz в файл в формате независимом от устройства (dvi). Перенаправление вывода необходимо, так как при параметре -T вывод направляется напрямую на стандартный вывод без пейджера. Результат может быть просмотрен с помощью, например, xdvi или преобразован в PostScript с помощью, например, dvips.

man -k printf
    Искать в кратких описаниях и именах справочных страниц ключевое слово printf, рассматриваемое как регулярное выражение. Показать любые найденные совпадения. Эквивалентно вызову apropos printf.

man -f smail
    Искать справочные страницы, ссылающиеся на smail и показать краткое описание любой найденной. Эквивалентно вызову whatis smail.

ОБЗОР
Многие параметры man предназначены для предоставления как можно большей гибкости пользователю. Можно изменять путь поиска, порядок разделов, выходной обработчик и другие характеристики и операции — всё это подробно описано ниже. В работе man могут использоваться различные переменные окружения. Возможно задать любые параметры во 'всеобъемлющей' переменной $MANOPT, экранируя пробельные символы в значениях (с помощью обратной косой черты). man разбирает $MANOPT перед началом анализа параметров, переданных при вызове в командной строке. Все значения параметров, указанные в командной строке, заменят значения своих аналогов из переменной окружения. Для сброса всех параметров, установленных с помощью $MANOPT, можно указать параметр -D в начале командной строки. Это позволит man 'забыть' о значениях, указанных в $MANOPT, хотя они всё равно должны быть заданы правильно. Утилиты пейджера справочных страниц из пакета man-db широко используют кэши базы данных index. Эти кэши содержат информацию о расположении справочной страницы в файловой системе и какие данные whatis (короткое однострочное описание справочной страницы) она содержит, а также позволяют man работать быстрее, чем если бы каждый раз осуществлялся поиск по файловой системе для нахождения определённой справочной страницы. Если при запросе страницы указан параметр -u, то man проверит целостность кэшей, и в случае проблем может потребоваться ручной запуск программы по обновлению обычных текстовых баз данных whatis. Если man не может найти mandb для первоначального создания базы данных index под определённую иерархию справочных страниц, то она попытается выполнить поиск запрашиваемых справочных страниц, хотя для этого потребуются универсальные имена файлов для поиска внутри иерархии. Если whatis или apropos не удастся найти index, то они попробуют извлечь информацию из традиционной текстовой базы данных whatis. Утилиты пакета могут работать с сжатыми исходными файлами в формате nroff, имеющими расширения по умолчанию .Z, .z и .gz. Возможна работа с любыми расширениями, указывающими на сжатие, но эта информация задаётся на этапе компиляции. Также по умолчанию, любые создаваемые cat страницы сжимаются с помощью gzip. Каждой 'глобальной' иерархии справочных страниц, типа /usr/share/man или /usr/X11R6/man, может быть сопоставлен любой каталог для иерархии cat страниц. Обычно, cat страницы хранятся в той же иерархии что и справочные страницы, но по причинам, указанным в File Hierarchy Standard (FHS), может оказаться лучшим хранить их в другом месте. Подробней о том, как это сделать, читайте в manpath(5). Подробней о том, почему так делается, читайте стандарт. Пакетом обеспечивается поддержка разных языков. Справочные страницы на родном языке доступны (если, они есть в системе) с помощью функций локализации. Чтобы включить поддержку, необходимо присвоить переменной $LC_MESSAGES, $LANG или другой переменной окружения (зависит от системы) значение локали вашего языка, обычно задаваемое в формате, основанном на POSIX 1003.1: <язык>[_<территория>[.<кодировка>[,<версия>]]] Если запрашиваемая страница доступна для вашей локали, то она будет показана вместо стандартной (обычно, на американском английском) страницы. Также в этом пакете есть переводы интерфейса на разные языки, которые могут быть включены тем же путём. Если вы обнаружили, что для вашего языка нет справочных страниц или не переведён интерфейс и вы хотите сделать это, то свяжитесь с сопровождающим, который скоординирует данную работу. О других возможностях и расширениях, доступных в этом пейджере справочных страниц, читайте в описаниях из этого пакета.

ЗНАЧЕНИЯ ПО УМОЛЧАНИЮ
man ищет требуемые справочные страницы в кэшах базы данных index. Если указан параметр -u, то проверяется целостность кэша, чтобы удостовериться, что базы данных точно отражают данные из файловой системы. Если этот параметр задавать каждый раз, то, в принципе, нет необходимости запускать mandb после первоначального создания кэша, пока кэш не повредится. Однако проверка целостности кэша может работать медленно на машинах с большим количеством установленных справочных страниц, поэтому она не выполняется по умолчанию, и системным администраторам лучше запускать mandb раз в неделю, чтобы поддерживать кэши базы данных в актуальном состоянии. Чтобы предотвратить проблемы из-за устаревших кэшей, man выполняет поиск файлов по имени, если в кэше ничего не нашлось ( как если бы кэша не было). После обнаружения справочной страницы выполняется проверка, существует ли уже отформатированный для неё `cat' файл и что он новее, чем найденный nroff файл. Если уже отформатированный файл существует, он (обычно) расжимается и показывается с помощью пейджера. Нужную программу пейджер можно задать различными способами или используется значение по умолчанию (подробней смотрите в описании параметра -P). Если cat страница не найдена или старее, чем nroff файл, то nroff файл пропускается через различные программы и сразу же показывается. Если есть возможность создать cat файл (существует соответствующий cat каталог и достаточно прав), то man сжимает и сохраняет cat файл в фоновом режиме. Фильтры можно указывать разными способами. Во-первых, обрабатывается значение параметра -p или переменная окружения $MANROFFSEQ. Если -p не указывалась и переменная окружения не установлена, то в поисках строки препроцессора анализируется первая строка nroff файла. Чтобы указывать строку препроцессора правильно, первая строка должна быть в формате '\" <строка> где строка может содержать комбинацию букв, описанных в параметре -p ниже. Если информация о фильтре нигде не указана, то используется набор по умолчанию. Конвейер форматирования создаётся из фильтров и основной программы форматирования (nroff или [tg]roff с параметром -t) и выполняется. Или же, если существует исполняемая программа mandb_nfmt (или mandb_tfmt с параметром -t) в корне дерева справочных страниц, то выполняется именно она. Она получает файл с исходным текстом справочной страницы, строку препроцессора, и, необязательно, устройство, указанное в параметре -T или -E.

ПАРАМЕТРЫ
Параметры без значений, повторяющиеся в командной строки, $MANOPT или обоих, не опасны. В случае с параметрами со значением, при каждом повторении новое значение заменяет имеющееся.

  Общие параметры

-C файл, --config-file=файл
    Использовать указанный пользовательский файл настройки вместо значения по умолчанию ~/.manpath.

-d, --debug
    Показывать отладочную информацию.

-D, --default
    Этот параметр обычно вводится самым первым, и указывает man активировать поведение по умолчанию. Он используется для сброса параметров, которые могли быть установлены через переменную окружения $MANOPT. Любые параметры, указанные после -D, будут действовать как обычно.

--warnings[=предупреждения]
    Включить предупреждения от groff. Это может быть использовано для проверки тривиальных ошибок в исходном тексте справочных страниц. Предупреждения представляют собой список названий предупреждений через запятую; если он не указан, то по умолчанию используется значение «mac». Полный список доступных предупреждений можно найти в info groff, раздел “Предупреждения”.

  Основные режимы работы

-f, --whatis
    Эквивалентно работе whatis. Отображает краткое описание из справочной страницы, если оно есть. Подробней смотрите whatis(1).

-k, --apropos
    Эквивалентно работе apropos. Ищет в кратких описаниях справочных страниц ключевые слова и показывает любые совпадения. Подробней смотрите apropos(1).

-K, --global-apropos
    Поиск текста во всех справочных страницах. Используется простой поиск перебором, что занимает определённое время; если можно, указывайте раздел для сокращения числа страниц, в которых нужно искать. Термины поиска могут быть простыми строками (по умолчанию), или регулярными выражениями, если указан параметр --regex.

-l, --local-file
    Включить 'локальный' режим. Форматирует и показывает локальные справочные файлы, а не ищет их в справочной коллекции системы. Каждый параметр справочной страницы считается именем правильно отформатированного исходного файла nroff. Cat файлы не создаются. Если в качестве одного из параметров указан '-', то данные будут взяты из стандартного входного потока. Если этот параметр не используется и man не может найти запрашиваемую страницу, то перед тем как показать сообщение об ошибке, будет предпринята попытка работать в локальном режиме, используя указанное имя в качестве имени файла для поиска.

-w, --where, --path, --location
    Не выводить содержимое справочных страниц, а показать место(а) нахождения исходных файлов nroff, которые были бы отформатированы.

-W, --where-cat, --location-cat
    Не выводить содержимое справочных страниц, а показать место(а) нахождения cat файлов, которые были бы показаны. Если указаны оба параметра, -w и -W, то выводятся оба результата через пробел.

-c, --catman
    Этот параметр не для обычного использования, и должен использоваться только программой catman.

-R кодировка, --recode=кодировка
    Вместо обычного форматирования справочной страницы можно преобразовать исходный текст в заданную кодировку. Если вам уже известна кодировка исходного файла, то вы можете также использовать непосредственно manconv(1). Однако, этот параметр позволяет преобразовывать несколько справочных страниц в одну кодировку без явного указания кодировки каждой страницы, предполагая, что они уже установлены в структуру, подобную иерархии справочных страниц.

  Поиск справочных страниц

-L локаль, --locale=локаль
    man, обычно, определяет текущую локаль с помощью вызова C-функции setlocale(3), которая исследует различные переменные окружения, возможно $LC_MESSAGES и $LANG. Для временной подмены полученного значения, используйте этот параметр, задающий локаль только в man. Заметим, что это влияет только непосредственно на поиск страниц. Вывод сообщений программы, например справки, всегда будет выполняться для изначально определённой локали.

-m система[,...], --systems=система[,...]
    Если система имеет доступ к справочным страницам других операционных систем, то к ним можно обратиться с помощью этого параметра. Чтобы найти справочную страницу из коллекции страниц для операционной системы NewOS, укажите -m NewOS. В значении система может указать несколько имён операционных систем через запятую. Чтобы включить поиск по справочным страницам родной операционной системы, добавьте системное имя man в это значение. Этот параметр заменяет значение переменной окружения $SYSTEM.

-M путь, --manpath=путь
    Задать альтернативный manpath для работы. По умолчанию, для определения пути поиска man использует manpath, указанный в исходном коде программы. Этот параметр заменяет значение переменной окружения $MANPATH и выключает действие параметра -m. Задаваемый в качестве manpath путь должен быть корнем иерархии справочных страниц, разделённой на разделы, описанных в справочной странице по man-db (в разделе "Система справочных страниц"). Для просмотра справочных страниц вне этих иерархий, используйте параметр -l.

-S список, -s список, --sections=список
    В списке перечисляются справочные разделы для поиска 'в указанном порядке' (через запятую или двоеточие). Этот параметр заменяет значение переменной окружения $MANSECT. (Параметр -s введён для совместимости с System V.)

-e доп.расширение, --extension=доп.расширение
    Некоторые системы включают большое число пакетов справочных страниц, например таких, которые поставляются с пакетом Tcl, в главную иерархию справочных страниц. Для решения проблемы появления двух справочных страниц с одинаковым именем, например, exit(3), все страницы Tcl, обычно, помещаются в раздел l. Но для страниц такого типа уже определён правильный раздел (3). Теперь возможно помещать страницы в правильный раздел, и назначать им специальное 'расширение', в данном случае, exit(3tcl). Обычно, man показывает exit(3), а не exit(3tcl). Чтобы преодолеть это и не запоминать в каком разделе лежит определённая страница, теперь возможно передать man строку доп.расширения, указывающую какому пакету должна принадлежать страница. Возвращаясь к примеру выше, укажите параметр -e tcl для man, чтобы ограничить поиск только страницами с расширением *tcl.

-i, --ignore-case
    Игнорировать регистр при поиске справочных страниц. Включено по умолчанию.

-I, --match-case
    Искать справочные страницы с учётом регистра символов.

--regex
    Показывает все страницы, у которых какая-то часть в имени или в описании совпадает с параметром страница, заданным в виде регулярного выражения, также как apropos(1). Так как, обычно, нет разумного способа определить "лучшую" страницу при поиске по регулярному выражению, то этот параметр подразумевает -a.

--wildcard
    Показывает все страницы, у которых какая-то часть в имени или в описании совпадает с параметром страница, заданным в виде групповых символов, также как в apropos(1) --wildcard. Значение страница должно полностью совпадать с именем или описанием, или совпадать по границе слов в описании. Так как, обычно, нет разумного способа определить "лучшую" страницу при поиске по регулярному выражению, то этот параметр подразумевает -a.

--names-only
    Если указан параметр --regex или --wildcard, то совпадения ищутся только в именах страниц, а не в описании страницы, как в whatis(1). Иначе, этого не происходит.

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

-u, --update
    Этот параметр заставляет man выполнять проверку целостности своих кэшей базы данных 'на уровне inode', чтобы убедиться, что они точно представляют данные из файловой системы. Это работает только, если man установлена с включённым setuid битом.

--no-subpages
    По умолчанию, man пытается интерпретировать пары имён справочных страниц, указанных в командной строке, как единое имя справочной страницы, содержащее символ переноса или подчёркивания. Это поддерживает общую систему программ, которые имеют несколько подкоманд, позволяя для каждой из них предоставлять справочные страницы используя синтаксис, похожий на вызов самих подкоманд. Например:
      $ man -aw git diff
      /usr/share/man/man1/git-diff.1.gz
    Чтобы выключить такое поведение, укажите параметр --no-subpages.
      $ man -aw --no-subpages git diff
      /usr/share/man/man1/git.1.gz
      /usr/share/man/man3/Git.3pm.gz
      /usr/share/man/man1/diff.1.gz

  Контролирование форматированного вывода

-P пейджер, --pager=пейджер
    Указывает, какой пейджер использовать для вывода. По умолчанию, man использует pager. Этот параметр заменяет значение переменной окружения $MANPAGER которая, в свою очередь, заменяет значение переменной окружения $PAGER. Не используется вместе с -f или -k. Значением может быть просто имя команды или команды с параметрами, можно использовать экранирование интерпретатора команд (обратные слэши, одиночные кавычки или двойные кавычки). Нельзя объединять несколько команд каналами; если эту нужно, создайте сценарий-обёртку, который получает файл для показа в виде параметра или со стандартного ввода.

-r приглашение, --prompt=приглашение
    Если в качестве пейджера используется новая версия less, то man будет пытаться установить ей формат приглашения и некоторые значимые параметры. По умолчанию приглашение выглядит как Manual page имя(раздел) line x где имя это имя справочной страницы, раздел — раздел, в котором она была найдена и x — номер текущей строки. Приглашение устанавливается с помощью переменной окружения $LESS. Данное значение по умолчанию можно изменить с помощью параметра -r. Значение параметра может содержать текст $MAN_PN, вместо которого подставляется имя текущей справочной страницы и её название раздела, окружённое `(' и `)'. Строка, используемая для создания приглашения по умолчанию, могла бы выглядеть как \ Справочная\ страница\ \$MAN_PN\ ?ltстрока\ %lt?L/%L.:
    byte\ %bB?s/%s..?\ (ВСЕ):?pB\ %pB\\%..
    (h — справка, q — выход) Здесь она разделена на три строки только для повышения читаемости. Описание её составных частей смотрите в справочной странице less(1). Строка приглашения сначала обрабатывается оболочкой командной строки. Все двойные кавычки, обратные кавычки и обратные косые черты в приглашении должны предваряться обратными косыми чертами для экранирования. Строка приглашения может заканчиваться экранированным $, за которым можно указать другие параметры less. По умолчанию, man указывает параметры -ix8. Переменная окружения $MANLESS, описанная ниже, может использоваться для назначения строки приглашения по умолчанию, если это не задано в командной строке.

-7, --ascii
    При просмотре справочной страницы в изначальной кодировке ascii(7) на 7-битном терминале или эмуляторе терминала при использовании описания устройства latin1(7) с GNU nroff некоторые символы могут неправильно отображаться . Этот параметр позволяет справочным страницам в изначальной ascii отображаться в ascii, используя устройство latin1. Любой latin1 текст не будет транслироваться. Следующая таблица показывает выполняемые трансляции: некоторые её части могут отображаться правильно только при использовании GNU nroff устройства latin1(7).
    Описание
    Восьмеричный код
    latin1
    ascii
    длинный перенос
    255
    -
    bullet (точка в центре)
    267
    •
    o
    значок ударения
    264
    ´
    знак ударения
    327
    ×
    x
    Если колонка latin1 отображается правильно, то ваш терминал может быть настроен для отображения символов latin1 и этот параметр ненужен. Если колонки latin1 и ascii одинаковы, то вы читаете эту страницу с помощью данного параметра, или man не отформатировал страницу с помощью описания устройства latin1. Если колонка latin1 отсутствует или повреждена, то вам может потребоваться просматривать справочные страницы с помощью этого параметра. Этот параметр игнорируется при использовании параметров -t, -H, -T или -Z, и может быть бесполезен для nroff, если он не от GNU.

-E кодировка, --encoding=кодировка
    Сгенерировать вывод в символьной кодировке, отличной от используемой по умолчанию. Кроме реальной символьной кодировки, типа UTF-8, для обратной совместимости в кодировке можно указывать устройство nroff, например, ascii, latin1 или utf8.

--no-hyphenation, --nh
    Обычно, nroff автоматически разбивает текст при окончании строки даже на словах, у которых нет переносов, если это необходимо для размещения слов в строке для избежания лишних пробелов. Этот параметр отключает автоматический перенос; в результате перенос выполняется только для слов, в которых есть символы переноса. Если вы пишите справочную страницу и просто хотите отключить в nroff перенос в словах в неподходящем месте, не используйте этот параметр, а почитайте документацию к nroff; например, вы можете поместить "\%" внутрь слова в место возможного разрыва, или поместить "\%" в начало слова, что не даст его разорвать совсем.

--no-justification, --nj
    Обычно, nroff автоматически выравнивает текст по обеим границам. Этот параметр выключает полное выравнивание, оставляя выравнивание по левому краю, получается так называемый текст "без выключки по правому краю". Если вы пишите справочную страницу и просто хотите отключить в nroff выравнивание в некоторых параграфах, не используйте этот параметр, а почитайте документацию к nroff; например, вы можете использовать запросы ".na", ".nf", ".fi", и ".ad" для временного отключения выравнивания и заполнения.

-p строка, --preprocessor=строка
    Задать последовательность препроцессоров для запуска перед nroff или troff/groff. Не во всех системах имеется полный набор препроцессоров. Некоторые препроцессоры и буквы, используемые для их обозначения: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Этот параметр заменяет значение переменной окружения $MANROFFSEQ. zsoelim запускается всегда в качестве первого очень быстрого препроцессора.

-t, --troff
    Использовать groff -mandoc для форматирования справочной страницы и вывода в стандартный выходной поток. Этот параметр не требуется вместе с -H, -T или -Z.

-T[устройство], --troff-device[=устройство]
    Этот параметр используется для замены вывода groff (или, возможно, troff) на более подходящий для устройства, отличного от используемого по умолчанию. Подразумевается -t. Примеры (предоставляются с Groff-1.17) включают dvi, latin1, ps, utf8, X75 и X100.

-H[браузер], --html[=браузер]
    Этот параметр заставляет groff создавать HTML -страницу, и отображать её в веб-браузере. Выбор браузера определяется необязательным значением браузер, переменной окружения $BROWSER, или, если ничего не указано, значением по умолчанию, установленным при компиляции программы (обычно lynx). Этот параметр предполагает -t, и работает только с GNU troff.

-X[dpi], --gxditview[=dpi]
    С этим параметром вывод groff осуществляет в графическое окно с помощью программы gxditview. Значениями dpi (точек на дюйм) могут быть 75, 75-12, 100 или 100-12; по умолчанию 75; в вариантах с -12 в конце используется базовый шрифт в 12 точек. Этот параметр подразумевает -T со значениями устройств X75, X75-12, X100 и X100-12 соответственно.

-Z, --ditroff
    groff запустит troff, а затем использует соответствующий постпроцессор для создания результата, подходящего для выбранного устройства. Если groff -mandoc совпадает с groff, то данный параметр передаётся groff и использование постпроцессора отменяется. Подразумевает -t.

  Выдача справки

-?, --help
    Показать справочное сообщение и закончить работу.

--usage
    Показать короткое сообщение об использовании и завершить работу.

-V, --version
    Показать информацию о версии.

КОД ВЫХОДА

0   Успешное выполнение программы.

1   Была показана справка об использовании, произошла синтаксическая ошибка или проблемы в файле настройки.

2   Ошибка при работе.

3   Дочерний процесс завершился с ненулевым кодом выхода.

16  По крайней мере одна из страниц/файлов/ключевых слов не существует или для неё при поиске ничего не найдено.

ОКРУЖЕНИЕ

MANPATH
    Если установлена переменная окружения $MANPATH, то её значение используется в качестве пути поиска справочных страниц.

MANROFFOPT
    Содержимое переменной окружения $MANROFFOPT добавляется в командную строку всякий раз, когда man вызывает программу форматирования (nroff, troff или groff).

MANROFFSEQ
    Если установлена переменная окружения $MANROFFSEQ, то её значение используется для определения набора препроцессоров для обработки каждой справочной страницы. Список препроцессоров по умолчанию зависит от системы.

MANSECT
    Если установлена переменная окружения $MANSECT, то её значением является список разделов, указанных через двоеточие, и она используется для задания разделов справочных страниц, в которых будет производится поиск и в каком порядке. Значением по умолчанию является «1 n l 8 3 2 3posix 3pm 3perl 5 4 9 6 7», если оно не заменено директивой SECTION в /etc/manpath.config.

MANPAGER, PAGER
    Если установлена переменная окружения $MANPAGER или $PAGER ($MANPAGER просматривается первой), то в ней задано имя программы для отображения справочной страницы. По умолчанию, используется pager. Значением может быть просто имя команды или команды с параметрами, можно использовать экранирование интерпретатора команд (обратные слэши, одиночные кавычки или двойные кавычки). Нельзя объединять несколько команд каналами; если эту нужно, создайте сценарий-обёртку, который получает файл для показа в виде параметра или со стандартного ввода.

MANLESS
    Если установлена переменная окружения $MANLESS, то её значение будет использоваться по умолчанию как строка приглашения для пейджера less, как если бы был указан параметр -r (так что любые появления текста $MAN_PN будут как-то раскрыты). Например, если вы хотите установить строку приглашения дословно в “my prompt string”, то установите $MANLESS равной ‘-Psmy prompt string’. Указанное значение параметра -r замещает значение переменной окружения.

BROWSER
    Если установлена переменная окружения $BROWSER, то её значение представляет собой список команд, разделяемых двоеточием; каждая из них используется для попытки запуска веб-браузера для man --html. В каждой команде %s заменяется именем файла, содержащим HTML результат от groff, %% заменяется одним знаком процента (%), а %c заменяется двоеточием (:).

SYSTEM
    Установка значения переменной окружения $SYSTEM равносильна указанию параметра -m.

MANOPT
    Если установлена переменная окружения $MANOPT, то она анализируется раньше командной строки man и должна задаваться в том же формате. Значения всех специальных переменных окружения man могут быть заданы в параметрах командной строки, а включение в $MANOPT показывает, что данный параметр скоро устареет. Обратите особое внимание на то, что все пробелы, которые должны быть частью значения параметра, нужно экранировать.

MANWIDTH
    Если установлена переменная окружения $MANWIDTH, то её значение используется в качестве длины строки форматируемых справочных страниц. Если она не установлена, то справочные страницы будут отформатированы по длине строки текущего терминала (используется значение переменной $COLUMNS, вызов ioctl(2), если он доступен или 80 символов, если ничего недоступно). Cat страницы будут сохраняться на диск только, если может быть использовано форматирование по умолчанию, то есть когда длина строки терминала лежит в промежутке между 66 и 80 символами.

MAN_KEEP_FORMATTING
    Обычно, если вывод не направляется на терминал (например, в файл или канал), символы форматирования отбрасываются для облегчения чтения результата не имея специальных инструментов. Однако, если переменная окружения $MAN_KEEP_FORMATTING установлена в непустое значение, то символы форматирования остаются. Это может быть полезно для оболочек вокруг man, которые распознают символы форматирования.

MAN_KEEP_STDERR
    Обычно, если вывод направляется на терминал (например, в пейджер), все ошибки вывода команды, используемой для создания форматированного варианта справочной страницы, отбрасываются во избежании порчи отображаемого текста. Программы типа groff часто выводят относительно безобидные сообщения об ошибках, например о печатных проблемах плохого выравнивания вперемешку с информацией справочной страницы. Однако, некоторые пользователи всё равно хотели бы их видеть, и поэтому, если установить переменную окружения $MAN_KEEP_STDERR в непустое значение, вывод ошибок будет производиться как обычно.

LANG, LC_MESSAGES
    В зависимости от системы и реализации, одна или обе переменные $LANG и $LC_MESSAGES будут просмотрены для определения текущей локали сообщений. man будет отображать свои сообщения в этой локали (если они для неё есть). Подробней смотрите в setlocale(3).

ФАЙЛЫ

/etc/manpath.config
    Файл настройки man-db.

/usr/share/man
    Глобальная иерархия справочных страниц.

/usr/share/man/index.(bt|db|dir|pag)
    Традиционный кэш глобальной базы данных index.

/var/cache/man/index.(bt|db|dir|pag)
    Соответствующий FHS глобальный кэш базы данных index.

СМОТРИТЕ ТАКЖЕ
apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), setlocale(3), manpath(5), ascii(7), latin1(7), man(7), catman(8), mandb(8), руководство к пакету man-db, FSSTND

ИСТОРИЯ
1990, 1991 – изначально написана Джоном В. Итоном (John W. Eaton, jwe@che.utexas.edu). 23 декабря 1992: Рик Фейт (Rik Faith, faith@cs.unc.edu) исправил ошибки, найденные Виллемом Касдорпом (Willem Kasdorp, wkasdo@nikhefk.nikef.nl). 30 апреля 1994 – 23 февраля 2000: Вильф (Wilf., G.Wilford@ee.surrey.ac.uk) разрабатывал и сопровождал этот пакет с помощью некоторых других людей. 30 октября 1996 – 30 марта 2001: Фабрицио Полако (Fabrizio Polacco, <fpolacco@debian.org> сопровождал и улучшал этот пакет для проекта Debian с помощью всего сообщества. 31 марта 2001 – настоящие дни: Колин Уотсон (Colin Watson, <cjwatson@debian.org> занимается разработкой и сопровождением man-db.