tldr
Dieser Artikel wurde für die folgenden Ubuntu-Versionen getestet:
Ubuntu 24.04 Noble Numbat
Ubuntu 22.04 Jammy Jellyfish
Du möchtest den Artikel für eine weitere Ubuntu-Version testen? Mitarbeit im Wiki ist immer willkommen! Dazu sind die Hinweise zum Testen von Artikeln zu beachten.
Zum Verständnis dieses Artikels sind folgende Seiten hilfreich:
Die tldr-pages sind ein gemeinschaftlicher Versuch, die beliebten manpage-Seiten mit praktischen Beispielen zu vereinfachen. Es ist auch möglich, sich an der Entwicklung zu beteiligen und zum Beispiel eigene Seiten zu Programmen zu veröffentlichen 🇬🇧. Die Namensgebung ist übrigens an den Internetslang TL;DR angelehnt.
Installation¶
Achtung!
Das Paket aus den Paketquellen von Ubuntu 22.04 ist von 2018387 betroffen und kann daher nicht genutzt werden.
Befehl zum Installieren der Pakete:
sudo apt-get install tldr tldr-hs
Hinweis:
via Snap¶
Die Installation ist als Snap-Paket möglich:
sudo snap install tldr
Hinweis!
Zusätzliche Fremdquellen können das System gefährden.
via pip¶
Das Programm kann man unter Ubuntu 22.04 via pip installieren.
Der Python-Paketmanager pip stellt häufig aktuellere Versionen von Programmen als in den Paketquellen bereit. Folgendermaßen lässt sich das Programm darüber installieren:
pip3 install tldr # Programm wird nur für den aktuellen Nutzer installiert
Ab Ubuntu 23.04 muss in eine virtuelle Umgebung für Python installiert werden:
python3 -m venv venv-name && source venv-name/bin/activate # venv-name durch den gewünschten Namen ersetzen pip3 install tldr
Die von dem Paket zur Verfügung gestellten Module können nur bei aktivierter Umgebung bzw. direktem Aufruf des zugehörigen Python-Interpreters genutzt werden.
Hinweis!
Fremdsoftware kann das System gefährden.
Unter Ubuntu 24.04 muss die Installation in einer eigenen virtuelle Umgebungen erfolgen. Dies kann beispielsweise mit pipx erfolgen.
pipx install tldr
Der Pfad ~/.local/bin liegt nicht im $PATH und muss daher selbst hinzugefügt werden.
Funktion¶
Die Syntax des Aufrufs lautet:
tldr [OPTION] THEMA
Hinweis:
Bei der Installation über die Paketverwaltung gibt es kein ausführbares tldr, sondern tldr-hs, dass zudem die Option „-L“ erst ab 24.04 kennt.
Folgende Tabelle enthält eine Übersicht der wichtigsten Optionen von tldr.
Optionen von tldr | |
| Option | Beschreibung |
-u | Aktualisieren des lokalen Cache der tldr-pages. |
-L de THEMA | tldr-pages in Deutsch abrufen; es sind aber nicht alle Hilfeseiten übersetzt. |
-p android|linux|osx|sunos|windows THEMA | Abruf von Hilfeseiten für verschiedene andere Plattformen. |
-h | Hilfstext mit einer Übersicht aller Optionen aufrufen. |
-v | Version anzeigen. |
Alternative¶
Ein mögliches, anderes Programm ist mit tealdeer 🇬🇧 seit 23.04 in den offiziellen Paketquellen enthalten.
tealdeer (universe; ab 23.04)
Befehl zum Installieren der Pakete:
sudo apt-get install tealdeer
Links¶
https://tldr.sh/ 🇬🇧 - Projektseite
tldr-pages-clients 🇬🇧 - Wikiseite zu den diversen tldr-pages clients
https://tldr.inbrowser.app/ 🇬🇧 - tldr im Browser nutzen