Manpage

Was sind "man"-Pages?

Die "man"-Pages (Manual Pages) sind eine umfangreiche Sammlung von Dokumentationen und Handbüchern für nahezu alle Befehle, Programme, Bibliotheken und Systemkonzepte unter Unix-ähnlichen Betriebssystemen, einschließlich Linux. Sie sind hilfreich, um detaillierte Informationen über die Nutzung, Optionen und Beispiele eines bestimmten Befehls oder Tools zu erhalten. Wie nutzt man "man"-Pages?

Um die "man"-Pages in einem Terminal anzuzeigen, verwendet man den Befehl man, gefolgt von dem Namen des Befehls oder Programms, über das man mehr erfahren möchte. Die allgemeine Syntax ist:

 man <befehl>

Beispiel: Um Informationen über den Befehl ls zu erhalten (der zum Auflisten von Dateien und Verzeichnissen verwendet wird), gibt man ein:

 man ls

Aufbau einer "man"-Page

Eine typische "man"-Page ist in verschiedene Abschnitte unterteilt, die je nach Befehl variieren können:

   NAME – Der Name des Befehls und eine kurze Beschreibung.
   SYNOPSIS – Die allgemeine Syntax des Befehls mit seinen Optionen und Argumenten.
   DESCRIPTION – Eine ausführliche Beschreibung der Funktion und Funktionsweise des Befehls.
   OPTIONS – Eine Liste der verfügbaren Optionen und deren Bedeutung.
   EXAMPLES – Beispiele für die Verwendung des Befehls (falls vorhanden).
   SEE ALSO – Verweise auf verwandte Befehle oder weitere Ressourcen.

Navigation in "man"-Pages

In einer "man"-Page kann man sich folgendermaßen bewegen:

* Pfeiltasten – Zum Navigieren nach oben und unten.
* Space-Taste – Blättert eine Seite weiter.
* q – Beendet die "man"-Page und kehrt zum Terminal zurück.
* /Suchbegriff – Sucht nach einem Begriff in der "man"-Page. Mit n springt man zum nächsten Treffer.
* ?Suchbegriff – Sucht nach einem Begriff rückwärts in der "man"-Page. Mit n springt man zum nächsten Treffer weiter rückwärts im Text.

Weitere Tipps zur Nutzung

apropos

Der Befehl apropos ist eine Alternative für die Eingabe von man -k <Suchbegriff>. Dieser Befehl sucht nach allen Befehlen, die den Suchbegriff enthalten, und zeigt kurze Beschreibungen dazu. Dies ist nützlich, wenn man den genauen Befehl nicht kennt.

Beispiel

$ apropos permissions
.
access (2)           - check user's permissions for a file
chmod (2)            - change permissions of a file
dh_fixperms (1)      - fix permissions of files in package build directories
dh_testroot (1)      - ensure that a package is built with necessary level of root permissions
eaccess (3)          - check effective user's permissions for a file
euidaccess (3)       - check effective user's permissions for a file
ioperm (2)           - set port input/output permissions
mariadb-setpermission (1) - interactively set permissions in grant tables (mysql_setpermission is now a symlink to mariadb-setpermission)
...

whatis

Der Befehl whatis - eine Alternative zu man -f <Suchbegriff> – Zeigt eine kurze Übersicht über den Befehl bzw. Hilfeseiten und die zugehörigen "man"-Pages.

Beispiel

$ whatis crontab 
.
crontab (1)          - maintain crontab files for individual users (Vixie Cron)
crontab (5)          - tables for driving cron

Man sieht dass es hier in Sektion 1 als auch Sektion 5 eine Hilfeseite für den Begriff crontab gibt. Die Hilfeseite von Sektion 1 erklärt die Befehle zur Handhabung der crontabs und die Hilfeseite in Sektion 5 erklärt das Dateiformat für eine crontab Datei.

Online-Versionen von Manpages

Es gibt auch mehrere Webseiten die die Informationen der Manpages zusammenfassen und leichter via Browser lesbar anbieten. Hier sind zwei Seiten die ich erwähnen möchte:

• Die Manpages vom Debian-Projekt: https://manpages.debian.org
• Eine recht umfangreiche andere Sammlung von manpages: https://man.cx

Sektionen in "man"-Pages

"man"-Pages sind in nummerierte Sektionen unterteilt. Zum Beispiel findet man Systemaufrufe in Abschnitt 2 und C-Bibliotheksfunktionen in Abschnitt 3.

Beispiel

man 2 open

Der Befehl zeigt zeigt man beispielsweise die Seite des Systemaufrufs open aus Abschnitt 2.

Verfügbare Sektionen

Die "man"-Pages unter Linux und Unix-ähnlichen Systemen sind in verschiedene Sektionen unterteilt, die jeweils eine bestimmte Art von Dokumentation abdecken. Jede Sektion ist einer bestimmten Kategorie von Befehlen, Funktionen oder Dateien zugeordnet. Hier sind die gängigen Sektionen:

1. Benutzerbefehle: Befehle, die direkt in der Shell ausgeführt werden können, z. B. ls, cp, man.
2. Systemaufrufe: Kernelfunktionen und Systemaufrufe, die von Programmen verwendet werden können, z. B. open, read, write.
3. C-Bibliotheksfunktionen: Standardfunktionen der C-Bibliothek (libc), z. B. printf, malloc, exit, aber auch Bibliotheksfunktionen von Scriptsprachen. Für Perl ist die Sektion dann z. B. "3pm" für Sektion 3 - Perl Modules benannt.
4. Gerätedateien und besondere Dateien: Dateien, die sich unter /dev befinden und Hardwaregeräte repräsentieren, z. B. tty.
5. Dateiformate und -konventionen: Beschreibungen von Dateiformaten und Protokollen, z. B. /etc/passwd, fstab.
6. Spiele und Spaßprogramme: Dokumentationen für Spiele oder humorvolle Programme, falls installiert.
7. Sonstiges (z. B. Makros und Konventionen): Verschiedene Dinge, einschließlich Makropaketen und Standarddokumentationen für die Programmierung, z. B. man(7).
8. Systemadministration und Befehle für den Systemadministrator: Befehle und Werkzeuge, die hauptsächlich für den Systemadministrator gedacht sind, z. B. mount, iptables.