242 lines
12 KiB
HTML
242 lines
12 KiB
HTML
|
||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<HTML><HEAD><TITLE>Man page of WHATIS</TITLE>
|
||
</HEAD><BODY>
|
||
<H1>WHATIS</H1>
|
||
Section: Утилиты просмотра справочных страниц (1)<BR>Updated: 2020-02-25<BR><A HREF="#index">Index</A>
|
||
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
||
|
||
<A NAME="lbAB"> </A>
|
||
<H2>НАЗВАНИЕ</H2>
|
||
|
||
whatis - показывает однострочные описания справочных страниц
|
||
<A NAME="lbAC"> </A>
|
||
<H2>СИНТАКСИС</H2>
|
||
|
||
<B>whatis</B> [<B>-dlv?V</B>] [<B>-r</B>|<B>-w</B>] [<B>-s</B> <I>список</I>]
|
||
[<B>-m</B> <I>система</I>[,...]] [<B>-M</B> <I>путь</I>] [<B>-L</B>
|
||
<I>локаль</I>] [<B>-C</B> <I>файл</I>] <I>название</I> ...
|
||
<A NAME="lbAD"> </A>
|
||
<H2>ОПИСАНИЕ</H2>
|
||
|
||
В начале каждой справочной страницы есть её краткое описание. <B>whatis</B>
|
||
осуществляет поиск в названиях справочных страниц и отображает описания всех
|
||
страниц, подходящих под <I>название</I>.
|
||
<P>
|
||
В <I>названии</I> могут содержаться шаблоны (<B>-w</B>) или это может быть
|
||
регулярное выражение (<B>-r</B>). При использовании этих параметров, может
|
||
потребоваться указывать <I>название</I> в кавычках или экранировать (\)
|
||
специальные символы для того, чтобы оболочка командной строки не
|
||
обрабатывала их.
|
||
<P>
|
||
При поиске используются <B>индексные</B> базы данных, которые обновляются с
|
||
помощью программы <B>mandb</B>. Для обновления баз в зависимости от установки,
|
||
её можно периодически запускать из задания cron или вручную после установки
|
||
новых справочных страниц. Чтобы создать текстовую базу данных <B>whatis</B>
|
||
старого формата из соответствующей <B>индексной</B> базы, выполните команду:
|
||
<P>
|
||
<B>whatis -M</B> <I>manpath</I> <B>-w '*' | sort ></B> <I>manpath/whatis</I>
|
||
<P>
|
||
где <I>manpath</I> — иерархия справочных страниц, например <I>/usr/man</I>.
|
||
<A NAME="lbAE"> </A>
|
||
<H2>ПАРАМЕТРЫ</H2>
|
||
|
||
<DL COMPACT>
|
||
<DT id="1"><B>-d</B>, <B>--debug</B>
|
||
|
||
|
||
<DD>
|
||
Показывать отладочную информацию.
|
||
<DT id="2"><B>-v</B>, <B>--verbose</B>
|
||
|
||
|
||
<DD>
|
||
Показывать подробные предупреждающие сообщения.
|
||
<DT id="3"><B>-r</B>, <B>--regex</B>
|
||
|
||
|
||
<DD>
|
||
Рассматривать каждое <I>название</I> как регулярное выражение. Если <I>название</I>
|
||
совпадает с любой частью имени страницы, то совпадение считается
|
||
произошедшим. Этот параметр вызывает замедление работы <B>whatis</B> из-за
|
||
применяемого алгоритма поиска в базе.
|
||
<DT id="4"><B>-w</B>, <B>--wildcard</B>
|
||
|
||
|
||
<DD>
|
||
Рассматривать каждое <I>название</I> как шаблон, содержащий символы подстановки
|
||
в стиле интерпретатора командной строки. Для получения совпадения, раскрытое
|
||
<I>название</I> должно полностью совпадать с именем страницы. Этот параметр
|
||
вызывает замедление работы <B>whatis</B> из-за применяемого алгоритма поиска в
|
||
базе.
|
||
<DT id="5"><B>-l</B>, <B>--long</B>
|
||
|
||
|
||
<DD>
|
||
Не обрезать вывод по ширине терминала. Обычно, вывод обрезается по ширине
|
||
терминала во избежание проблем с плохо оформленными разделами <B>НАЗВАНИЕ</B>.
|
||
<DT id="6"><B>-s</B> <I>список/</I>, <B>--sections=</B><I>список/</I>, <B>--section=</B><I>список</I><DD>
|
||
Искать только в заданном разделе справочных страниц. В <I>списке</I>
|
||
перечисляются разделы через двоеточие или запятую. Если в <I>списке</I> указан
|
||
только номер, например "3", то в выводимый список описаний войдут страницы
|
||
из разделов "3", "3perl", "3x" и так далее; но если в <I>списке</I> указано
|
||
расширение, например "3perl", то будут показаны страницы только из раздела
|
||
справочных страниц с этим расширением.
|
||
<DT id="7"><B>-m</B> <I>система</I>[,...], <B>--systems=</B><I>система</I>[,...]<DD>
|
||
Если система имеет доступ к названиям справочных страниц других операционных
|
||
систем, то с помощью этого параметра среди них тоже можно осуществлять
|
||
поиск. Чтобы искать в названиях справочных страниц для операционной системы
|
||
NewOS, укажите <B>-m</B> <B>NewOS</B>.
|
||
<P>
|
||
В значении <I>система</I> можно указать несколько имён операционных систем через
|
||
запятую. Чтобы включить поиск в именах страниц для родной операционной
|
||
системы, укажите в значении системное название <B>man</B>. Этот параметр
|
||
заменяет значение переменной окружения $<B>SYSTEM</B>.
|
||
<DT id="8"><B>-M </B><I>путь</I>, <B>--manpath=</B><I>путь</I><DD>
|
||
Задать альтернативный набор каталогов (через двоеточие) иерархии справочных
|
||
страниц для поиска. По умолчанию, <B>whatis</B> использует переменную
|
||
окружения $<B>MANPATH</B>, если она существует и не пуста, иначе соответствующий
|
||
manpath определяется на основе переменной окружения $<B>PATH</B>. Этот параметр
|
||
подменяет значение переменной окружения $<B>MANPATH</B>.
|
||
<DT id="9"><B>-L </B><I>локаль</I>, <B>--locale=</B><I>локаль</I><DD>
|
||
<B>whatis</B>, обычно, определяет текущую локаль с помощью вызова C-функции
|
||
<B><A HREF="/cgi-bin/man/man2html?3+setlocale">setlocale</A></B>(3), которая исследует различные переменные окружения, возможно
|
||
$<B>LC_MESSAGES</B> и $<B>LANG</B>. Для временной подмены полученного значения,
|
||
используйте этот параметр, задающий <I>локаль</I> только в
|
||
<B>whatis</B>. Заметим, что это влияет только непосредственно на поиск
|
||
страниц. Вывод сообщений программы, например справки, всегда будет
|
||
выполняться для изначально определённой локали.
|
||
<DT id="10"><B>-C </B><I>файл</I>, <B>--config-file=</B><I>файл</I><DD>
|
||
Использовать указанный пользовательский файл настройки вместо значения по
|
||
умолчанию <I>~/.manpath</I>.
|
||
<DT id="11"><B>-?</B>, <B>--help</B>
|
||
|
||
|
||
<DD>
|
||
Показать справочное сообщение и закончить работу.
|
||
<DT id="12"><B>--usage</B>
|
||
|
||
|
||
<DD>
|
||
Показать короткое сообщение об использовании и завершить работу.
|
||
<DT id="13"><B>-V</B>, <B>--version</B>
|
||
|
||
|
||
<DD>
|
||
Показать информацию о версии.
|
||
</DL>
|
||
<A NAME="lbAF"> </A>
|
||
<H2>КОД ВЫХОДА</H2>
|
||
|
||
<DL COMPACT>
|
||
<DT id="14"><B>0</B>
|
||
|
||
|
||
<DD>
|
||
Успешное выполнение программы.
|
||
<DT id="15"><B>1</B>
|
||
|
||
|
||
<DD>
|
||
Была показана справка об использовании, произошла синтаксическая ошибка или
|
||
проблемы в файле настройки.
|
||
<DT id="16"><B>2</B>
|
||
|
||
|
||
<DD>
|
||
Ошибка при работе.
|
||
<DT id="17"><B>16</B>
|
||
|
||
|
||
<DD>
|
||
По запросу ничего не найдено.
|
||
</DL>
|
||
<A NAME="lbAG"> </A>
|
||
<H2>ОКРУЖЕНИЕ</H2>
|
||
|
||
<DL COMPACT>
|
||
<DT id="18"><B>SYSTEM</B>
|
||
|
||
|
||
<DD>
|
||
Установка значения переменной окружения $<B>SYSTEM</B> равносильна указанию
|
||
параметра <B>-m</B>.
|
||
<DT id="19"><B>MANPATH</B>
|
||
|
||
|
||
<DD>
|
||
Если установлена переменная окружения $<B>MANPATH</B>, то она рассматривается
|
||
как набор каталогов (через двоеточие) иерархии справочных страниц для
|
||
использования при поиске.
|
||
<DT id="20"><B>MANWIDTH</B>
|
||
|
||
|
||
<DD>
|
||
Если установлена переменная окружения $<B>MANWIDTH</B>, то её значение
|
||
используется для определения ширины терминала (смотрите описание параметра
|
||
<B>--long</B>). Если она не установлена, то ширина терминала вычисляется из
|
||
значения переменной окружения $<B>COLUMNS</B> и, если доступен, вызова
|
||
<B><A HREF="/cgi-bin/man/man2html?2+ioctl">ioctl</A></B>(2) или устанавливается равной 80 символам, если определить значение
|
||
не удалось.
|
||
</DL>
|
||
<A NAME="lbAH"> </A>
|
||
<H2>ФАЙЛЫ</H2>
|
||
|
||
<DL COMPACT>
|
||
<DT id="21"><I>/usr/share/man/index.(bt|db|dir|pag)</I>
|
||
|
||
|
||
<DD>
|
||
Традиционный кэш глобальной базы данных <I>index</I>.
|
||
<DT id="22"><I>/var/cache/man/index.(bt|db|dir|pag)</I>
|
||
|
||
|
||
<DD>
|
||
Соответствующий FHS глобальный кэш базы данных <I>index</I>.
|
||
<DT id="23"><I>/usr/share/man/.../whatis</I>
|
||
|
||
|
||
<DD>
|
||
Традиционная текстовая база данных <B>whatis</B>.
|
||
</DL>
|
||
<A NAME="lbAI"> </A>
|
||
<H2>СМОТРИТЕ ТАКЖЕ</H2>
|
||
|
||
<B><A HREF="/cgi-bin/man/man2html?1+apropos">apropos</A></B>(1),
|
||
|
||
|
||
<B><A HREF="/cgi-bin/man/man2html?1+man">man</A></B>(1),
|
||
|
||
|
||
<B><A HREF="/cgi-bin/man/man2html?8+mandb">mandb</A></B>(8)
|
||
|
||
|
||
<A NAME="lbAJ"> </A>
|
||
<H2>АВТОР</H2>
|
||
|
||
<PRE>
|
||
Wilf. (<A HREF="mailto:G.Wilford@ee.surrey.ac.uk">G.Wilford@ee.surrey.ac.uk</A>).Fabrizio Polacco (<A HREF="mailto:fpolacco@debian.org">fpolacco@debian.org</A>).Colin Watson (<A HREF="mailto:cjwatson@debian.org">cjwatson@debian.org</A>).</PRE>
|
||
|
||
<P>
|
||
|
||
<HR>
|
||
<A NAME="index"> </A><H2>Index</H2>
|
||
<DL>
|
||
<DT id="24"><A HREF="#lbAB">НАЗВАНИЕ</A><DD>
|
||
<DT id="25"><A HREF="#lbAC">СИНТАКСИС</A><DD>
|
||
<DT id="26"><A HREF="#lbAD">ОПИСАНИЕ</A><DD>
|
||
<DT id="27"><A HREF="#lbAE">ПАРАМЕТРЫ</A><DD>
|
||
<DT id="28"><A HREF="#lbAF">КОД ВЫХОДА</A><DD>
|
||
<DT id="29"><A HREF="#lbAG">ОКРУЖЕНИЕ</A><DD>
|
||
<DT id="30"><A HREF="#lbAH">ФАЙЛЫ</A><DD>
|
||
<DT id="31"><A HREF="#lbAI">СМОТРИТЕ ТАКЖЕ</A><DD>
|
||
<DT id="32"><A HREF="#lbAJ">АВТОР</A><DD>
|
||
</DL>
|
||
<HR>
|
||
This document was created by
|
||
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
||
using the manual pages.<BR>
|
||
Time: 00:06:23 GMT, March 31, 2021
|
||
</BODY>
|
||
</HTML>
|