НАЗВАНИЕ

whatis - показывает однострочные описания справочных страниц

СИНТАКСИС

whatis [-dlv?V] [-r|-w] [-s список] [-m система[,...]] [-M путь] [-L локаль] [-C
файл] название ...

ОПИСАНИЕ

В начале каждой справочной страницы есть её краткое описание. whatis осуществляет
поиск в названиях справочных страниц и отображает описания всех страниц,
подходящих под название.

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

При поиске используются индексные базы данных, которые обновляются с помощью
программы mandb. Для обновления баз в зависимости от установки, её можно
периодически запускать из задания cron или вручную после установки новых
справочных страниц. Чтобы создать текстовую базу данных whatis старого формата из
соответствующей индексной базы, выполните команду:

whatis -M manpath -w '*' | sort > manpath/whatis

где manpath — иерархия справочных страниц, например /usr/man.

ПАРАМЕТРЫ

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

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

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

-w, --wildcard
Рассматривать каждое название как шаблон, содержащий символы подстановки в
стиле интерпретатора командной строки. Для получения совпадения, раскрытое
название должно полностью совпадать с именем страницы. Этот параметр
вызывает замедление работы whatis из-за применяемого алгоритма поиска в
базе.

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

-s список, --sections список, --section список
Искать только в заданном разделе справочных страниц. В списке перечисляются
разделы через двоеточие или запятую. Если в списке указан только номер,
например "3", то в выводимый список описаний войдут страницы из разделов
"3", "3perl", "3x" и так далее; но если в списке указано расширение,
например "3perl", то будут показаны страницы только из раздела справочных
запятую. Чтобы включить поиск в именах страниц для родной операционной
системы, укажите в значении системное название man. Этот параметр заменяет
значение переменной окружения $SYSTEM.

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

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

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

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

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

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

КОД ВЫХОДА

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

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

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

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

ОКРУЖЕНИЕ

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

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

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

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

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

apropos(1), man(1), mandb(8)

АВТОР

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