Hilfe im Terminal: man-Pages, —help und tldr

Kurz: Unter Linux und macOS erklärt jedes Programm sich selbst: mit man, —help und tldr findest du Optionen und Beispiele, ohne den Browser zu öffnen.

Genauer: Es gibt Hunderte Befehle mit unzähligen Optionen; niemand kennt sie alle. Entscheidend ist, schnell nachzulesen. Die Hilfe ist offline verfügbar und passt exakt zur installierten Version.

Im Detail

—help und -h

Die schnellste Variante: ls --help, git --help, git commit -h. Sie zeigt eine Kurzübersicht der Optionen. Manche Programme nutzen -h, help oder /? (Windows). Bei langer Ausgabe hilft | less (scrollen, q beendet): grep --help | less.

man-Pages

man ls öffnet die ausführliche Handbuchseite. Navigation: Pfeiltasten/Leertaste, /suchwort sucht, n springt zum nächsten Treffer, q beendet. Aufbau: NAME, SYNOPSIS (Aufruf), DESCRIPTION, OPTIONS, EXAMPLES, SEE ALSO. Die Nummer gibt die Sektion an: man 1 printf (Befehl), man 3 printf (C-Funktion), man 5 passwd (Dateiformat). man -k begriff oder apropos begriff sucht Handbücher zu einem Thema. info bietet teils ausführlichere Dokumentation.

tldr und cheat.sh

Die man-Seiten sind genau, aber lang. tldr („too long; didn’t read“) zeigt die häufigsten Beispiele kurz und verständlich: tldr tar. Installation: npm install -g tldr, pip install tldr oder über Paketmanager. Online: curl cheat.sh/tar. Auch Spickzettel (Cheat Sheets) in diesem Wiki helfen.

Weitere Wege

• type befehl, which befehl, command -v befehl: Wo liegt das Programm?
• whatis befehl: Ein-Zeilen-Beschreibung.
• Tab-Vervollständigung zeigt Optionen und Pfade.
• Shell-Verlauf: history, Strg+R zur Suche in früheren Befehlen.
• Dokumentation des Projekts (README, Webseite) und Foren wie Unix & Linux StackExchange. Gewöhnung: Erst --help, dann man, dann das Netz.

Siehe auch: grep, sed und awk, zsh, fish und bash, bash, Shell-Skripte schreiben