[[Vorlage(Getestet, jammy, noble)]] 

{{{#!vorlage Wissen
[:Terminal: Ein Terminal öffnen]
[:Pakete_installieren: Installation von Programmen] 
}}}
[[Inhaltsverzeichnis()]] 

[[Bild(Wiki/Icons/terminal.png, 48, align=left)]]

Die tldr-pages sind ein gemeinschaftlicher Versuch, die beliebten [:man: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 [https://github.com/tldr-pages/tldr#how-do-i-contribute-to-tldr-pages veröffentlichen] {en}. Die Namensgebung ist übrigens an den Internetslang [wikipedia_en:TL;DR:] angelehnt.

= Installation =

{{{#!vorlage Warnung
Das Paket aus den Paketquellen von Ubuntu 22.04 ist von [bug:2018387:] betroffen und kann daher nicht genutzt werden.
}}}

{{{#!vorlage Paketinstallation
tldr, universe; bis [:22.04:]
tldr-hs, universe; ab [:24.04:] bis [:25.04:]
}}}

{{{#!vorlage hinweis
Ein möglicher Ersatz ist das in [:Rust:] geschriebene `tldr` aus dem Paket '''tealdeer''', (''universe''; ab [:24.04:])
}}}

== via Snap ==

Die Installation ist als [:snap:Snap]-Paket möglich:

{{{#!vorlage Befehl
sudo snap install tldr
}}}

[[Vorlage(Fremd, Quelle, "")]]

== via pip ==
Das Programm kann man unter Ubuntu 22.04 via [:pip:] installieren.

[[Vorlage(PipInstallation, tldr)]]

Unter Ubuntu 24.04 muss die Installation in einer eigenen virtuelle Umgebungen [:pip/#Ab-Ubuntu-23-04: erfolgen]. Dies kann beispielsweise mit pipx erfolgen.

{{{#!vorlage Befehl
pipx install tldr
}}}

Der Pfad '''~/.local/bin''' liegt nicht im '''$PATH''' und muss daher selbst hinzugefügt [:Umgebungsvariable/Dateien: werden].

= Funktion =

[[Bild(tldr_tldr.png, 400x400, align=right)]]

Die Syntax des Aufrufs lautet: 

{{{#!vorlage Befehl
tldr [OPTION] THEMA
}}}

{{{#!vorlage 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`. 

{{{#!vorlage Tabelle
<tableclass="zebra_3" rowclass="titel"-2> Optionen von `tldr`
+++
<rowclass="kopf"> 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 [github:tealdeer-rs/tealdeer: tealdeer] {en} seit [:Lunar Lobster:23.04] in den offiziellen Paketquellen enthalten.

{{{#!vorlage Paketinstallation
tealdeer, universe; ab [:23.04:]
}}}


= Links =
 * [https://tldr.sh/] {en} - Projektseite
 * [github:tldr-pages/tldr/wiki/tldr-pages-clients:tldr-pages-clients] {en} - Wikiseite zu den diversen tldr-pages clients
 * [https://tldr.inbrowser.app/] {en} - tldr im Browser nutzen

#tag: Shell