Befehl "man"

Online bearbeiten

Zweck

Zeigt Handbucheinträge online an.

Syntax

Mann [ [ [ -c ] [ -t. ] [ Abschnitt ] ] | [ -k | -f ] ] [ -F ] [ -m ] [ -MPfad ] [ -r ] [ -a ] Titel ...

Beschreibung

Der Befehl man stellt Referenzinformationen zu Themen wie Befehlen, Subroutinen und Dateien bereit. Der Befehl man zeigt einzeilige Beschreibungen der nach Namen angegebenen Befehle an. Der Befehl man stellt auch Informationen zu allen Befehlen bereit, deren Beschreibungen eine Reihe benutzerdefinierter Schlüsselwörter enthalten.

Der Befehl man formatiert eine bestimmte Gruppe von Man-Pages. Wenn Sie einen Abschnitt für den Parameter Abschnitt angeben, sucht der Befehl Mann in diesem Abschnitt der Handbuchseiten nach dem im Parameter Titel angegebenen Titel.. Der Wert des Parameters Abschnitt kann entweder eine arabische Zahl zwischen 1 und 8 oder ein Buchstabe sein.

Die Abschnittsbuchstaben sind im Folgenden aufgeführt:

Element Beschreibung
C Gibt Befehle an (einschließlich Systemmanagementbefehlen).
F Gibt Man-Pages für Dateitypen an.
L Gibt Bibliotheksfunktionen an.
n Gibt neue Befehle an.
l Gibt lokale Befehle an.
o Gibt alte Befehle an.
p Gibt öffentliche Befehle an.
Hinweis: Die Abschnittskennungen n, l, ound p sind für das Lesen der Hypertextinformationsbasen nicht gültig. die die Betriebssystemdokumentation enthalten.

Die Abschnittsnummern sind im Folgenden aufgelistet:

Element Beschreibung
1 Gibt Benutzerbefehle und Dämonprozesse an.
2. Gibt Systemaufrufe und Kernel-Services an.
3 Gibt Subroutinen an.
4 Gibt Gerätedateien, Einheitentreiber und Hardware an.
5 Gibt Konfigurationsdateien an.
6 Gibt Spiele an.
7 Gibt verschiedene Befehle an.
8 Gibt Verwaltungsbefehle und Dämonprozesse an.
Anmerkung: Die Betriebssystemdokumentation in den Hypertextinformationsdatenbanken ist nur in drei Abschnitte unterteilt: Befehlshandbuchseiten (in Abschnitt 1, äquivalent zu Abschnitt C), Unterroutinenhandbuchseiten (in Abschnitt 3, äquivalent zu Abschnitt L) und Dateihandbuchseiten (in Abschnitt 4, äquivalent zu Abschnitt F). Wenn Sie nach Hypertextinformationen suchen, werden bei der Angabe von Abschnitt 1, 6, 7 oder 8 standardmäßig die Man-Pages zu Befehlen, bei Angabe von Abschnitt 2 oder 3 standardmäßig die Man-Pages zu Subroutinen und bei Angabe von Abschnitt 4 oder 5 standardmäßig die Man-Pages zu Dateien verwendet.

Wenn der Parameter Abschnitt nicht angegeben ist, durchsucht der Befehl man alle Abschnitte des Handbuchs.

Der Suchpfad, den der Befehl man verwendet, ist eine durch Doppelpunkte (:) getrennte Liste von Verzeichnissen, in dem Unterverzeichnisse des Handbuchs enthalten sind.

Der Befehl man zeigt die Man-Pages wie folgt an:

  1. Der Befehl Mann durchsucht die NROFF-Verzeichnisse (Mann?) unter dem /usr/share/man-Verzeichnis.
  2. Der Befehl Mann durchsucht die formatierten Versionsverzeichnisse (Katze?). unter dem /usr/share/man-Verzeichnis. Wenn die formatierte Version verfügbar ist und eine jüngere Änderungszeit als die Quelle des Befehls nroff hat, zeigt der Befehl man die formatierte Version an. Andernfalls wird die Man-Page mit dem Befehl nroff formatiert und angezeigt. Wenn der Benutzer die entsprechende Berechtigung hat, wird die formatierte Man-Page an der richtigen Position gespeichert, sodass die Seite bei späteren Aufrufe des Befehls man nicht erneut formatiert wird.
    Hinweis Für die bereitgestellten Handbuchseiten gibt es keine nroff -Quelle. Sie können die nroff-Quellen für Man-Pages jedoch nicht in den man-Verzeichnissen speichern, und der Befehl man kann die nroff-Quellen finden und verarbeiten.
  3. Wenn der Befehl Mann keine manuelle Seite in der /usr/share/man/man oder Verzeichnis/usr/share/man/cat : Der Befehl Mann durchsucht die über die Option -M oder die Umgebungsvariable MANPATH angegebenen Pfade nach nroff-Verzeichnissen (man?) und formatierte Versionsverzeichnisse (cat?).
  4. Wenn der Befehl man keine Man-Page im Verzeichnis /usr/share/man/man oder /usr/share/man/ cat oder im benutzerdefinierten Verzeichnis man/cat findet, liest der Befehl man in den Hypertextinformationsbasen. Die Hypertextinformationsbasen befinden sich in der Verzeichnisstruktur /usr/share/man/info und enthalten die Betriebssystemdokumentation. Wenn der Befehl in den Hypertextdatenbanken liest, speichert der Befehl man keine Man-Pages in der Verzeichnisstruktur /usr/share/man/cat. Der Befehl man konvertiert die HTML-Datei in eine formatierte Textdatei, die in die Anzeige passt, und zeigt die Man-Page mit dem in der Umgebungsvariablen PAGER angegebenen Befehl an.
  5. Wenn der Befehl man eine Man-Page nicht in den Hypertextinformationsbasen in der Verzeichnisstruktur /usr/share/man/info findet, durchsucht er die benutzerdefinierte Hypertextinformationsbasis (die mit dem Flag -M oder mit der Umgebungsvariablen MANPATH angegeben ist). Die benutzerdefinierte Hypertextinformationsbasis muss die folgende Verzeichnisstruktur haben:
    BasePath[/%{ L | l }]/DocLibraryname/Section/command_or_routine_or_filename.htm
    Dabei gilt:
    • %L stellt die mit LC_MESSAGES angegebene ISO-Sprachnotation dar und %l die ersten 2 Zeichen der mit LC_MESSAGES angegebenen ISO-Sprachnotation. Für LC_MESSAGES=en_US können die Dokumente beispielsweise in Path/en_US oder Path/enplatziert werden.
    • DocLibraryname steht für den Namen der Dokumentationsbibliothek.
    • Section steht für den Abschnittsnamen, der einer der folgenden Werte sein muss:
      • cmds — Stellt den Befehlsabschnitt dar.
      • libs — Stellt den Bibliotheksabschnitt dar.
      • files — Stellt den Dateiabschnitt dar.
    Hinweis: Wenn die Option -m angegeben ist, erfolgt die Suche nach manuellen Seiten nur in der Reihenfolge der Pfade, die über -M oder die Umgebungsvariable MANPATH angegeben sind.

Beim Zugriff auf die HTML-Datenbanken sucht man nach der Betriebssystembibliothek, bevor er mit mit anderen LPP-Bibliotheken fortfährt. In diesen Bibliotheken werden Informationen in der folgenden Reihenfolge verarbeitet:

Element Beschreibung
cmds Befehlsreferenz
libs Subroutinen, Systemaufrufe
Dateien Dateireferenz

Wenn die Standardausgabe ein nicht grafikfähiges Terminal ist, leitet der Befehl Mann seine Ausgabe über eine Pipe weiter, indem er den Befehl mehr mit den Flags -s und -v verwendet. Das Flag -s löscht mehrere Leerzeilen und stoppt nach jeder Seite in der Anzeige. Das Flag -v unterdrückt die Anzeige nicht druckbarer Zeichen am Bildschirm. Drücken Sie die Leertaste, um das Blättern fortzusetzen. Um weitere 11 Zeilen zu blättern, wenn die Ausgabe gestoppt ist, drücken Sie die Tastenkombination Strg-D.

Die Umgebungsvariable PAGER kann auf die gewünschte Seitenbefehl gesetzt werden. Der Standardwert ist der Befehl more . Zum Ändern der Standardseitenfunktion geben Sie Folgendes ein:

PAGER=Somepager
export PAGER

Wenn es beispielsweise angepasste Man-Pages gibt, die mit umgekehrten oder teilweisen Zeilenvorschüben formatiert sind, kann die Umgebungsvariable PAGER auf /usr/bin/pg gesetzt werden, sodass die Zeilenvorschübe nicht als Steuerzeichen ausgegeben werden. Diese Prozedur ist für Man-Pages nicht erforderlich.

Wenn der Befehl man eine Hypertextdatenbank verwendet, kann er mehrere Artikel abrufen. Beispiel:man openzeigt mehrere Artikel an. Bei der Verwendung von SIGINT (Strg-C) wird der Befehl man vollständig beendet. Der Befehlman open closeZeigt auch mehrere Artikel an, aber die Verwendung von SIGINT (Strg-C) führt dazu, dass man die Informationen des Befehls close anzeigt, anstatt beendet zu werden. Ein erneutes Signal SIGINT (Strg-C) bewirkt, dass der Befehl man vollständig beendet wird.

Wenn Sie eine der NCS-Bibliotheksroutinen (Network Computing System) angeben, die ein Dollarzeichen ($) enthalten, geben Sie vor dem $ einen Backslash (\) ein.

Flags

Element Beschreibung
-a Zeigt alle übereinstimmenden Einträge an.
-c Zeigt die Man-Pages mit dem Befehl cat an.
-F Zeigt Einträge in der Schlüsselwortdatenbank an, die sich auf den Befehlsnamen beziehen, der als letzter Parameter angegeben ist. Sie können mehrere Befehlsnamen eingeben, die jeweils durch ein Leerzeichen getrennt werden müssen. Verwenden Sie dieses Flag, wenn Sie nur nach Befehlsartikeln suchen. Zur Verwendung des Flags -f muss ein Rootbenutzer zuvor eingegeben haben.catman -w zum Erstellen der Datei /usr/share/man/whatis .
-F Zeigt nur den ersten übereinstimmenden Eintrag an.
-k Zeigt jede Zeile in der Schlüsselwortdatenbank an, die eine Zeichenfolge enthält, die mit dem als letzten Parameter angegebenen Titel übereinstimmt. Sie können mehrere Titel eingeben, die jeweils durch ein Leerzeichen getrennt werden müssen. Zur Verwendung des Flags -k muss ein Rootbenutzer zuvor eingegeben haben.catman -w zum Erstellen der Datei /usr/share/man/whatis .
-m Sucht nur in den mit MANPATH oder -M angegebenen Pfaden.
-MPfad Ändert die Standardposition, an der der Befehl man nach Man-Pages sucht. Der Pfad ist eine durch Doppelpunkte getrennte Liste von Pfaden, wobei die folgenden speziellen Symbole verwendet werden können:
  • %D-
  • Die AIX® für Manpages.
  • %L - Ein lokalspezifisches Verzeichnis, das der Kategorie LC_MESSAGES des aktuellen Gebietsschemas entspricht.
  • %l - Eine ländereinstellungsspezifische Verzeichnisposition, die den ersten beiden Zeichen der LC_MESSAGES-Kategorie der aktuellen Ländereinstellung entspricht.
-r Sucht über Fernzugriff nach Man-Pages. Wenn die Fernsuche aus irgendeinem Grund fehlschlägt, führt man eine lokale Suche der gewünschten Man-Page durch. Jede der folgenden Bedingungen kann zum Fehlschlagen der Fernsuche führen:
  • Die ferne Maschine ist nicht erreichbar.
  • Beim Lesen der URL ist ein Problem aufgetreten.
  • Ein Java™ -Applet ist nicht installiert oder wurde nicht im Suchpfad des Benutzers gefunden, der in der Umgebungsvariablen PATH angegeben ist.
Hinweis: Die Umgebungsvariable DOCUMENT_SERVER_MACHINE_NAME sollte auf den Namen der Dokumentationssuchservermaschine gesetzt werden, die der Benutzer verwenden möchte. Wenn die AIX für das Gebietsschema des Hosts nicht unterstützt wird, sucht der Befehl man nach der Dokumentation für ein anderes Gebietsschema. Wenn die Suche erfolgreich ist, wird die Dokumentationsseite nach der Konvertierung in die Ländereinstellung des lokalen Hosts angezeigt. Wenn keine alternative Ländereinstellung auf dem lokalen Host installiert ist, zeigt der Befehl man die Dokumentationsseite nicht an.
-T Formatiert die Man-Pages mit dem Befehl troff. Dieses Flag wird ignoriert, wenn die Man-Page in einer Hypertextinformationsbasis gefunden wird.

Exitstatus

Dieser Befehl gibt die folgenden Exitwerte zurück:

Element Beschreibung
0 Erfolgreiche Ausführung.
>0 Es ist ein Fehler aufgetreten.

Beispiele

  1. Geben Sie den folgenden Befehl ein, um Informationen zum Befehl grep anzuzeigen:
    man grep
  2. Geben Sie den folgenden Befehl ein, um Informationen zur Bibliotheksroutine rpc_$register anzuzeigen:
    man rpc_\$register
  3. Geben Sie den folgenden Befehl ein, um alle Einträge in der Schlüsselwortdatenbank /usr/share/man/whatis anzuzeigen, die die Zeichenfolge "mkdir" enthalten:
    man -k mkdir
    Die Ausgabe entspricht dem Befehl apropos. Die Ausgabe des Flags -k wird nur angezeigt, wenn die Schlüsselwortdatenbank /usr/share/man/whatis bereits vorhanden ist.
  4. Geben Sie den folgenden Befehl ein, um alle Einträge aus der Schlüsselwortdatenbank anzuzeigen, die sich auf die Befehle nroff und troff beziehen:
    man -f nroff troff
    Die Ausgabe entspricht dem Befehl whatis. Die Ausgabe des Flags -f wird nur angezeigt, wenn die Schlüsselwortdatenbank /usr/share/man/whatis bereits vorhanden ist.
  5. Geben Sie den folgenden Befehl ein, um alle auf den Befehl FTP bezogenen Artikel im Pfad /usr/share/man oder /usr/share/man/local anzuzeigen:
    man -M/usr/share/man:/usr/share/man/local ftp
  6. Geben Sie den folgenden Befehl ein, um alle übereinstimmenden Einträge anzuzeigen:
    man -a title
  7. Geben Sie den folgenden Befehl ein, um nur den ersten übereinstimmenden Eintrag anzuzeigen:
    man -F title
  8. Geben Sie den folgenden Befehl ein, um nur in den in MANPATH oder -Mangegebenen Pfaden zu suchen:
    man -m -M PATH title
  9. Geben Sie den folgenden Befehl ein, um im benutzerdefinierten PATH zu suchen:
    man -M PATH title

Dateien

Element Beschreibung
/usr/bin/man Enthält den Befehl man.
/usr/share/man Die Standardverzeichnisstruktur für Man-Pages.
/usr/share/man/cat?/* Das Verzeichnis mit vorformatierten Seiten.
/usr/share/man/whatis Enthält die Schlüsselwortdatenbank.
/usr/share/man/man?/* Das Verzeichnis, das Man-Pages im nroff-Format enthält.