whatis

Aus Foxwiki

whatis durchsucht die Man-Pages nach Kurzbeschreibungen

whatis - durchsucht die Indexdatenbank nach Kurzbeschreibungen


Beschreibung

WHATIS(1) Dienstprogramme für Handbuchseiten WHATIS(1)

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

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

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.

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

Dokumentation

Man-Pages
Info-Pages

Links

Projekt
Weblinks