Handbuchseiten richtig lesen: man, tldr und der Aufbau einer Manpage

Die vollständigste Dokumentation eines Programms liegt meistens schon auf dem Rechner. Sie wird nur selten benutzt, weil ihr Aufbau nicht selbsterklärend ist.

Handbuchseiten folgen einer festen Struktur

Jede Manpage ist gleich gegliedert: NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, SEE ALSO. Der schnellste Weg zum Ziel führt fast immer über SYNOPSIS und EXAMPLES, nicht über die Beschreibung. In der SYNOPSIS bedeuten eckige Klammern optionale Angaben, senkrechte Striche Alternativen und drei Punkte eine beliebige Wiederholung.

Suchen innerhalb der Seite

Handbuchseiten werden mit less angezeigt, also gelten dessen Tasten. /begriff sucht vorwärts, n springt zum nächsten Treffer, g an den Anfang, G ans Ende, q beendet. Bei umfangreichen Seiten wie der von rsync mit mehreren tausend Zeilen ist die Suche der einzige praktikable Zugang. Die Zahl in Klammern hinter dem Namen bezeichnet den Abschnitt: 1 für Benutzerbefehle, 5 für Dateiformate, 8 für die Systemverwaltung.

Die Handbuchseite beantwortet Ihre Frage genauer als jedes Forum, nur eben nicht in der Reihenfolge, in der Sie fragen.

tldr für den schnellen Fall

Wenn Sie nur wissen wollen, wie ein Befehl typischerweise aufgerufen wird, liefert tldr befehl eine Handvoll Beispiele statt einer vollständigen Referenz. Das ersetzt die Handbuchseite nicht, verkürzt aber den häufigsten Fall erheblich.

Eine Reihenfolge, die sich bewährt hat:

• befehl --help für den Schnellüberblick;
• tldr befehl für typische Aufrufe;
• man befehl für die vollständige Wahrheit;
• apropos stichwort, wenn Sie den Namen des Befehls gar nicht kennen.

Der letzte Punkt ist der am meisten unterschätzte. apropos compress durchsucht die Kurzbeschreibungen aller installierten Handbuchseiten und beantwortet damit die Frage, die man sonst in eine Suchmaschine tippt. Beachten Sie, dass diese Kurzbeschreibungen in aller Regel auf Englisch vorliegen.