Whatis: Unterschied zwischen den Versionen

Aktuelle Version vom 12. November 2024, 19:39 Uhr

whatis - Indexdatenbank der Man-Page nach Kurzbeschreibungen durchsuchen

Beschreibung

Dienstprogramme für Handbuchseiten

Innerhalb jeder Handbuchseite ist eine Kurzbeschreibung vorhanden.
whatis durchsucht die Namen der Handbuchseiten und zeigt die Beschreibungen der gefundenen Seiten mit passendem Namen an.

Platzhalter

Der Name kann Platzhalter (Wildcards, -w) oder reguläre Ausdrücke (-r) enthalten. Bei der Nutzung dieser Optionen kann es erforderlich sein, den Namen mit Anführungszeichen und Sonderzeichen mit Escape-Sequenzen (\) vor der Verarbeitung durch die Shell zu schützen.

Während der Suche werden Index-Datenbanken verwendet, die von dem Programm mandb aktuell gehalten werden.

Abhängig von Ihrer Installation wird die Datenbank periodisch per Cron-Job aktualisiert - oder Sie müssen nach der Installation neuer Handbuchseiten mandb manuell starten.
Um aus der relativen Index-Datenbank eine althergebrachte whatis-Textdatenbank zu erzeugen, geben Sie den folgenden Befehl ein:

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

wobei Pfad eine Handbuch-Hierarchie wie z.B. /usr/man ist.

type whatis
whatis ist /usr/bin/whatis

Installation

whatis ist Teil des Pakets man-db

Anwendung

whatis thunderbird zeigt an, dass thunderbird Mail User Agent (MUA) and newsgroup/RSS client for X... ist.

$ whatis thunderbird
thunderbird (1)      - Mail User Agent (MUA) and newsgroup/RSS client for X1...

Beispiel

$ whatis man
man (1)              - eine Oberfläche für die System-  
Referenzhandbücher
man (7)              - Makros für das Formatieren von  
Handbuchseiten

Was tut ein Kommando?

$ whatis <Kommando>

Dies entspricht dem Abschnitt NAME der entsprechenden man-page.

Beispiel

whatis whatis
whatis (1) - search the whatis database for complete words.

Aufruf

whatis [-dlv?V] [-r|-w] [-s Liste] [-m System[,...]] [-M Pfad] [-L Locale] [-C Datei] Name ...

Optionen

Unix	GNU	Parameter	Beschreibung
-d	--debug		Ausgabe von Debug-Informationen
-v	--verbose		Ausgabe ausführlicher Warnmeldungen
-r	--regex		Interpretiert jeden Namen als regulären Ausdruck. Wenn ein Name irgendeinem Teil eines Seitennamens entspricht, wird dies als Übereinstimmung gewertet. Aus der Natur von Datenbankabfragen heraus macht diese Option whatis etwas langsamer.
-w	--wildcard		Interpretiert jeden Namen als ein Muster, das Shell-Platzhalter (Wildcards) enthält. Für einen Fund muss der ausgewertete Name mit dem vollständigen Namen der Handbuchseite übereinstimmen. Aus der Natur von Datenbankabfragen heraus macht diese Option whatis etwas langsamer.
-l	--long		Die Ausgabe wird nicht auf die Terminalbreite beschnitten. Normalerweise wird die Ausgabe auf die Terminalbreite gestutzt, um hässliche Ergebnisse schlecht geschriebener BEZEICHNUNGs-Abschnitte zu vermeiden.
-s	--sections= --section=	Liste	Durchsucht nur die vorgegebenen Abschnitte. Liste ist eine durch Kommas oder Doppelpunkte gegliederte Liste von Abschnitten. Wenn ein Eintrag in Liste ein einfacher Abschnitt ist (z. B. »3«), enthält das Ergebnis Seiten aus den Abschnitten »3«, »3perl«, »3x« usw. Wird Abschnitt mit Suffix angegeben (z. B. »3perl«), werden die Ergebnisse nur in diesem speziellen Unterabschnitt gesucht.
-m	--systems=	System[,...]	Wenn Ihr System auch auf die Handbuchseiten eines anderen Betriebssystems zugreifen kann, können diese Seiten mit dieser Option durchsucht werden. Um die Beschreibungen der Handbuchseiten von NewOS zu durchsuchen, verwenden Sie die Option -m NewOS. Das angegebene System kann eine durch Kommas abgetrennte Aufzählung von Betriebssystemnamen sein. Um auch die Handbuchseiten des eigenen Betriebssystems mit zu durchsuchen, geben Sie auch den Systemnamen man als Argument mit ein. Diese Option überschreibt die Umgebungsvariable $SYSTEM.
-M	--manpath=	Pfad	Legt mehrere durch Doppelpunkte getrennte alternative Handbuch-Hierarchien fest, die durchsucht werden sollen. Standardmäßig verwendet whatis die Umgebungsvariable $MANPATH. Wenn diese leer ist oder ihr kein Wert zugewiesen wurde, wird das Programm versuchen, auf Grundlage der Umgebungsvariablen $PATH einen geeigneten »Manpath« zu bestimmen. Diese Option überschreibt den Inhalt von $MANPATH.
-L	--locale=	Locale	whatis wird in der Regel Ihre aktuelle Locale durch einen Aufruf der C-Funktion setlocale(3) bestimmen, welche verschiedene Umgebungsvariablen auswertet (darunter sind eventuell auch $LC_MESSAGES und $LANG). Um den ermittelten Wert vorübergehend außer Kraft zu setzen, können Sie whatis mit dieser Option eine Locale 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.
-C	--config-file=	Datei	Verwendung dieser benutzerspezifischen Konfigurationsdatei an Stelle der Vorgabe ~/.manpath
-?	--help		Hilfetext anzeigen und beenden
	--usage		zeigt eine kurze Anwendungszusammenfassung an und beendet das Programm.
-V	--version		Versionsinformation anzeigen und beenden

Parameter

Umgebungsvariablen

Variable	Beschreibung
SYSTEM	Wenn $SYSTEM gesetzt ist, hat das die gleiche Wirkung wie die Verwendung als Argument für die Option -m.
MANPATH	Wenn $MANPATH gesetzt ist, wird ihr Wert als der mit Kommas getrennte anzuwendende Hierarchie-Suchpfad für Handbuchseiten interpretiert. Siehe den Abschnitt SUCHPFAD in der Handbuchseite manpath(5) für das Standardverhalten und Details dazu, wie mit dieser Umgebungsvariable umgegangen wird.
MANWIDTH	Wenn $MANWIDTH gesetzt ist, wird ihr Wert als Terminalbreite verwendet (siehe die Option --long). Ist sie nicht gesetzt, wird die Terminalbreite mittels ioctl(2) oder mit dem Wert von $COLUMNS ermittelt, wenn diese Variable gesetzt ist. Wenn alles fehlschlägt, werden 80 Zeichen verwendet.

Exit-Status

Status	Beschreibung
0	erfolgreiche Programmausführung
1	Fehler beim Aufruf, in der Syntax oder in der Konfigurationsdatei
2	betriebsbedingter Fehler
16	keine Ergebnisse für die angegebenen Suchkriterien

Konfiguration

Dateien

Option	Beschreibung
/usr/share/man/index.(bt\|db\|dir\|pag)	traditioneller, globaler Zwischenspeicher für die Index-Datenbank
/var/cache/man/index.(bt\|db\|dir\|pag)	FHS-konformer, globaler Zwischenspeicher für die Index-Datenbank
/usr/share/man/.../whatis	traditionelle whatis-Textdatenbank

Anhang

Siehe auch

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

Whatis

Dokumentation

Man-Page

Info-Pages

Links

Projekt

Weblinks

@@ Zeile 1: / Zeile 1: @@
-'''whatis''' durchsucht die Man-Pages nach Kurzbeschreibungen
+'''whatis''' - Indexdatenbank der Man-Page nach Kurzbeschreibungen durchsuchen
-whatis - durchsucht die Indexdatenbank nach Kurzbeschreibungen
 == Beschreibung ==
-WHATIS(1) Dienstprogramme für Handbuchseiten WHATIS(1)
+; Dienstprogramme für Handbuchseiten
+* Innerhalb jeder Handbuchseite ist eine Kurzbeschreibung vorhanden.
-Innerhalb jeder Handbuchseite ist eine Kurzbeschreibung vorhanden. whatis durchsucht die Namen der Handbuchseiten und zeigt die Beschreibungen der gefundenen Seiten mit passendem Namen an.
+* whatis durchsucht die Namen der Handbuchseiten und zeigt die Beschreibungen der gefundenen Seiten mit passendem Namen an.
+; Platzhalter
 Der Name kann Platzhalter (Wildcards, -w) oder reguläre Ausdrücke (-r) enthalten. Bei der Nutzung dieser Optionen kann es erforderlich sein, den Namen mit Anführungszeichen und Sonderzeichen mit Escape-Sequenzen (\) vor der Verarbeitung durch die Shell zu schützen.
-Während der Suche werden Index-Datenbanken verwendet, die von dem Programm mandb aktuell gehalten werden. Abhängig von Ihrer Installation wird die Datenbank periodisch per Cron-Job aktualisiert - oder Sie müssen nach der Installation neuer Handbuchseiten mandb manuell starten. Um aus der relativen Index-Datenbank eine althergebrachte whatis-Textdatenbank zu erzeugen, geben Sie den folgenden Befehl ein:
+Während der Suche werden Index-Datenbanken verwendet, die von dem Programm mandb aktuell gehalten werden.
+* Abhängig von Ihrer Installation wird die Datenbank periodisch per Cron-Job aktualisiert - oder Sie müssen nach der Installation neuer Handbuchseiten mandb manuell starten.
+* Um aus der relativen Index-Datenbank eine althergebrachte whatis-Textdatenbank zu erzeugen, geben Sie den folgenden Befehl ein:
 <syntaxhighlight lang="bash" highlight="1" line>
@@ Zeile 25: / Zeile 25: @@
 == Installation ==
+''whatis'' ist Teil des Pakets [[man-db]]
+== Anwendung ==
+whatis thunderbird zeigt an, dass thunderbird Mail User Agent (MUA) and newsgroup/RSS client for X... ist.
+ $ whatis thunderbird
+ thunderbird (1)      - Mail User Agent (MUA) and newsgroup/RSS client for X1...
+; Beispiel
+ $ whatis man
+ man (1)              - eine Oberfläche für die System-
+ Referenzhandbücher
+ man (7)              - Makros für das Formatieren von
+ Handbuchseiten
+; Was tut ein Kommando?
+ $ '''whatis <Kommando>'''
+Dies entspricht dem Abschnitt <tt>'''NAME'''</tt> der entsprechenden man-page.
+; Beispiel
+ whatis whatis
+ whatis (1) - search the whatis database for complete words.
-== Syntax ==
+== Aufruf ==
 <syntaxhighlight lang="bash" highlight="1" line>
 whatis [-dlv?V] [-r|-w] [-s Liste] [-m System[,...]] [-M Pfad] [-L Locale] [-C Datei] Name ...
@@ Zeile 47: / Zeile 70: @@
 | -l || --long || || Die Ausgabe wird nicht auf die Terminalbreite beschnitten. Normalerweise wird die Ausgabe auf die Terminalbreite gestutzt, um hässliche Ergebnisse schlecht geschriebener BEZEICHNUNGs-Abschnitte zu vermeiden.
 |-
-| -s Liste || --sections=Liste, --section=Liste || || Durchsucht nur die vorgegebenen Abschnitte. Liste ist eine durch Kommas oder Doppelpunkte gegliederte Liste von Abschnitten. Wenn ein Eintrag in Liste ein einfacher Abschnitt ist (z. B. »3«), enthält das Ergebnis Seiten aus den Abschnitten »3«, »3perl«, »3x« usw. Wird Abschnitt mit Suffix angegeben (z. B. »3perl«), werden die Ergebnisse nur in diesem speziellen Unterabschnitt gesucht.
+| -s || --sections=</br>--section= || Liste || Durchsucht nur die vorgegebenen Abschnitte. Liste ist eine durch Kommas oder Doppelpunkte gegliederte Liste von Abschnitten. Wenn ein Eintrag in Liste ein einfacher Abschnitt ist (z. B. »3«), enthält das Ergebnis Seiten aus den Abschnitten »3«, »3perl«, »3x« usw. Wird Abschnitt mit Suffix angegeben (z. B. »3perl«), werden die Ergebnisse nur in diesem speziellen Unterabschnitt gesucht.
 |-
-| -m system[,...] || --systems=System[,...] || || Wenn Ihr System auch auf die Handbuchseiten eines anderen Betriebssystems zugreifen kann, können diese Seiten mit dieser Option durchsucht werden. Um die Beschreibungen der Handbuchseiten von NewOS zu durchsuchen, verwenden Sie die Option -m NewOS. Das angegebene System kann eine durch Kommas abgetrennte Aufzählung von Betriebssystemnamen sein. Um auch die Handbuchseiten des eigenen Betriebssystems mit zu durchsuchen, geben Sie auch den Systemnamen man als Argument mit ein. Diese Option überschreibt die Umgebungsvariable $SYSTEM.
+| -m || --systems= || System[,...] || Wenn Ihr System auch auf die Handbuchseiten eines anderen Betriebssystems zugreifen kann, können diese Seiten mit dieser Option durchsucht werden. Um die Beschreibungen der Handbuchseiten von NewOS zu durchsuchen, verwenden Sie die Option -m NewOS. Das angegebene System kann eine durch Kommas abgetrennte Aufzählung von Betriebssystemnamen sein. Um auch die Handbuchseiten des eigenen Betriebssystems mit zu durchsuchen, geben Sie auch den Systemnamen man als Argument mit ein. Diese Option überschreibt die Umgebungsvariable $SYSTEM.
 |-
-| -M Pfad || --manpath=Pfad || || Legt mehrere durch Doppelpunkte getrennte alternative Handbuch-Hierarchien fest, die durchsucht werden sollen. Standardmäßig verwendet whatis die Umgebungsvariable $MANPATH. Wenn diese leer ist oder ihr kein Wert zugewiesen wurde, wird das Programm versuchen, auf Grundlage der Umgebungsvariablen $PATH einen geeigneten »Manpath« zu bestimmen. Diese Option überschreibt den Inhalt von $MANPATH.
+| -M || --manpath= || Pfad || Legt mehrere durch Doppelpunkte getrennte alternative Handbuch-Hierarchien fest, die durchsucht werden sollen. Standardmäßig verwendet whatis die Umgebungsvariable $MANPATH. Wenn diese leer ist oder ihr kein Wert zugewiesen wurde, wird das Programm versuchen, auf Grundlage der Umgebungsvariablen $PATH einen geeigneten »Manpath« zu bestimmen. Diese Option überschreibt den Inhalt von $MANPATH.
 |-
-| -L Locale || --locale=Locale || || whatis wird in der Regel Ihre aktuelle Locale durch einen Aufruf der C-Funktion setlocale(3) bestimmen, welche verschiedene Umgebungsvariablen auswertet (darunter sind eventuell auch $LC_MESSAGES und $LANG). Um den ermittelten Wert vorübergehend außer Kraft zu setzen, können Sie whatis mit dieser Option eine Locale 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.
+| -L || --locale= || Locale || whatis wird in der Regel Ihre aktuelle Locale durch einen Aufruf der C-Funktion setlocale(3) bestimmen, welche verschiedene Umgebungsvariablen auswertet (darunter sind eventuell auch $LC_MESSAGES und $LANG). Um den ermittelten Wert vorübergehend außer Kraft zu setzen, können Sie whatis mit dieser Option eine Locale 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.
 |-
-| -C Datei || --config-file=Datei || || Verwendung dieser benutzerspezifischen Konfigurationsdatei an Stelle der Vorgabe ~/.manpath
+| -C || --config-file= || Datei || Verwendung dieser benutzerspezifischen Konfigurationsdatei an Stelle der Vorgabe ~/.manpath
 |-
 | -? || --help || || Hilfetext anzeigen und beenden
@@ Zeile 66: / Zeile 89: @@
 === Parameter ===
 === Umgebungsvariablen ===
-; SYSTEM
+{| class="wikitable options"
-Wenn $SYSTEM gesetzt ist, hat das die gleiche Wirkung wie die Verwendung als Argument für die Option -m.
+|-
+! Variable !! Beschreibung
-; MANPATH
+|-
-Wenn $MANPATH gesetzt ist, wird ihr Wert als der mit Kommas getrennte anzuwendende Hierarchie-Suchpfad für Handbuchseiten interpretiert.
+| SYSTEM || Wenn $SYSTEM gesetzt ist, hat das die gleiche Wirkung wie die Verwendung als Argument für die Option -m.
+|-
-Siehe den Abschnitt SUCHPFAD in der Handbuchseite manpath(5) für das Standardverhalten und Details dazu, wie mit dieser Umgebungsvariable umgegangen wird.
+| MANPATH || Wenn $MANPATH gesetzt ist, wird ihr Wert als der mit Kommas getrennte anzuwendende Hierarchie-Suchpfad für Handbuchseiten interpretiert. Siehe den Abschnitt SUCHPFAD in der Handbuchseite manpath(5) für das Standardverhalten und Details dazu, wie mit dieser Umgebungsvariable umgegangen wird.
+|-
-; MANWIDTH
+| MANWIDTH || Wenn $MANWIDTH gesetzt ist, wird ihr Wert als Terminalbreite verwendet (siehe die Option --long). Ist sie nicht gesetzt, wird die Terminalbreite mittels ioctl(2) oder mit dem Wert von $COLUMNS ermittelt, wenn diese Variable gesetzt ist. Wenn alles fehlschlägt, werden 80 Zeichen verwendet.
-Wenn $MANWIDTH gesetzt ist, wird ihr Wert als Terminalbreite verwendet (siehe die Option --long). Ist sie nicht gesetzt, wird die Terminalbreite mittels ioctl(2) oder mit dem Wert von $COLUMNS ermittelt, wenn diese Variable gesetzt ist. Wenn alles fehlschlägt, werden 80 Zeichen verwendet.
+|}
 === Exit-Status ===
-erfolgreiche Programmausführung
+{| class="wikitable options"
+|-
-Fehler beim Aufruf, in der Syntax oder in der Konfigurationsdatei
+! Status !! Beschreibung
+|-
-betriebsbedingter Fehler
+| 0 || erfolgreiche Programmausführung
+|-
-keine Ergebnisse für die angegebenen Suchkriterien
+| 1 || Fehler beim Aufruf, in der Syntax oder in der Konfigurationsdatei
+|-
-== Anwendung ==
+| 2 || betriebsbedingter Fehler
-whatis thunderbird zeigt an, dass thunderbird Mail User Agent (MUA) and newsgroup/RSS client for X... ist.
+|-
+| 16 || keine Ergebnisse für die angegebenen Suchkriterien
- $ whatis thunderbird
+|}
- thunderbird (1)      - Mail User Agent (MUA) and newsgroup/RSS client for X1...
-'''Beispiel'''
- $ whatis man
- man (1)              - eine Oberfläche für die System-
- Referenzhandbücher
- man (7)              - Makros für das Formatieren von
- Handbuchseiten
-Was tut ein Kommando?
- $ '''whatis <Kommando>'''
-Dies entspricht dem Abschnitt <tt>'''NAME'''</tt> der entsprechenden man-page.
-'''Beispiel'''
- whatis whatis
- whatis (1) - search the whatis database for complete words.
-=== Fehlerbehebung ===
 == Konfiguration ==
 === Dateien ===
-; /usr/share/man/index.(bt|db|dir|pag)
+{| class="wikitable options"
-ein traditioneller, globaler Zwischenspeicher für die Index-Datenbank
+|-
+! Option !! Beschreibung
-; /var/cache/man/index.(bt|db|dir|pag)
+|-
-ein FHS-konformer, globaler Zwischenspeicher für die Index-Datenbank
+| <nowiki>/usr/share/man/index.(bt|db|dir|pag)</nowiki> || traditioneller, globaler Zwischenspeicher für die Index-Datenbank
+|-
+| <nowiki>/var/cache/man/index.(bt|db|dir|pag)</nowiki> || FHS-konformer, globaler Zwischenspeicher für die Index-Datenbank
+|-
+| <nowiki>/usr/share/man/.../whatis</nowiki> || traditionelle whatis-Textdatenbank
+|}
-; /usr/share/man/.../whatis
-eine traditionelle whatis-Textdatenbank
 <noinclude>
@@ Zeile 129: / Zeile 137: @@
 ==== Dokumentation ====
-===== Man-Pages =====
+===== Man-Page =====
 ===== Info-Pages =====
 ==== Links ====