#howto - tldr: esempi pratici per i comandi
Utilizzando il terminale, potrebbe accadere che ci si dimentichi il funzionamento di alcuni comandi o che non lo si conosca affatto.
Solitamente, è sufficiente dare una rapida occhiata alla pagina di aiuto del comando ricorrendo ai parametri --help o -h.
Altre volte può essere necessario ricorrere al manuale, disponibile mediante il comando man.
In più, alcune shell in particolare dispongono di documentazioni speciali accessibili a parte - è il caso di Zsh, di cui si può consultare l’aiuto dei comandi built-in ricorrendo a run-help.
Va detto, però, che la documentazione è prettamente teorica, e quindi potrebbe non essere sempre immediato estrapolare i parametri e le informazioni cercate.
In passato è stato già trattato TLDR in questo articolo, l’approccio di questo software (qui la pagina del progetto su GitHub) si rivela complementare alla classica documentazione: è quello di fornire esempi pratici, annessi a una breve descrizione su cosa faccia ciascuno di essi.
È degno di nota osservare che il progetto non si limita solamente all’ambiente Linux, ma si focalizza anche su Android, Windows, MacOS e SunOS.
Installazione ed utilizzo
tldr è un progetto comunitario che mira principalmente a raccogliere le pagine d’ esempio.
Per questo, esistono numerosi client che ne consentono la visualizzazione - e non unicamente da console.
In altre parole, si può usare tldr anche senza installarlo (ad esempio, via browser o PDF).
Console
Di seguito, un elenco non esaustivo dei client per console, filtrati (sono stati esclusi quelli aggiornati molto di rado e/o archiviati) ed elencati in base al numero di stelle su GitHub e di sistemi supportati.
I client, tra di loro, non hanno rilevanti differenze di funzionamento siccome sono solitamente conformi alla specifica riguardante i client tldr.
Per consultare la pagina di un comando, è sufficiente digitare tldr <comando>.
NodeJS
Il client originario, scritto in NodeJS (pagina NPM), è quello ufficialmente supportato dai maintainer della repository GitHub.
Si installa usando npm:
npm install -g tldr
Rust
Il client scritto in Rust, tealdeer, si installa mediante cargo:
cargo install tealdeer
Go
A differenza degli altri client, tldr++, scritto in Go (pagina GitHub) è anche interattivo.
È installabile usando go:
go install github.com/isacikgoz/tldr/cmd/tldr@latest
Per gli utenti MacOS o brew, in alternativa:
brew install isacikgoz/taps/tldr
POSIX
Lo script POSIX-compatibile (pagina GitHub) è nient’altro che un unico file eseguibile.
Richiede le sole dipendenze di curl and unzip per essere installato e usato:
curl https://raw.githubusercontent.com/raylee/tldr/master/tldr
chmod +x tldr
Python
Il client scritto in Python (pagina GitHub) va installato con pip:
pip install tldr
Gli utenti Arch Linux possono, in modo equivalente, usare il package manager pacman:
pacman -S tldr
Gli utenti Fedora:
sudo dnf install tldr
C
Il client scritto in C (pagina GitHub) in genere va compilato da sorgente.
Per gli utenti MacOS o brew, è più comodo installare il package tldr:
brew install tldr
Per gli utenti Arch Linux, in alternativa:
yay -S tldr-git
Browser
Se non si vuole installare alcun software, le pagine tldr si possono anche consultare da browser (mediante i client per il web).
tldr.inbrowser.app
Il sito tldr.inbrowser.app è una PWA funzionante anche offline.
Permette inoltre di filtrare le pagine in base a lingua e piattaforma.
DuckDuckGo
Cercare tldr <comando> su DuckDuckGo consente di visualizzare, senza installazione alcuna, la schermata di aiuto di alcuni dei comandi più usati (ma non tutti).
Un PDF omnicomprensivo, lungo alcune migliaia di pagine ma di appena qualche MegaByte di dimensione, è disponibile per il download diretto sul sito ufficiale.