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

-C файл, --config-file=файл

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

-d, --debug

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

-D, --default

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

--warnings[=предупреждения]

Включить предупреждения от groff. Это может быть использовано для проверки тривиальных ошибок в исходном тексте справочных страниц. Предупреждения представляют собой список названий предупреждений через запятую; если он не указан, то по умолчанию используется значение «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, то вывести расположения всех отформатированных файлов, которые подпадают под критерии поиска.

Если указаны параметры -w и -W, и вывести исходный файл и файл cat, разделив их пробелом. Если указаны сразу -w, -W и -a, то сделать это для каждого возможного совпадения.

-c, --catman

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

-R кодировка, --recode=кодировка

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

Попробуйте использовать man-recode(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 обновить свои кэши базы данные установленных справочных страниц. Это требуется очень редко и для этого, обычно, лучше запускать 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=пейджер

Указывает, какой пейджер использовать для вывода. По умолчанию, man использует less и применяет cat, если less не найден или не является исполняемым файлом. Этот параметр заменяет значение переменной окружения $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[=устройство]

This option is used to change groff (or possibly troff's) output to be suitable for a device other than the default. It implies -t. Examples (as of groff 1.23.0) include dvi, latin1, pdf, ps, utf8, X75 and 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

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