НАЗВАНИЕ¶

apropos - поиск в именах справочных страниц и кратких описаниях

СИНТАКСИС¶

apropos [-dalv?V] [-e|-w|-r] [-s list] [-m system[,...]] [-M path] [-L locale] [-C file] keyword ...

ОПИСАНИЕ¶

Внутри каждой справочной страницы есть краткое описание о чём эта страница. apropos выполняет поиск ключевого слова в этом описании.

Ключевое слово может представлять собой регулярное выражение (-r), шаблон (-w) или точное искомое ключевое слово (-e). При использовании этих параметров может потребоваться указывать ключевое слово в кавычках или экранировать (\) специальные символы для того, чтобы избежать их интерпретации оболочкой командной строки.

Стандартные правила поиска позволяют искать по названию страницы и границам слова в описании.

Используемая apropos поисковая база данных обновляется программой mandb. В зависимости от установки, она может запускаться как периодически выполняемое задание cron или вручную, после установки новых справочных страниц.

ПАРАМЕТРЫ¶

-d, --debug

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

-v, --verbose

Показывать подробные предупреждающие сообщения.

-r, --regex

Рассматривать каждое ключевое слово как регулярное выражение. Является поведением по умолчанию. Для каждого ключевого слова будет выполнен независимый поиск в названиях страниц и описаниях. Для совпадения достаточно нахождения в одном из этих мест. Сравнение не ограничивается границами слова.

-w, --wildcard

Рассматривать каждое ключевое слово как шаблон с символами подстановки в стиле оболочки командной строки. Для каждого ключевого слова будет выполнен независимый поиск в названиях страниц и описаниях. Если также указан параметр --exact, то совпадением будет считаться только полное равенство раскрытого ключевого слова со всем описанием или названием страницы. Иначе сравнение ограничивается границами слова в описании.

-e, --exact

Искать точное совпадение с названиями страниц и описаниями каждого ключевого слова.

-a, --and

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

-l, --long

Не обрезать вывод по ширине терминала. Обычно, вывод обрезается по ширине терминала во избежание проблем с плохо оформленными разделами НАЗВАНИЕ.

-s список, --sections список, --section список

Искать только в заданном разделе справочных страниц. В списке перечисляются разделы через двоеточие или запятую. Если в списке указан только номер, например "3", то в выводимый список описаний войдут страницы из разделов "3", "3perl", "3x" и так далее; но если в списке указано расширение, например "3perl", то будут показаны страницы только из раздела справочных страниц с этим расширением.

-m система[,...], --systems=система[,...]

-M путь, --manpath=путь

Задать альтернативный набор каталогов (через двоеточие) иерархии справочных страниц для поиска. По умолчанию, apropos использует переменную окружения $MANPATH, если она существует и не пуста, иначе соответствующий manpath определяется на основе переменной окружения $PATH. Этот параметр подменяет значение переменной окружения $MANPATH.

-L локаль, --locale=локаль

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

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

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

-?, --help

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

--usage

Print a short usage message and exit.

-V, --version

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

КОД ВЫХОДА¶

0

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

1

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

2

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

16

По запросу ничего не найдено.

ОКРУЖЕНИЕ¶

SYSTEM

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

MANPATH

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

MANWIDTH

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

POSIXLY_CORRECT

Если установлена переменная окружения $POSIXLY_CORRECT, даже имеющая пустое значение, то по умолчанию apropos включает поиск по расширенным регулярным выражениям (-r). В настоящее время, это всё равно является поведением по умолчанию.

ФАЙЛЫ¶

/usr/share/man/index.(bt|db|dir|pag)

Традиционный кэш глобальной базы данных index.

/var/cache/man/index.(bt|db|dir|pag)

Соответствующий FHS глобальный кэш базы данных index.

/usr/share/man/.../whatis

Традиционная текстовая база данных whatis.

СМОТРИТЕ ТАКЖЕ¶

man(1), whatis(1), mandb(8)

АВТОР¶

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).