8 UNIX/Linux-Man-Befehlsbeispiel zum Anzeigen von Man-Pages

In UNIX- und Linux-Distributionen werden Befehlszeilenprogramme mit ihrer eigenen Dokumentation geliefert, die Manpages oder Manpages genannt werden.

Manpages werden in der Regel vom Entwickler des entsprechenden Programms geschrieben. Im Allgemeinen sind die Handbuchseiten in eine Anzahl von Abschnitten unterteilt.

Das Folgende ist die Liste aller verfügbaren Man-Sektionen. Jeder Abschnitt hat eine eindeutige Nummer und enthält nur einen bestimmten Typ von Handbuchseiten. Man-Section Nummer 3 zum Beispiel enthält nur Manpages von Bibliotheksaufrufen.

• 1 – Ausführbare Programme oder Befehle
• 2 – Systemaufrufe ( vom Kernel bereitgestellte Funktionen )
• 3 – Bibliotheksaufrufe (von der Bibliothek bereitgestellte Funktionen)
• 4 – Spezielle Dateien
• 5 – Dateiformate und Konventionen (Konfigurationsdateien)
• 6 – Spiele
• 7 – Verschiedenes
• 8 – Systemverwaltungsbefehle

Syntax:

man <TOPICNAME>

1. Manpage eines UNIX-Befehls anzeigen

Um die Manpage eines UNIX-Befehls zu lesen, übergeben Sie den Befehlsnamen als Argument an man. Im Folgenden wird die Manpage für den Befehl passwd angezeigt.

$ man passwd
PASSWD(1)     User Commands     PASSWD(1)
NAME
       passwd - change user password
...

Einige Themen können sogar Handbuchseiten in mehr als einem Abschnitt haben. In einem solchen Fall zeigt der Befehl man die Seite mit der niedrigeren Abschnittsnummer an.

In diesem Beispiel enthält der Befehl passwd Handbuchseiten in mehreren Abschnitten. Aber standardmäßig zeigt es die Manpage aus Abschnitt 1.

an

Das in der ersten Zeile der man-Befehlsausgabe angezeigte „PASSWD(1)“ zeigt an, dass die Manpage aus Abschnitt 1 angezeigt wird. Die Manpage-Ausgabe zeigt den Befehlsnamen, die Syntax der Befehle, eine Beschreibung dessen, was der Befehl tut, Optionen, die vom Befehl bereitgestellt werden, etc…

2. Manpage von einem bestimmten Abschnitt anzeigen

Um die Manpage eines bestimmten Abschnitts zu lesen, geben Sie die Abschnittsnummer wie folgt ein. Der Befehl passwd hat sowohl in Abschnitt 1 als auch in Abschnitt 5 eine Manpage. Wenn Sie die Abschnittsnummer nicht angeben, wird standardmäßig die Manpage von Abschnitt 1 angezeigt.

Um die Manpage von Abschnitt 5 anzuzeigen, geben Sie die Abschnittsnummer wie unten gezeigt ein.

$ man 5 passwd

Jetzt wird die Handbuchseite für die Konfigurationsdatei /etc/passwd angezeigt, da Abschnitt 5 für Dateiformate und Konvertierungen steht.

3. Verfügbare Man-Sections für einen Befehl auflisten

Sie können auch alle verfügbaren Abschnitte zu einem bestimmten Thema mit der Option -aw auflisten.

$ man -aw printf
/usr/share/man/man1/printf.1.gz
/usr/share/man/man3/printf.3.gz

Aus der obigen Ausgabe können wir erkennen, dass es 2 printf-Handbücher gibt, eines im Abschnitt „Befehle“ und eines im Abschnitt „Bibliotheksaufrufe“. Sie können also den folgenden man-Befehl ausführen, um beide Manpages anzuzeigen.

$ man printf

$ man 3 printf

4. Alle Manpages für einen Befehl anzeigen – Alle Abschnitte anzeigen

Um alle Manpages für ein bestimmtes Thema anzuzeigen, verwenden Sie die Option „-a“. Sie sehen zuerst die Manpage mit der niedrigsten Nummer. Wenn Sie diese Seite verlassen und „Enter“ drücken, erscheint die nächste Handbuchseite.

$ man -a printf

Der obige Befehl zeigt zuerst die Manpage des Befehls printf(1) an. Wenn Sie „q“ und „Enter“ drücken, wird die Handbuchseite der printf(3)-Bibliotheksfunktion angezeigt.

5. Manpage im HTML-Format in einem Browser anzeigen

Sie können die Handbuchseite auch im HTML-Format mit einem beliebigen Browser Ihrer Wahl mit dem Argument „-H“ anzeigen. Dadurch wird die Handbuchseite für den Befehl printf in Firefox als HTML-Seite geöffnet.

$ export BROWSER=/usr/bin/firefox

$ man -H printf

6. Ändern Sie den von Man Command verwendeten Standard-Pager

Standardmäßig verwendet der Befehl man die Umgebungsvariable $PAGER, um zu identifizieren, welcher Pager zum Anzeigen der Ausgabe verwendet werden soll. Benutzer können den Pager ändern, in dem sie die Manpage lieber sehen möchten, indem sie die Option „-P“ verwenden.

Der folgende Befehl zeigt die Manpage mit more command pager an.

$ man -P more printf

7. Durchsuchen Sie die Man Page im Abschnitt NAME

Um die Manpage nach dem Abschnitt NAME zu durchsuchen, verwenden Sie die Option „-f“ wie unten gezeigt.

$ man -f printf
printf (3)           - formatted output conversion
printf (1)           - format and print data

Dies entspricht der Verwendung des Shell-Befehls whatis.

Der obige Befehl durchsucht die Handbuchseitennamen und zeigt die Beschreibung für das angegebene Thema an, wenn die Handbuchseitennamen mit dem angegebenen Thema übereinstimmen. Sie können auch mehrere Themen in derselben Befehlszeile übergeben.

8. Durchsuchen Sie die Man Page anhand des Abschnitts NAME und DESCRIPTION

Um die Manpage nach dem Abschnitt NAME &BESCHREIBUNG zu durchsuchen, verwenden Sie die Option „-k“. Dies entspricht der Verwendung des Shell-Befehls „apropos“.

$ man -k printf
asprintf (3)         - print to allocated string
dprintf (3)          - print to a file descriptor
fprintf (3)          - formatted output conversion
fwprintf (3)         - formatted wide-character output conversion
printf (1)           - format and print data
printf (3)           - formatted output conversion
snprintf (3)         - formatted output conversion
sprintf (3)          - formatted output conversion
...
...

Der obige Befehl sucht nach dem Schlüsselwort „printf“ als regulärer Ausdruck und zeigt alle Manpages an, die mit dem Schlüsselwort übereinstimmen.