TLDR — łatwe do zrozumienia strony podręcznika zawierające polecenia systemu Linux

Jednym z najczęściej używanych i niezawodnych sposobów uzyskania pomocy w systemach uniksowych są strony podręcznika, które stanowią standardową dokumentację każdego systemu uniksowego i odpowiadają podręcznikom online programów, funkcji , biblioteki, wywołania systemowe, standardy formalne i konwencje, formaty plików i tak dalej.

Jednakże strony podręcznika mają wiele wad, z których jedną jest to, że są zbyt długie, a niektórzy ludzie po prostu nie lubią czytać zbyt dużej ilości tekstu na ekranie.

TLDR (skrót od „Too Long; Didn’t Read”) to projekt kierowany przez społeczność, który zapewnia zwięzłą i uproszczoną dokumentację różnych poleceń systemu Linux.

TLDR ma na celu oferowanie szybkich i praktycznych przykładów użycia poleceń, ułatwiając użytkownikom zrozumienie i wykorzystanie poleceń bez konieczności zagłębiania się w obszerne podręczniki lub długie wyjaśnienia.

Dostęp do TLDR jest zwykle możliwy z wiersza poleceń za pomocą polecenia „tldr”, po którym następuje nazwa polecenia, o którym chcesz się więcej dowiedzieć.

tldr ls

TLDR to slang internetowy oznaczający, że post, artykuł, komentarz lub cokolwiek innego, np. strona podręcznika, było za długie i ktokolwiek użył tego wyrażenia, nie czytał go z tego powodu. Treść stron TLDR jest ogólnodostępna w ramach liberalnej licencji MIT.

W tym krótkim artykule pokażemy, jak zainstalować i używać stron TLDR w systemie Linux.

Jak zainstalować strony TLDR w systemach Linux

Aby mieć wygodny dostęp do stron TLDR, musisz zainstalować jednego z obsługiwanych klientów o nazwie Node.js, który jest oryginalnym klientem projektu tldr-pages.

Aby zainstalować Node.js, możesz użyć menedżera pakietów specyficznego dla Twojej dystrybucji.

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 zainstalowaniu Node.js i npm możesz przystąpić do instalacji TLDR za pomocą polecenia npm, jak pokazano .

sudo npm install -g tldr

TLDR jest również dostępny jako pakiet Snap, który można zainstalować i uruchomić.

sudo snap install tldr

Po zainstalowaniu klienta TLDR możesz przeglądać strony podręcznika dowolnego polecenia, na przykład polecenia tar tutaj (możesz tutaj użyć dowolnego innego polecenia):

tldr tar

Oto kolejny przykład dostępu do podsumowanej strony podręcznika dla polecenia ls.

tldr ls

Aby wyświetlić w pamięci podręcznej wszystkie polecenia dla wybranej platformy, użyj flagi -l.

tldr -l 

Aby wyświetlić listę wszystkich obsługiwanych poleceń w pamięci podręcznej, użyj flagi -a.

tldr -a

Możesz zaktualizować lub wyczyścić lokalną pamięć podręczną, uruchamiając.

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

Aby wyszukiwać strony za pomocą słów kluczowych, użyj na przykład opcji -s.

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

Aby zmienić motyw kolorów (prosty, base16, ocean), użyj flagi -t.

tldr -t ocean

Możesz także wyświetlić losowe polecenie za pomocą flagi -r.

tldr -r   

Możesz zobaczyć pełną listę obsługiwanych opcji, uruchamiając.

tldr -h

Listę wszystkich obsługiwanych i dedykowanych aplikacji klienckich dla różnych platform można znaleźć na stronie wiki klientów TLDR.

To wszystko na teraz! Strony TLDR zawierają podsumowanie praktycznych przykładów poleceń udostępnianych przez społeczność. W tym krótkim artykule pokazaliśmy, jak zainstalować i używać stron TLDR w systemie Linux.

Skorzystaj z formularza opinii, aby podzielić się swoimi przemyśleniami na temat TLDR lub udostępnić nam podobne programy.