261 lines
13 KiB
HTML
261 lines
13 KiB
HTML
|
||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<HTML><HEAD><TITLE>Man page of APROPOS</TITLE>
|
||
</HEAD><BODY>
|
||
<H1>APROPOS</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>
|
||
|
||
apropos - поиск в именах справочных страниц и кратких описаниях
|
||
<A NAME="lbAC"> </A>
|
||
<H2>СИНТАКСИС</H2>
|
||
|
||
<B>apropos</B> [<B>-dalv?V</B>] [<B>-e</B>|<B>-w</B>|<B>-r</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>apropos</B> выполняет поиск <I>ключевого слова</I> в этом описании.
|
||
<P>
|
||
<I>Ключевое слово</I> может представлять собой регулярное выражение (<B>-r</B>),
|
||
шаблон (<B>-w</B>) или точное искомое ключевое слово (<B>-e</B>). При использовании
|
||
этих параметров может потребоваться указывать <I>ключевое слово</I> в кавычках
|
||
или экранировать (\) специальные символы для того, чтобы избежать их
|
||
интерпретации оболочкой командной строки.
|
||
<P>
|
||
Стандартные правила поиска позволяют искать по названию страницы и границам
|
||
слова в описании.
|
||
<P>
|
||
Используемая <B>apropos</B> поисковая база данных обновляется программой
|
||
<B>mandb</B>. В зависимости от установки, она может запускаться как
|
||
периодически выполняемое задание cron или вручную, после установки новых
|
||
справочных страниц.
|
||
<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>
|
||
Рассматривать каждое ключевое слово как регулярное выражение. Является
|
||
поведением по умолчанию. Для каждого ключевого слова будет выполнен
|
||
независимый поиск в названиях страниц и описаниях. Для совпадения достаточно
|
||
нахождения в одном из этих мест. Сравнение не ограничивается границами
|
||
слова.
|
||
<DT id="4"><B>-w</B>, <B>--wildcard</B>
|
||
|
||
|
||
<DD>
|
||
Рассматривать каждое ключевое слово как шаблон с символами подстановки в
|
||
стиле оболочки командной строки. Для каждого ключевого слова будет выполнен
|
||
независимый поиск в названиях страниц и описаниях. Если также указан
|
||
параметр <B>--exact</B>, то совпадением будет считаться только полное равенство
|
||
раскрытого ключевого слова со всем описанием или названием страницы. Иначе
|
||
сравнение ограничивается границами слова в описании.
|
||
<DT id="5"><B>-e</B>, <B>--exact</B>
|
||
|
||
|
||
<DD>
|
||
Искать точное совпадение с названиями страниц и описаниями каждого ключевого
|
||
слова.
|
||
<DT id="6"><B>-a</B>, <B>--and</B>
|
||
|
||
|
||
<DD>
|
||
Показывать страницы, в которых найдены все указанные ключевые слова. По
|
||
умолчанию отображаются страницы, в которых есть хотя бы одно ключевое слово.
|
||
<DT id="7"><B>-l</B>, <B>--long</B>
|
||
|
||
|
||
<DD>
|
||
Не обрезать вывод по ширине терминала. Обычно, вывод обрезается по ширине
|
||
терминала во избежание проблем с плохо оформленными разделами <B>НАЗВАНИЕ</B>.
|
||
<DT id="8"><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="9"><B>-m</B> <I>система</I>[,...], <B>--systems=</B><I>система</I>[,...]<DD>
|
||
Если эта система имеет доступ к описаниям справочных страниц других
|
||
операционных систем, то с помощью этого параметра среди них тоже может быть
|
||
осуществлён поиск. Чтобы искать в описаниях справочных страниц по NewOS,
|
||
укажите параметр <B>-m</B> <B>NewOS</B>.
|
||
<P>
|
||
В значении <I>системы</I> можно указать несколько названий систем, перечислив их
|
||
через запятую. Чтобы включить поиск в <B>whatis</B>-описаниях по родной
|
||
операционной системе, добавьте в значение системное название <B>man</B>. Этот
|
||
параметр подменяет значение переменной окружения $<B>SYSTEM</B>.
|
||
<DT id="10"><B>-M </B><I>путь</I>, <B>--manpath=</B><I>путь</I><DD>
|
||
Задать альтернативный набор каталогов (через двоеточие) иерархии справочных
|
||
страниц для поиска. По умолчанию, <B>apropos</B> использует переменную
|
||
окружения $<B>MANPATH</B>, если она существует и не пуста, иначе соответствующий
|
||
manpath определяется на основе переменной окружения $<B>PATH</B>. Этот параметр
|
||
подменяет значение переменной окружения $<B>MANPATH</B>.
|
||
<DT id="11"><B>-L </B><I>локаль</I>, <B>--locale=</B><I>локаль</I><DD>
|
||
<B>apropos</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>apropos</B>. Заметим, что это влияет только непосредственно на поиск
|
||
страниц. Вывод сообщений программы, например справки, всегда будет
|
||
выполняться для изначально определённой локали.
|
||
<DT id="12"><B>-C </B><I>файл</I>, <B>--config-file=</B><I>файл</I><DD>
|
||
Использовать указанный пользовательский файл настройки вместо значения по
|
||
умолчанию <I>~/.manpath</I>.
|
||
<DT id="13"><B>-?</B>, <B>--help</B>
|
||
|
||
|
||
<DD>
|
||
Показать справочное сообщение и закончить работу.
|
||
<DT id="14"><B>--usage</B>
|
||
|
||
|
||
<DD>
|
||
Показать короткое сообщение об использовании и завершить работу.
|
||
<DT id="15"><B>-V</B>, <B>--version</B>
|
||
|
||
|
||
<DD>
|
||
Показать информацию о версии.
|
||
</DL>
|
||
<A NAME="lbAF"> </A>
|
||
<H2>КОД ВЫХОДА</H2>
|
||
|
||
<DL COMPACT>
|
||
<DT id="16"><B>0</B>
|
||
|
||
|
||
<DD>
|
||
Успешное выполнение программы.
|
||
<DT id="17"><B>1</B>
|
||
|
||
|
||
<DD>
|
||
Была показана справка об использовании, произошла синтаксическая ошибка или
|
||
проблемы в файле настройки.
|
||
<DT id="18"><B>2</B>
|
||
|
||
|
||
<DD>
|
||
Ошибка при работе.
|
||
<DT id="19"><B>16</B>
|
||
|
||
|
||
<DD>
|
||
По запросу ничего не найдено.
|
||
</DL>
|
||
<A NAME="lbAG"> </A>
|
||
<H2>ОКРУЖЕНИЕ</H2>
|
||
|
||
<DL COMPACT>
|
||
<DT id="20"><B>SYSTEM</B>
|
||
|
||
|
||
<DD>
|
||
Установка значения переменной окружения $<B>SYSTEM</B> равносильна указанию
|
||
параметра <B>-m</B>.
|
||
<DT id="21"><B>MANPATH</B>
|
||
|
||
|
||
<DD>
|
||
Если установлена переменная окружения $<B>MANPATH</B>, то она рассматривается
|
||
как набор каталогов (через двоеточие) иерархии справочных страниц для
|
||
использования при поиске.
|
||
<DT id="22"><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 символам, если определить значение
|
||
не удалось.
|
||
<DT id="23"><B>POSIXLY_CORRECT</B>
|
||
|
||
|
||
<DD>
|
||
Если установлена переменная окружения $<B>POSIXLY_CORRECT</B>, даже имеющая
|
||
пустое значение, то по умолчанию <B>apropos</B> включает поиск по расширенным
|
||
регулярным выражениям (<B>-r</B>). В настоящее время, это всё равно является
|
||
поведением по умолчанию.
|
||
</DL>
|
||
<A NAME="lbAH"> </A>
|
||
<H2>ФАЙЛЫ</H2>
|
||
|
||
<DL COMPACT>
|
||
<DT id="24"><I>/usr/share/man/index.(bt|db|dir|pag)</I>
|
||
|
||
|
||
<DD>
|
||
Традиционный кэш глобальной базы данных <I>index</I>.
|
||
<DT id="25"><I>/var/cache/man/index.(bt|db|dir|pag)</I>
|
||
|
||
|
||
<DD>
|
||
Соответствующий FHS глобальный кэш базы данных <I>index</I>.
|
||
<DT id="26"><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+man">man</A></B>(1),
|
||
|
||
|
||
<B><A HREF="/cgi-bin/man/man2html?1+whatis">whatis</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="27"><A HREF="#lbAB">НАЗВАНИЕ</A><DD>
|
||
<DT id="28"><A HREF="#lbAC">СИНТАКСИС</A><DD>
|
||
<DT id="29"><A HREF="#lbAD">ОПИСАНИЕ</A><DD>
|
||
<DT id="30"><A HREF="#lbAE">ПАРАМЕТРЫ</A><DD>
|
||
<DT id="31"><A HREF="#lbAF">КОД ВЫХОДА</A><DD>
|
||
<DT id="32"><A HREF="#lbAG">ОКРУЖЕНИЕ</A><DD>
|
||
<DT id="33"><A HREF="#lbAH">ФАЙЛЫ</A><DD>
|
||
<DT id="34"><A HREF="#lbAI">СМОТРИТЕ ТАКЖЕ</A><DD>
|
||
<DT id="35"><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:22 GMT, March 31, 2021
|
||
</BODY>
|
||
</HTML>
|