So navigieren Sie effizient durch Handbuchseiten unter Linux
Eine gute Dokumentation ist für jede Software zwingend erforderlich, und dieses Prinzip gilt auch für Linux-Befehle.
Zahlreiche Linux-Distributionen und Open-Source-Communities bieten eine umfassende Dokumentation, die im Internet leicht zugänglich ist.
Diese Dokumentation enthält ausführliche Informationen, Anweisungen und Erklärungen zu Linux-Befehlen, um sicherzustellen, dass Benutzer über die Ressourcen verfügen, die sie benötigen, um die ihnen zur Verfügung stehenden Befehlszeilentools effektiv zu nutzen und zu verstehen.
Es gibt jedoch Fälle, in denen eine präzise Dokumentation ausreicht, um eine bestimmte Aufgabe schnell zu erledigen. In solchen Situationen können wir uns auf die eingebaute Systemdokumentation verlassen, die über den Befehl "man" zugänglich ist.
Der Befehl "man" ist eine Kurzform von "manual" und dient als Schnittstelle, um auf die Referenzhandbücher des Systems zuzugreifen. Diese Handbücher, die auch als "Manpages" bezeichnet werden, enthalten eine detaillierte Dokumentation für die einzelnen Befehle.
Zum Beispiel bieten die Manpages von Befehlen wie mkdir, rmdir, dd und anderen eine detaillierte Dokumentation zu ihren jeweiligen Funktionalitäten und Verwendung.
$ man mkdir
man rmdir
man dd
Man sollte mit dem Befehl "man" vertraut sein, um Linux effizient vom Terminal aus zu nutzen.
man Befehl Syntax
Die Syntax des Befehls man ist einfach:
$ man [OPTIONS] ... ...
Wie bei jedem anderen Linux-Befehl stellt das Paar eckiger Klammern ([]) das optionale Argument dar, während das Paar eckiger Klammern (<>) das obligatorische Argument darstellt.
Abschnitte des man Command
Neben Shell-Befehlen unterstützt Linux auch andere Programmierkonstrukte wie Systemaufrufe, Bibliotheksaufrufe, spezielle Dateien und so weiter. Zur besseren Organisation wird jedes Programmierkonstrukt in einer speziellen Gruppe zusammengefasst, die als Sektionen bezeichnet wird.
Lassen Sie uns also jeden Männerabschnitt kurz besprechen:
- Abschnitt 1 – Dieser Abschnitt enthält Handbuchseiten von ausführbaren Programmen oder Shell-Befehlen. Zum Beispiel cut, gzip, uniq usw.
- Abschnitt 2 – Dieser Abschnitt enthält Handbuchseiten von Systemaufrufen. Ein Systemaufruf wird vom Linux-Kernel verwendet, um seine Funktionalität verfügbar zu machen. Die gebräuchlichsten Systemaufrufe sind
– open(),read(),write(),close(),lseek()usw. - Abschnitt 3 – Dieser Abschnitt enthält Handbuchseiten von Bibliotheksaufrufen. Bibliotheksaufrufe sind die Funktionen, die von den Bibliotheken im Benutzerbereich bereitgestellt werden. Zum Beispiel die Funktion
strlen()aus der Zeichenfolgenbibliothek,die Funktion fopen()aus der Standard-Eingabe-/Ausgabebibliothek usw. - Abschnitt 4 – Dieser Abschnitt enthält die Handbuchseiten der speziellen Dateien. Normalerweise befinden sich diese Dateien im Verzeichnis
/dev. Beispiel:/dev/null,/dev/fullusw. - Abschnitt 5 – Dieser Abschnitt enthält Handbuchseiten der Dateiformate und Konventionen. Beispiel: /etc/hosts, /etc/shadow usw.
- Abschnitt 6 – Dieser Abschnitt enthält spielbezogene Handbuchseiten.
- Abschnitt 7 – Dieser Abschnitt enthält Handbuchseiten der verschiedenen Befehle. Zum Beispiel Mann und Groff.
In diesem Leitfaden für Einsteiger werden wir uns mit den Feinheiten des "man"-Befehls befassen und anhand praktischer Beispiele vertieftes Wissen erlangen.
1. Manpage des Linux-Befehls anzeigen
Eine der Hauptanwendungen des Befehls man ist die Anzeige der Systemdokumentation. Das gültige Argument für den Befehl man ist der Name des Programms, des Dienstprogramms oder der Funktion.
Um dies zu verstehen, verwenden wir den folgenden Befehl, um die Manpage des sleep-Befehls anzuzeigen.
$ man sleep
In der obigen Ausgabe können wir sehen, dass der Befehl man detaillierte Informationen über den Befehl sleep anzeigt. Wir können die 'q'-Taste drücken, um das Manpage-Fenster zu verlassen und zum Terminal zurückzukehren.
Wenn Sie genau hinsehen, können wir sehen, dass in der oberen linken und rechten Ecke nach dem Befehlsnamen in Klammern eine Zahl steht. Diese Zahl steht für den Abschnitt der Manpage.
In der obigen Ausgabe wird beispielsweise SLEEP(1) verwendet, um Abschnitt 1 der Handbuchseite darzustellen.
2. Navigieren Sie durch eine Manpage
Jede Handbuchseite enthält ausführliche Informationen. Zum Beispiel die Beschreibung des Befehls mit allen unterstützten Optionen, Exit-Codes, Autor des Befehls, bekannte Probleme/Fehler usw.
Solche detaillierten Informationen können nicht in einem einzelnen Terminalfenster angezeigt werden, daher verwendet der man-Befehl standardmäßig das Pager-Dienstprogramm namens less.
Wir können die folgenden Pager-Befehle verwenden, um effizient durch die Manpage zu navigieren:
- Pfeil nach oben – um in einer Handbuchseite um eine Zeile vorwärts zu gehen.
- Pfeil nach unten – um in einer Handbuchseite um eine Zeile rückwärts zu gehen.
- f oder Leerzeichen – um in einer Handbuchseite um ein Terminalfenster vorwärts zu gehen.
- b – um in einer Handbuchseite um ein Terminalfenster rückwärts zu blättern.
- /pattern – um nach einem Muster in einer Handbuchseite in Vorwärtsrichtung zu suchen.
- ?pattern – um in einer Handbuchseite in umgekehrter Richtung nach einem Muster zu suchen.
3. Manpage aus einem bestimmten Abschnitt anzeigen
Viele Linux-Befehle sind nach den Systemaufrufen oder Bibliotheksfunktionen benannt. Zum Beispiel ist chown sowohl ein Linux-Befehl als auch ein Systemaufruf. In ähnlicher Weise ist der Ruhezustand sowohl ein Linux-Befehl als auch eine Bibliotheksfunktion.
Standardmäßig sucht der Befehl man in allen Abschnitten nach der Dokumentation und zeigt die Seite aus dem ersten übereinstimmenden Abschnitt an.
Im vorherigen Beispiel zeigt der Befehl – man sleep beispielsweise nur die Manpage aus Abschnitt 1 an, auch wenn die Manpage auch in Abschnitt 3 vorhanden ist. In solchen Fällen können wir specify the section number als Befehlszeilenargument für den man-Befehl verwenden.
Sehen wir uns nun die Manpage der Bibliotheksfunktion sleep() mit dem folgenden Befehl an:
$ man 3 sleep
Im obigen Befehl steht die Zahl 3 nach dem man-Befehl für Abschnitt 3.
4. Manpage aus allen Abschnitten anzeigen
In den vorherigen Beispielen haben wir gesehen, wie eine Manpage sowohl aus dem Standard- als auch aus dem spezifischen Abschnitt angezeigt wird. Manchmal kennen wir jedoch nicht die anderen Abschnitte, in denen die Manpage verfügbar ist.
In solchen Fällen können wir die Option -a mit dem Befehl verwenden, um Handbuchseiten aus allen Abschnitten anzuzeigen.
$ man -a sleep
Mit dieser Option zeigt der man-Befehl alle Handbuchseiten nacheinander an. Um die nächste Handbuchseite anzuzeigen, müssen wir daher die aktuelle Handbuchseite beenden, indem wir die Taste 'q' drücken.
Zum Beispiel werden die folgenden Anweisungen auf dem Bildschirm angezeigt, nachdem Sie die Taste "q" gedrückt haben.
5. Suchabschnitte der Manpage
Im vorherigen Beispiel haben wir gesehen, wie die Manpages aus allen Abschnitten angezeigt werden. Manchmal möchten wir jedoch nur die Abschnitte wissen, in denen die jeweilige Manpage verfügbar ist.
In solchen Fällen können wir die Option -f verwenden, um den Abschnitt der Handbuchseite zusammen mit der Kurzbeschreibung anzuzeigen.
$ man -f sleep
In der obigen Ausgabe sehen wir die prägnanten Informationen über den Schlaf aus den Abschnitten 3 bzw. 1.
6. Suchen Sie Manpages nach Schlüsselwörtern
Manchmal möchten wir in der Beschreibung der Manpage nach einem bestimmten Schlüsselwort suchen. In solchen Fällen können wir die Option -k verwenden, die die Manpages nach Schlüsselwörtern auflistet.
Lassen Sie uns nun alle Handbuchseiten auflisten, in denen das Wort sleep vorkommt:
$ man -k sleep
7. Finden Sie den Quellspeicherort der Manpage
Eine Handbuchseite ist eine reine Textdatei, die mit dem Befehl gzip komprimiert wird. Mit der Option -w wird der Speicherort der Handbuchseitendatei gedruckt.
$ man -a -w sleep
/usr/share/man/man1/sleep.1.gz
/usr/share/man/man3/sleep.3.gz
In der obigen Ausgabe können wir sehen, dass die Man-Page-Datei aus Abschnitt 1 im Verzeichnis /usr/share/man/man1 vorhanden ist. In ähnlicher Weise befindet sich die Manpage-Datei aus Abschnitt 3 im Verzeichnis /usr/share/man/man3.
8. Manpage im GNOME-Hilfebrowser anzeigen
Bisher haben wir alle Handbuchseiten nur auf dem Terminal angezeigt. Wir können sie jedoch auch im GNOME-Hilfebrowser anzeigen, indem wir den Befehl yelp verwenden.
$ yelp man:sleep
Es ist wichtig zu beachten, dass diese Methode nur nützlich ist, wenn die GNOME-Desktop-GUI verfügbar ist.
9. Manpage im Webbrowser anzeigen
Darüber hinaus können wir auch die Option -H verwenden, um die Manpage in einem Webbrowser wie dem Firefox-Browser anzuzeigen.
$ man -Hfirefox sleep
Auf einigen Systemen erhalten Sie möglicherweise die folgende Fehlermeldung:
man: command exited with status 3: (cd /tmp/hmanQf1PgM && /usr/lib/man-db/zsoelim) | (cd /tmp/hmanQf1PgM && /usr/lib/man-db/manconv -f UTF-8:ISO-8859-1 -t UTF-8//IGNORE) | (cd /tmp/hmanQf1PgM && preconv -e UTF-8) | (cd /tmp/hmanQf1PgM && tbl) | (cd /tmp/hmanQf1PgM && groff -mandoc -Thtml)
Um diesen Fehler zu beheben, müssen wir das Dienstprogramm groff installieren, ein Satzsystem, das häufig zum Formatieren und Verarbeiten von Nur-Text-Dokumenten verwendet wird.
$ sudo apt install groff [On Debian, Ubuntu and Mint]
sudo yum install groff [On RHEL/CentOS/Fedora and Rocky/AlmaLinux]
sudo emerge -a sys-apps/groff [On Gentoo Linux]
sudo apk add groff [On Alpine Linux]
sudo pacman -S groff [On Arch Linux]
sudo zypper install groff [On OpenSUSE]
Schlussfolgerung
In diesem Handbuch haben wir besprochen, wie die Dokumentation zum Linux-System angezeigt wird. Wir haben die Verwendung des Befehls "man" untersucht, um die Systemdokumentation sowohl auf dem Terminal als auch in UI-Tools anzuzeigen.
Kennen Sie eine andere Möglichkeit, auf die Linux-Systemdokumentation zuzugreifen? Teilen Sie uns Ihre Meinung in den Kommentaren unten mit.