TLDR - Snadno srozumitelné Man Pages pro Linux Commands

Jedním z nejpoužívanějších a nejspolehlivějších způsobů, jak získat pomoc v systémech typu Unix, jsou manové stránky, které jsou standardní dokumentací pro každý systém typu Unix a odpovídají online manuálům programů, funkcí , knihovny, systémová volání, formální standardy a konvence, formáty souborů a tak dále.

Manuálové stránky však trpí mnoha nedostatky, z nichž jedním je, že jsou příliš dlouhé a někteří lidé prostě neradi čtou příliš mnoho textu na obrazovce.

TLDR (zkratka pro „Too Long; Don’t Read“) je komunitně řízený projekt, který poskytuje stručnou a zjednodušenou dokumentaci pro různé příkazy Linuxu.

TLDR si klade za cíl nabídnout rychlé a praktické příklady použití příkazů, které uživatelům usnadňují pochopení a používání příkazů, aniž by se museli ponořit do obsáhlých příruček nebo zdlouhavých vysvětlování.

K TLDR se obvykle přistupuje z příkazového řádku pomocí příkazu „tldr“, za kterým následuje název příkazu, o kterém se chcete dozvědět.

tldr ls

TLDR je internetový slang, což znamená, že příspěvek, článek, komentář nebo cokoli, jako je manuálová stránka, byly příliš dlouhé a kdokoli ji použil, z tohoto důvodu ji nečetl. Obsah stránek TLDR je otevřeně dostupný pod licencí MIT.

V tomto krátkém článku si ukážeme, jak nainstalovat a používat stránky TLDR v Linuxu.

Jak nainstalovat stránky TLDR v systémech Linux

Pro pohodlný přístup ke stránkám TLDR je třeba nainstalovat jednoho z podporovaných klientů s názvem Node.js, což je původní klient pro projekt tldr-pages.

Chcete-li nainstalovat Node.js, můžete použít správce balíčků specifický pro vaši distribuci.

sudo apt install nodejs npm         [On Debian, Ubuntu and Mint]
sudo yum install nodejs npm         [On RHEL/CentOS/Fedora and Rocky/AlmaLinux]
sudo emerge -a sys-apps/nodejs npm  [On Gentoo Linux]
sudo apk add nodejs npm             [On Alpine Linux]
sudo pacman -S nodejs npm           [On Arch Linux]
sudo zypper install nodejs npm      [On OpenSUSE]    

Po instalaci Node.js a npm můžete pokračovat v instalaci TLDR pomocí příkazu npm, jak je znázorněno .

sudo npm install -g tldr

TLDR je k dispozici také jako balíček Snap, lze jej nainstalovat a spustit.

sudo snap install tldr

Po instalaci klienta TLDR můžete zobrazit manuálové stránky libovolného příkazu, například příkaz tar zde (zde můžete použít jakýkoli jiný příkaz):

tldr tar

Zde je další příklad přístupu k souhrnné manuálové stránce pro příkaz ls.

tldr ls

Chcete-li zobrazit všechny příkazy pro vybranou platformu v mezipaměti, použijte příznak -l.

tldr -l 

Chcete-li zobrazit seznam všech podporovaných příkazů v mezipaměti, použijte příznak -a.

tldr -a

Spuštěním můžete aktualizovat nebo vymazat místní mezipaměť.

tldr -u	#update local cache 
OR
tldr -c 	#clear local cache 

Chcete-li vyhledávat stránky pomocí klíčových slov, použijte například možnosti -s.

tldr -s  "list of all files, sorted by modification date"

Chcete-li změnit barevný motiv (simple, base16, ocean), použijte příznak -t.

tldr -t ocean

Můžete také zobrazit náhodný příkaz s příznakem -r.

tldr -r   

Spuštěním můžete zobrazit úplný seznam podporovaných možností.

tldr -h

Seznam všech podporovaných a vyhrazených klientských aplikací pro různé platformy naleznete na wiki stránce klientů TLDR.

To je prozatím vše! Na stránkách TLDR jsou shrnuty praktické příklady příkazů poskytovaných komunitou. V tomto krátkém článku jsme si ukázali, jak nainstalovat a používat stránky TLDR v Linuxu.

Pomocí formuláře zpětné vazby se podělte o své názory na TLDR nebo se s námi podělte o jakékoli podobné programy.