man - интерфейс к системным справочным страницам
СИНТАКСИС
man [опции man] [[раздел] страница ...] ...
man -k [опции apropos] регулярное_выражение ...
man -K [опции man] [раздел] термин ...
man -f [опции whatis] страница ...
man -l [опции man] файл ...
man -w|-W [опции man] страница ...
ОПИСАНИЕ
man - это системная программа-пагинатор. Каждый аргумент страницы, передаваемый команде man, обычно является именем программы, утилиты или функции. Затем соответствующая страница руководства для каждого из этих аргументов находится и отображается. Если указан раздел, команда man будет искать только в этом разделе руководства. Действием по умолчанию является поиск во всех доступных разделах в соответствии с предопределенным порядком (см. ДЕФОЛТЫ) и отображение только первой найденной страницы, даже если страница существует в нескольких разделах.
В таблице ниже показаны номера разделов руководства и типы страниц, которые они содержат.
1 Исполняемые программы или команды оболочки
2 Системные вызовы (функции, предоставляемые ядром)
3 Вызовы библиотек (функции в библиотеках программ)
4 Специальные файлы (обычно находятся в /dev)
5 Форматы файлов и соглашения, например, /etc/passwd
6 Игры
7 Разное (включая пакеты макросов и соглашения), например, man(7), [groff]({filename}../../groff)(7), man-pages(7)
8 Системные команды администратора (обычно только для root)
9 Подпрограммы ядра [Нестандартно]
Страница руководства состоит из нескольких разделов.
Обычные имена разделов включают NAME, SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS, EXIT STATUS, RETURN VALUE, ERRORS, ENVIRONMENT, FILES, VERSIONS, STANDARDS, NOTES, BUGS, EXAMPLE, AUTHORS и SEE ALSO.
Следующие соглашения применяются к разделу SYNOPSIS и могут использоваться в качестве руководства в других разделах.
текст полужирным шрифтом - введите точно так, как показано.
текст курсивом - замените соответствующим аргументом.
[-abc] - любой или все аргументы в [ ] являются необязательными.
-a|-b - параметры, разделенные |, нельзя использовать вместе.
аргумент ... - аргумент можно повторять.
[выражение] ... - все выражение в [ ] можно повторять.
Точный вывод может варьироваться в зависимости от выходного устройства. Например, man обычно не может отображать курсив в терминале и обычно использует подчеркнутый или цветной текст.
Иллюстрация команды или функции представляет собой шаблон, который должен соответствовать всем возможным вызовам. В некоторых случаях целесообразно иллюстрировать несколько исключающих друг друга вызовов, как показано в разделе SYNOPSIS этой страницы руководства.
ПРИМЕРЫ
man ls
Отображает страницу руководства для элемента (программы) ls.
man man.7
Отображает страницу руководства для макропакета man из раздела 7. (Это альтернативный способ написания "man 7 man".)
man 'man(7)'
Отображает страницу руководства для макропакета man из раздела 7. (Это еще один альтернативный способ написания "man 7 man". Это может быть более удобным при копировании и вставке перекрестных ссылок на страницы руководства. Обратите внимание, что скобки обычно должны быть заключены в кавычки, чтобы защитить их от оболочки.)
man -a intro
Отображает последовательно все доступные страницы руководства intro, содержащиеся в руководстве. Можно прервать отображение между страницами или пропустить любую из них.
man -t bash | lpr -Pps
Форматирует страницу руководства для bash в формат troff или groff по умолчанию и передает ее на принтер с именем ps. Формат groff по умолчанию обычно PostScript. man --help должен сообщать, какой процессор связан с опцией -t.
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
Эта команда распакует и отформатирует исходную страницу руководства nroff ./foo.1x.gz в файл в формате, независимом от устройства (dvi). Перенаправление необходимо, так как флаг -T приводит к тому, что вывод направляется в stdout без использования пейджера. Вывод можно просмотреть с помощью программы, такой как xdvi, или дополнительно обработать в PostScript с помощью программы, такой как dvips.
man -k printf
Выполняет поиск по кратким описаниям и именам страниц руководства для ключевого слова printf в виде регулярного выражения. Выводит все совпадения. Эквивалентно apropos printf.
man -f smail
Ищет страницы руководства, на которые ссылается smail, и выводит краткие описания найденных страниц. Эквивалентно whatis smail.
ОБЗОР
Доступно множество опций для man, чтобы обеспечить пользователю максимальную гибкость. Изменения можно вносить в путь поиска, порядок разделов, процессор вывода и другие параметры и операции, подробно описанные ниже.
Если установлено, различные переменные среды запрашиваются для определения работы man. Можно установить "универсальную" переменную $MANOPT на любую строку в формате командной строки, за исключением того, что любые пробелы, используемые в качестве части аргумента опции, должны быть экранированы (предварены обратной косой чертой). man сначала анализирует $MANOPT, а затем анализирует собственную командную строку. Опции, требующие аргумент, будут перезаписаны теми же опциями, найденными в командной строке. Чтобы сбросить все опции, установленные в $MANOPT, можно указать -D в качестве первой опции командной строки. Это позволит man "забыть" об опциях, указанных в $MANOPT, хотя они все равно должны быть действительными.
Страницы руководства обычно хранятся в формате nroff(1) в каталоге, таком как /usr/share/man. В некоторых установках также могут быть предварительно отформатированные страницы cat для повышения производительности. См. manpath(5) для получения подробной информации о том, где хранятся эти файлы.
Этот пакет поддерживает страницы руководства на нескольких языках, которые контролируются вашей локалью. Если ваша система не настроила это автоматически, вам может потребоваться установить $LC_MESSAGES, $LANG или другую зависящую от системы переменную среды, чтобы указать предпочитаемую локаль, обычно в формате POSIX:
<язык>[_<территория>[.<набор_символов>[,<версия>]]]
Если запрошенная страница доступна для вашей языковой среды, она будет отображена вместо стандартной страницы (обычно на американском английском языке).
Если вы обнаружите, что переводы, поставляемые в этом пакете, недоступны на вашем родном языке, и вы хотите их предоставить, свяжитесь с сопровождающим, который будет координировать эту деятельность.
Отдельные страницы руководства обычно пишутся и поддерживаются сопровождающими программы, функции или другой темы, которую они описывают, и не включены в этот пакет. Если вы обнаружите, что страница руководства отсутствует или неадекватна, сообщите об этом сопровождающим соответствующего пакета.
Для получения информации о других функциях и расширениях, доступных для этой программы просмотра руководств, прочитайте документацию, поставляемую с пакетом.
НАСТРОЙКИ ПО УМОЛЧАНИЮ
Порядок поиска разделов можно изменить с помощью переменной среды $MANSECT или директивы SECTION в /etc/manpath.config. По умолчанию он следующий:
1n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7
Отформатированная страница руководства отображается с помощью программы постраничного просмотра. Это можно указать несколькими способами или использовать значение по умолчанию (см. опцию -P для получения подробной информации).
Фильтры расшифровываются несколькими способами. Во-первых, проверяется опция командной строки -p или переменная среды $MANROFFSEQ. Если -p не использовалась и переменная среды не установлена, первая строка файла nroff анализируется на наличие строки препроцессора. Чтобы содержать допустимую строку препроцессора, первая строка должна быть похожа на:
'\" <строка>
где строка может быть любой комбинацией букв, описанных в опции -p ниже.
Если ни один из вышеперечисленных методов не предоставляет информации о фильтрах, используется набор по умолчанию.
Конвейер форматирования формируется из фильтров и основного форматировщика (nroff или [tg]roff с опцией -t) и выполняется. Кроме того, если существует исполняемая программа mandb_nfmt (или mandb_tfmt с опцией -t) в корне дерева man, она выполняется вместо этого. Ей передаются файл исходного текста руководства, строка препроцессора и, опционально, устройство, указанное с помощью опций -T или -E, в качестве аргументов.
ОПЦИИ
Неаргументированные опции, которые дублируются либо в командной строке, либо в $MANOPT, либо в обоих местах, не вредны. Для опций, которым требуется аргумент, каждое дублирование перезапишет предыдущее значение аргумента.
Общие опции
-C файл, --config-file=файл
Используйте этот пользовательский файл конфигурации вместо файла по умолчанию \~/.manpath.
-d, --debug
Выведите отладочную информацию.
-D, --default
Эта опция обычно выдается в качестве первой и сбрасывает поведение man к значениям по умолчанию. Ее использование заключается в сбросе тех опций, которые могли быть установлены в $MANOPT. Любые опции, следующие за -D, будут иметь свое обычное действие.
--warnings[=warnings]
Включить предупреждения от groff. Это можно использовать для проверки исходного текста страниц руководства. `warnings` — это список имен предупреждений, разделенных запятыми; если он не указан, значение по умолчанию — "mac". Чтобы отключить предупреждение groff, поставьте перед ним знак "!": например,
`--warnings=mac,!break` включает предупреждения категории "mac" и отключает предупреждения категории "break". Список доступных имен предупреждений см. в разделе "Предупреждения" в 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, который будет отформатирован. Если также используется опция `-a`, то выводит местоположения всех исходных файлов, соответствующих критериям поиска.
-W, --where-cat, --location-cat
Не отображает страницу руководства, а выводит местоположение предварительно отформатированного файла `cat`, который будет отображен. Если также используется опция `-a`, то выводит местоположения всех предварительно отформатированных файлов `cat`, соответствующих критериям поиска.
Если используются как `-w`, так и `-W`, то выводятся как исходный файл, так и файл `cat`, разделенные пробелом.
Если используются все три опции: `-w`, `-W` и `-a`, то это делается для каждого возможного совпадения.
-c, --catman
Эта опция не предназначена для общего использования и должна использоваться только программой `catman`.
-R encoding, --recode=encoding
Вместо форматирования страницы руководства обычным способом, выводит ее исходный код, преобразованный в указанную кодировку. Если вы уже знаете кодировку исходного файла, вы также можете использовать `manconv(1)` напрямую. Однако эта опция позволяет преобразовать несколько страниц руководства в одну и ту же кодировку, не указывая кодировку для каждой из них, при условии, что они уже установлены в структуре, аналогичной иерархии страниц руководства.
Вместо этого рассмотрите возможность использования man-recode(1) для преобразования нескольких страниц руководства, поскольку у нее есть интерфейс, предназначенный для пакетной обработки, и поэтому она может работать намного быстрее.
Поиск страниц руководства
-L locale, --locale=locale
man обычно определяет вашу текущую локаль, вызывая функцию C setlocale(3), которая опрашивает различные переменные среды, возможно, включая $LC_MESSAGES и $LANG. Чтобы временно переопределить определенное значение, используйте этот параметр, чтобы напрямую передать строку локали в man. Обратите внимание, что это не вступит в силу до начала поиска страниц. Такие выходные данные, как сообщение справки, всегда будут отображаться в изначально определенной локали.
-m system[,...], --systems=system[,...]
Если в этой системе есть доступ к страницам руководства других операционных систем, к ним можно получить доступ с помощью этого параметра. Чтобы найти страницу руководства из коллекции страниц руководства NewOS, используйте параметр -m NewOS.
Указанная система может быть комбинацией операционных систем, разделенных запятыми. Чтобы включить поиск в коллекциях страниц руководства для собственной операционной системы, включите имя системы man в строку аргументов. Этот параметр переопределит переменную среды $SYSTEM.
-M path, --manpath=path
Укажите альтернативный путь manpath для использования. По умолчанию man использует код, производный от manpath, для определения пути для поиска. Этот параметр переопределяет переменную среды $MANPATH и отключает параметр -m.
Путь, указанный как manpath, должен быть корневым каталогом иерархии страниц руководства, структурированной в разделы, как описано в руководстве man-db (в разделе «Система страниц руководства»). Чтобы просмотреть страницы руководства за пределами этих иерархий, см. параметр -l.
-S list, -s list, --sections=list
Указанный список представляет собой список разделов, разделенных двоеточиями или запятыми, который используется для определения разделов страниц руководства, в которых нужно выполнять поиск, и в каком порядке. Этот параметр переопределяет переменную среды $MANSECT. (Орфография -s предназначена для совместимости с System V.)
-e sub-extension, --extension=sub-extension
В некоторых системах большие пакеты страниц руководства, такие как пакеты, поставляемые с пакетом Tcl, включаются в основную иерархию страниц руководства. Чтобы обойти проблему наличия двух страниц руководства с одинаковым именем, таких как exit(3), страницы Tcl обычно назначались всем в раздел l. Поскольку это нежелательно, теперь можно поместить страницы в правильный раздел и назначить им определенное «расширение», в данном случае 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 обновлять кэш баз данных установленных страниц руководства. Это требуется только в редких случаях, и обычно лучше запускать mandb(8) вместо этого.
--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, --pager=pager
Укажите, какую программу просмотра вывода использовать. По умолчанию man использует pager, переходя к cat, если pager не найден или не является исполняемым файлом. Эта опция переопределяет переменную окружения $MANPAGER, которая, в свою очередь, переопределяет переменную окружения $PAGER. Она не используется в сочетании с -f или -k.
Значение может быть простым именем команды или командой с аргументами и может использовать кавычки оболочки (обратные слеши, одинарные кавычки или двойные кавычки). Нельзя использовать каналы для соединения нескольких команд; если это необходимо, используйте оберточный скрипт, который может принимать файл для отображения либо в качестве аргумента, либо через стандартный ввод.
-r prompt, --prompt=prompt
Если используется современная версия less в качестве программы постраничного просмотра, команда man попытается установить для нее подсказку и некоторые разумные параметры. Подсказка по умолчанию выглядит следующим образом:
Название страницы руководства(раздел) строка x
где `name` обозначает название страницы руководства, `sec` — раздел, в котором она была найдена, а `x` — текущий номер строки. Это достигается путем использования переменной среды `$LESS`.
Передача параметра -r со строкой перезапишет эту подсказку по умолчанию. Строка может содержать текст $MAN_PN, который будет расширен до названия текущей страницы руководства и названия ее раздела, заключенных в круглые скобки. Строку, используемую для создания подсказки по умолчанию, можно представить следующим образом:
\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(нажмите h для справки или q для выхода)
Здесь она разбита на три строки для удобства чтения. Для ее значения см. страницу руководства less(1). Строка подсказки сначала оценивается оболочкой. Все двойные кавычки, обратные кавычки и обратные слеши в строке подсказки должны быть экранированы предшествующим обратным слешем. Строка подсказки может заканчиваться экранированным символом $, за которым могут следовать дополнительные параметры для less. По умолчанию man устанавливает параметры -ix8.
Переменная среды $MANLESS, описанная ниже, может использоваться для установки строки подсказки по умолчанию, если она не указана в командной строке.
-7, --ascii
При просмотре страницы руководства в формате pure ascii(7) на 7-битном терминале или эмуляторе терминала некоторые символы могут отображаться некорректно при использовании описания устройства latin1(7) с GNU nroff. Этот параметр позволяет отображать страницы руководства в формате pure ascii в формате ascii с использованием устройства latin1. Он не будет преобразовывать текст latin1. В следующей таблице показаны выполняемые преобразования: некоторые ее части могут отображаться правильно только при использовании описания устройства latin1 GNU nroff.
Описание Octal latin1 ascii
символ продолжения 255 ‐ пуля (средняя точка) 267 • o
острый акцент 264 ´ '
знак умножения 327 × x
Если столбец latin1 отображается правильно, ваш терминал может быть настроен для символов latin1, и этот параметр не требуется. Если столбцы latin1 и ascii идентичны, вы просматриваете эту страницу, используя этот параметр, или man не отформатировал эту страницу с использованием описания устройства latin1. Если столбец latin1 отсутствует или поврежден, вам может потребоваться просматривать страницы руководства с этим параметром.
Этот параметр игнорируется при использовании параметров -t, -H, -T или -Z и может быть бесполезен для nroff, отличных от GNU.
-E encoding, --encoding=encoding
Создает выходные данные для другой кодировки символов, чем кодировка по умолчанию. Для обратной совместимости encoding может быть устройством nroff, таким как ascii, latin1 или utf8, а также настоящей кодировкой символов, такой как UTF-8.
--no-hyphenation, --nh
Обычно nroff автоматически расставляет переносы в тексте при переносе строк, даже в словах, которые не содержат дефисов, если это необходимо для размещения слов в строке без чрезмерных пробелов. Этот параметр отключает автоматический перенос, поэтому слова будут переноситься только в том случае, если они уже содержат дефисы.
Если вы пишете страницу руководства и просто хотите предотвратить перенос слова в неподходящем месте, не используйте этот параметр, а обратитесь к документации nroff; например, вы можете поместить "\%" внутри слова, чтобы указать, что его можно переносить в этом месте, или поместить "\%" в начале слова, чтобы предотвратить его перенос.
--no-justification, --nj
Обычно nroff автоматически выравнивает текст по обоим полям. Этот параметр отключает полное выравнивание, оставляя выравнивание только по левому полю, что иногда называют текстом с "неровным" правым краем.
Если вы пишете страницу руководства и просто хотите предотвратить выравнивание определенных абзацев, не используйте этот параметр, а обратитесь к документации nroff; например, вы можете использовать запросы ".na", ".nf", ".fi" и ".ad", чтобы временно отключить выравнивание и заполнение.
-p string, --preprocessor=string
Укажите последовательность препроцессоров, которые будут запущены перед 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[device], --troff-device[=device]
Этот параметр используется для изменения выходных данных groff (или, возможно, troff) для совместимости с другим устройством, отличным от устройства по умолчанию. Он подразумевает -t. Примеры (по состоянию на groff 1.23.0) включают dvi, latin1, pdf, ps, utf8, X75 и X100.
-H[browser], --html[=browser]
Этот параметр заставит 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 установлена, ее значение используется в качестве пути для поиска страниц руководства.
См. раздел «ПУТЬ ПОИСКА» в manpath(5) для получения информации о поведении по умолчанию и о том, как обрабатывается эта переменная окружения.
MANROFFOPT
Каждый раз, когда man вызывает форматтер (nroff, troff или groff), содержимое $MANROFFOPT добавляется в командную строку форматтера.
Например, MANROFFOPT=-P-i указывает форматтеру использовать курсив (который поддерживается не всеми терминалами) вместо подчеркнутого текста.
MANROFFSEQ
Если переменная $MANROFFSEQ установлена, ее значение используется для определения набора препроцессоров, которые будут переданы каждой странице руководства. Список препроцессоров по умолчанию зависит от системы.
MANSECT
Если переменная $MANSECT установлена, ее значение является списком разделов, разделенных двоеточиями, и оно используется для определения того, какие разделы руководства следует искать и в каком порядке. По умолчанию используется значение "1 n l 8 3 0 2 3ype 3posix 3pm 3perl 3am 5 4 9 6 7", если это не переопределено директивой SECTION в файле /etc/manpath.config.
MANPAGER, PAGER
Если переменная $MANPAGER или $PAGER установлена (при этом $MANPAGER используется в первую очередь), ее значение используется в качестве имени программы, используемой для отображения страницы руководства. По умолчанию используется программа pager, если она не найдена или не является исполняемой, то используется программа cat.
Значение может быть простым именем команды или командой с аргументами и может использовать кавычки оболочки (обратные косые черты, одинарные или двойные кавычки). Нельзя использовать конвейеры для соединения нескольких команд; если это необходимо, используйте вспомогательный скрипт, который может принимать файл для отображения либо в качестве аргумента, либо в стандартном потоке ввода.
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 символам, если ни то, ни другое не доступно). Страницы, отформатированные для просмотра в консоли, будут сохранены только в том случае, если используется форматирование по умолчанию, то есть когда длина строки терминала находится в диапазоне от 66 до 80 символов.
MAN_KEEP_FORMATTING
Обычно, когда вывод не направляется в терминал (например, в файл или канал), символы форматирования отбрасываются, чтобы упростить чтение результата без использования специальных инструментов. Однако, если переменная окружения $MAN_KEEP_FORMATTING установлена в любое ненулевое значение, эти символы форматирования сохраняются. Это может быть полезно для оберток вокруг man, которые могут интерпретировать символы форматирования.
MAN_KEEP_STDERR
Обычно, когда вывод направляется в терминал (обычно в программу-паджинатор), любой вывод ошибок из команды, используемой для создания отформатированных версий страниц руководства, отбрасывается, чтобы избежать помех при отображении паджинатором. Такие программы, как groff, часто генерируют относительно незначительные сообщения об ошибках, касающиеся типографских проблем, таких как плохое выравнивание, которые некрасивы и обычно вызывают путаницу при отображении вместе со страницей руководства. Однако некоторые пользователи хотят видеть их, поэтому, если переменная окружения $MAN_KEEP_STDERR установлена в любое ненулевое значение, вывод ошибок будет отображаться как обычно.
MAN_DISABLE_SECCOMP
В Linux программа man обычно ограничивает подпроцессы, обрабатывающие ненадежные данные, с помощью среды seccomp(2). Это делает более безопасным выполнение сложного кода анализа над произвольными страницами руководства. Если это по какой-либо причине выходит из строя, не связанной с содержимым отображаемой страницы, можно установить переменную окружения $MAN_DISABLE_SECCOMP в любое ненулевое значение, чтобы отключить среду.
PIPELINE_DEBUG
Если переменная окружения $PIPELINE_DEBUG установлена в "1", программа man будет выводить отладочные сообщения в стандартный поток ошибок, описывающие каждый запущенный подпроцесс.
LANG, LC_MESSAGES
В зависимости от системы и реализации, либо $LANG, либо $LC_MESSAGES (или оба) будут запрошены для получения текущей локали сообщений. Программа man будет отображать свои сообщения на этой локали (если она доступна). Подробности см. в setlocale(3).
ФАЙЛЫ
/etc/manpath.config
Конфигурационный файл `man-db`.
/usr/share/man
Глобальная иерархия страниц руководства.
СТАНДАРТЫ
POSIX.1-2001, POSIX.1-2008, POSIX.1-2017.
ССЫЛКИ
apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), manpath(5), man(7), catman(8), mandb(8)
Документация для некоторых пакетов может быть доступна в других форматах, таких как info(1) или HTML.
ИСТОРИЯ
1990 1991 — Первоначально написан Джоном У. Итоном (_).
23 дек. 1992: Рик Фейт (_) применил исправления ошибок, предоставленные Виллемом Касдорпом (_).
30 апр. 1994 — 23 февр. 2000: Вильф (_) разрабатывал и поддерживал этот пакет с помощью нескольких преданных своему делу людей.
30 окт. 1996 — 30 марта 2001: Фабрицио Полакко <_> поддерживал и улучшал этот пакет для проекта Debian с помощью всего сообщества.
31 марта 2001 — настоящее время: Колин Уотсон <_> сейчас разрабатывает и поддерживает man-db.
ОШИБКИ
https://gitlab.com/man-db/man-db/-/issues https://savannah.nongnu.org/bugs/?group=man-db