264 lines
9.2 KiB
HTML
264 lines
9.2 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: Dienstprogramme für Handbuchseiten (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>BEZEICHNUNG</H2>
|
|
|
|
apropos - Suche in Handbuchseiten und deren Kurzbeschreibungen
|
|
<A NAME="lbAC"> </A>
|
|
<H2>ÜBERSICHT</H2>
|
|
|
|
<B>apropos</B> [<B>-dalv?V</B>] [<B>-e</B>|<B>-w</B>|<B>-r</B>] [<B>-s</B>
|
|
<I>Liste</I>] [<B>-m</B> <I>System</I>[,...]] [<B>-M</B> <I>Pfad</I>]
|
|
[<B>-L</B> <I>Locale</I>] [<B>-C</B> <I>Datei</I>] <I>Schlüsselwort</I> ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>BESCHREIBUNG</H2>
|
|
|
|
Jede Handbuchseite enthält eine kurze Beschreibung. <B>apropos</B> durchsucht
|
|
diese Beschreibungen nach dem Vorkommen von <I>Schlüsselwort</I>.
|
|
<P>
|
|
Das <I>Schlüsselwort</I> ist gewöhnlich ein regulärer Ausdruck und hat den
|
|
gleichen Effekt wie (<B>-r</B>). Es kann außerdem nach einer bestimmten
|
|
Zeichenkette (<B>-e</B>) oder nach Zeichenketten mit Platzhaltern (Wildcards,
|
|
<B>-w</B>) gesucht werden. Bei Nutzung dieser Optionen kann es erforderlich
|
|
sein, für das <I>Schlüsselwort</I> und Sonderzeichen eine Verarbeitung durch die
|
|
Shell zu vermeiden. Für <I>Schlüsselwörter</I> werden dafür Anführungszeichen
|
|
und für Sonderzeichen Escape-Sequenzen (\) verwendet.
|
|
<P>
|
|
Die Regeln für die Standardsuche ermöglichen den Abgleich des Suchbegriffs
|
|
mit dem Namen der Handbuchseite und Wortgrenzen in der Beschreibung.
|
|
<P>
|
|
Bei der Suche wertet <B>apropos</B> die von <B>mandb</B> gepflegte Datenbank
|
|
aus. Abhängig von Ihrer Installation wird die Datenbank periodisch per
|
|
Cron-Job aktualisiert - oder Sie müssen nach der Installation neuer
|
|
Handbuchseiten <B>mandb</B> manuell starten.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONEN</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d</B>, <B>--debug</B>
|
|
|
|
|
|
<DD>
|
|
Ausgabe von Debug-Informationen
|
|
<DT id="2"><B>-v</B>, <B>--verbose</B>
|
|
|
|
|
|
<DD>
|
|
Ausgabe ausführlicher Warnmeldungen
|
|
<DT id="3"><B>-r</B>, <B>--regex</B>
|
|
|
|
|
|
<DD>
|
|
Interpretiert jedes Schlüsselwort als regulären Ausdruck. Dies ist das
|
|
Standardverhalten. Jedes Schlüsselwort wird unabhängig voneinander in den
|
|
Befehlsnamen und in den Beschreibungen gesucht. Die Suche liefert auch
|
|
Treffer über Wortgrenzen hinweg.
|
|
<DT id="4"><B>-w</B>, <B>--wildcard</B>
|
|
|
|
|
|
<DD>
|
|
Interpretiert jedes Schlüsselwort als Muster, das Shell-Platzhalter
|
|
enthält. Jedes Schlüsselwort wird unabhängig voneinander in den Befehlsnamen
|
|
und in den Beschreibungen gesucht. Wird außerdem <B>--exact</B> vorgegeben, wird
|
|
nur die Übereinstimmung des Schlüsselworts nach Ersetzung des regulären
|
|
Ausdrucks mit der vollständigen Beschreibung oder dem Namen einer
|
|
Handbuchseite als Treffer gewertet. Anderenfalls gelten auch einzelne Wörter
|
|
in der Beschreibung als Treffer.
|
|
<DT id="5"><B>-e</B>, <B>--exact</B>
|
|
|
|
|
|
<DD>
|
|
Jedes Schlüsselwort wird genau mit den Seitennamen und den Beschreibungen
|
|
verglichen.
|
|
<DT id="6"><B>-a</B>, <B>--and</B>
|
|
|
|
|
|
<DD>
|
|
Zeigt nur Einträge an, die alle angegebenen Schlüsselwörter
|
|
enthalten. Standardverhalten ist die Anzeige aller Einträge, die irgendeines
|
|
der Schlüsselwörter enthalten.
|
|
<DT id="7"><B>-l</B>, <B>--long</B>
|
|
|
|
|
|
<DD>
|
|
Die Ausgabe wird nicht auf die Terminalbreite beschnitten. Normalerweise
|
|
wird die Ausgabe auf die Terminalbreite gestutzt, um hässliche Ergebnisse
|
|
schlecht geschriebener <B>BEZEICHNUNGs</B>-Abschnitte zu vermeiden.
|
|
<DT id="8"><B>-s</B> <I>Liste/</I>, <B>--sections=</B><I>Liste/</I>, <B>--section=</B><I>Liste</I><DD>
|
|
Durchsucht nur die vorgegebenen Abschnitte. <I>Liste</I> ist eine durch Kommas
|
|
oder Doppelpunkte gegliederte Liste von Abschnitten. Wenn ein Eintrag in
|
|
<I>Liste</I> ein einfacher Abschnitt ist (z. B. »3«), enthält das Ergebnis
|
|
Seiten aus den Abschnitten »3«, »3perl«, »3x« usw. Wird <I>Abschnitt</I> mit
|
|
Suffix angegeben (z. B. »3perl«), werden die Ergebnisse nur in diesem
|
|
speziellen Unterabschnitt gesucht.
|
|
<DT id="9"><B>-m</B> <I>system</I>[,...], <B>--systems=</B><I>System</I>[,...]<DD>
|
|
Wenn Ihr System auch auf die Handbuchseiten eines anderen Betriebssystems
|
|
zugreifen kann, können diese mit dieser Option durchsucht werden. Um die
|
|
Beschreibungen der Handbuchseiten von NewOS zu durchsuchen, verwenden Sie
|
|
die Option <B>-m</B> <B>NewOS</B>.
|
|
<P>
|
|
Für <I>System</I> können Sie eine mit Kommas getrennte Liste von
|
|
Betriebssystem-Namen eingeben. Um auch in den <B>whatis</B>-Beschreibungen des
|
|
eigenen Systems zu suchen, verwenden Sie beim Aufruf des Programms den
|
|
Systemnamen <B>man</B> als zusätzliches Argument. Diese Option setzt die
|
|
Umgebungsvariable $<B>SYSTEM</B> außer Kraft.
|
|
<DT id="10"><B>-M </B><I>Pfad</I>, <B>--manpath=</B><I>Pfad</I><DD>
|
|
Legt mehrere durch Doppelpunkte getrennte alternative Handbuch-Hierarchien
|
|
fest, die durchsucht werden sollen. Standardmäßig verwendet <B>apropos</B> die
|
|
Umgebungsvariable $<B>MANPATH</B>. Wenn diese leer ist oder ihr kein Wert
|
|
zugewiesen wurde, wird das Programm versuchen, auf Grundlage der
|
|
Umgebungsvariablen $<B>PATH</B> einen geeigneten »Manpath« zu bestimmen. Diese
|
|
Option überschreibt den Inhalt von $<B>MANPATH</B>.
|
|
<DT id="11"><B>-L </B><I>Locale</I>, <B>--locale=</B><I>Locale</I><DD>
|
|
<B>apropos</B> wird in der Regel Ihre aktuelle Locale durch einen Aufruf der
|
|
C-Funktion <B><A HREF="/cgi-bin/man/man2html?3+setlocale">setlocale</A></B>(3) bestimmen, welche verschiedene Umgebungsvariablen
|
|
auswertet (darunter sind eventuell auch $<B>LC_MESSAGES</B> und $<B>LANG</B>). Um
|
|
den ermittelten Wert vorübergehend außer Kraft zu setzen, können Sie
|
|
<B>apropos</B> mit dieser Option eine <I>Locale</I> vorgeben. Beachten Sie, dass
|
|
dieser Wert erst wirksam wird, wenn die Suche tatsächlich
|
|
beginnt. Programm-Meldungen wie Hilfe-Nachrichten werden immer in der zu
|
|
Anfang ermittelten Locale angezeigt werden.
|
|
<DT id="12"><B>-C </B><I>Datei</I>, <B>--config-file=</B><I>Datei</I><DD>
|
|
Verwendung dieser benutzerspezifischen Konfigurationsdatei an Stelle der
|
|
Vorgabe <I>~/.manpath</I>
|
|
<DT id="13"><B>-?</B>, <B>--help</B>
|
|
|
|
|
|
<DD>
|
|
Hilfetext anzeigen und beenden
|
|
<DT id="14"><B>--usage</B>
|
|
|
|
|
|
<DD>
|
|
zeigt eine kurze Anwendungszusammenfassung an und beendet das Programm.
|
|
<DT id="15"><B>-V</B>, <B>--version</B>
|
|
|
|
|
|
<DD>
|
|
Versionsinformation anzeigen und beenden
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>EXIT-STATUS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="16"><B>0</B>
|
|
|
|
|
|
<DD>
|
|
erfolgreiche Programmausführung
|
|
<DT id="17"><B>1</B>
|
|
|
|
|
|
<DD>
|
|
Fehler beim Aufruf, in der Syntax oder in der Konfigurationsdatei
|
|
<DT id="18"><B>2</B>
|
|
|
|
|
|
<DD>
|
|
betriebsbedingter Fehler
|
|
<DT id="19"><B>16</B>
|
|
|
|
|
|
<DD>
|
|
keine Ergebnisse für die angegebenen Suchkriterien
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>UMGEBUNGSVARIABLEN</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="20"><B>SYSTEM</B>
|
|
|
|
|
|
<DD>
|
|
Wenn $<B>SYSTEM</B> gesetzt ist, hat das die gleiche Wirkung wie die Verwendung
|
|
als Argument für die Option <B>-m</B>.
|
|
<DT id="21"><B>MANPATH</B>
|
|
|
|
|
|
<DD>
|
|
Wenn $MANPATH gesetzt ist, wird ihr Wert als der mit Kommas getrennte
|
|
anzuwendende Hierarchie-Suchpfad für Handbuchseiten interpretiert.
|
|
<DT id="22"><B>MANWIDTH</B>
|
|
|
|
|
|
<DD>
|
|
Wenn $<B>MANWIDTH</B> gesetzt ist, wird ihr Wert als Terminalbreite verwendet
|
|
(siehe die Option <B> --long</B>). Ist sie nicht gesetzt, wird die
|
|
Terminalbreite mittels <B><A HREF="/cgi-bin/man/man2html?2+ioctl">ioctl</A></B>(2) oder mit dem Wert von $<B>COLUMNS</B>
|
|
ermittelt, wenn diese Variable gesetzt ist. Wenn alles fehlschlägt, werden
|
|
80 Zeichen verwendet.
|
|
<DT id="23"><B>POSIXLY_CORRECT</B>
|
|
|
|
|
|
<DD>
|
|
Wenn $<B>POSIXLY_CORRECT</B> gesetzt ist, wobei sogar NULL erlaubt ist, wird die
|
|
Standardsuche von <B>apropos</B> mit erweiterten regulären Ausdrücken (<B>-r</B>)
|
|
ausgeführt. Heutzutage ist dies sowieso das Standardverhalten.
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>DATEIEN</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="24"><I>/usr/share/man/index.(bt|db|dir|pag)</I>
|
|
|
|
|
|
<DD>
|
|
ein traditioneller, globaler Zwischenspeicher für die <I>Index</I>-Datenbank
|
|
<DT id="25"><I>/var/cache/man/index.(bt|db|dir|pag)</I>
|
|
|
|
|
|
<DD>
|
|
ein FHS-konformer, globaler Zwischenspeicher für die <I>Index</I>-Datenbank
|
|
<DT id="26"><I>/usr/share/man/.../whatis</I>
|
|
|
|
|
|
<DD>
|
|
eine traditionelle <B>whatis</B>-Textdatenbank
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>SIEHE AUCH</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>AUTOR</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">BEZEICHNUNG</A><DD>
|
|
<DT id="28"><A HREF="#lbAC">ÜBERSICHT</A><DD>
|
|
<DT id="29"><A HREF="#lbAD">BESCHREIBUNG</A><DD>
|
|
<DT id="30"><A HREF="#lbAE">OPTIONEN</A><DD>
|
|
<DT id="31"><A HREF="#lbAF">EXIT-STATUS</A><DD>
|
|
<DT id="32"><A HREF="#lbAG">UMGEBUNGSVARIABLEN</A><DD>
|
|
<DT id="33"><A HREF="#lbAH">DATEIEN</A><DD>
|
|
<DT id="34"><A HREF="#lbAI">SIEHE AUCH</A><DD>
|
|
<DT id="35"><A HREF="#lbAJ">AUTOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:04:55 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|