Cos’è TLDR e come usarlo spiegato

Gli utenti della riga di comando di Linux dovrebbero avere familiarità con il comando “man”. Questo sta per pagine man, il che significa che ogni comando o utilità Linux viene fornito con il set di istruzioni o il possibile utilizzo del comando. Le pagine man sono molto utili mentre si lavora sulla riga di comando, ma spesso la documentazione disponibile tramite le pagine man è troppo lunga o troppo confusa per essere appresa. Inoltre non fornisce alcun esempio di vita reale. Tutto ciò che include sono i dettagli di ciò che fa quel particolare comando e quali sono le sue opzioni disponibili (chiamate anche opzioni).

TLDR (Too Long Didn’t Read) è uno sforzo condotto dalla comunità per migliorare le pagine man predefinite di Linux, fornisce una documentazione semplice per ogni comando o utilità e dimostra anche l’utilizzo dei comandi con esempi abbastanza semplici. In questo articolo impareremo il processo di installazione di TLDR e come usarlo per lavorare meglio sui terminali Linux.

Come installare TLDR su sistemi Ubuntu e CentOS

Il modo più semplice per installare TLDR è utilizzare NPM e Nodejs. Quindi, dobbiamo prima installare questi due componenti sul nostro sistema. Gli utenti del sistema Ubuntu possono installare NPM e Nodejs utilizzando il seguente comando.

sudo apt-get install nodejs npm

Gli utenti CentOS dovranno prima abilitare il repository EPEL di Yum. Esegui il seguente comando per installare il repository Epel, una volta che è attivo, saremo in grado di installare nodejs e npm usando YUM.

yum install epel-release -y

Esegui il seguente comando sul tuo sistema CentOS per installare Node e NPM.

sudo yum install nodejs npm

Ok, esegui ora il seguente comando sul tuo sistema per completare il processo di installazione.

sudo npm install -g tldr

Congratulazioni, hai equipaggiato con successo il tuo sistema Linux con manuali di comandi di facile comprensione.

Esempi di TLDR

La sintassi per ottenere aiuto usando TLDR è abbastanza semplice, usa il seguente formato.

tldr Command

Dove sostituisci “Comando” con l’utilità effettiva o il nome del comando per cui stai cercando di ottenere la documentazione.

La documentazione per il comando ‘ls’ appare come mostrato di seguito.

# tldr ls

ls
List directory contents.

- List files one per line:
ls -1

- List all files, including hidden files:
ls -a

- Long format list (permissions, ownership, size and modification date) of all files:
ls -la

- Long format list with size displayed using human readable units (KB, MB, GB):
ls -lh

- Long format list sorted by size (descending):
ls -lS

Non è un modo estremamente semplice e descrittivo? ecco come appare la documentazione per il comando tar:

# tldr tar

tar
Archiving utility.
Optional compression with gzip / bzip.

- Create an archive from files:
tar cf target.tar file1 file2 file3

- Create a gzipped archive:
tar czf target.tar.gz file1 file2 file3

- Extract an archive in a target folder:
tar xf source.tar -C folder

- Extract a gzipped archive in the current directory:
tar xzf source.tar.gz

- Extract a bzipped archive in the current directory:
tar xjf source.tar.bz2

- Create a compressed archive, using archive suffix to determine the compression program:
tar caf target.tar.xz file1 file2 file3

Come puoi vedere, fornisce un modo molto intuitivo per cercare informazioni sull’ordine. Mostra esempi di diversi usi di ogni comando, rendendoli molto facili da capire.

Puoi anche elencare tutti i comandi disponibili nel repository digitando:

$ tldr -l

collaboratore

Se non riesci a trovare un ordine o hai altri esempi per un ordine esistente, puoi contribuire al progetto!

Prima di tutto, assicurati di seguire tutti questi elementi:

Istruzioni

1. È meglio mantenere le pagine a circa 5 esempi. Se è proprio necessario, le pagine possono essere più lunghe, ma non possono superare gli 8 esempi. La pagina non deve coprire tutto, tutto qui uomo è per.
2. In caso di dubbio, scegli il metodo sicuro che sai funzionerà sempre. Ad esempio: comandi che richiedono sudo dovrebbe includerlo direttamente negli esempi.
3. Includi opzioni lettera oltre alle opzioni lettera singola. Questo dà all’utente la possibilità di capire cosa sta facendo.
4. Negli esempi, inizia con le opzioni più semplici e poi passa a quelle più complesse.
5. Evita di spiegare i concetti generali di UNIX, concentrati solo sui dettagli specifici del comando.

Formato ribassato

Il formato di ogni pagina dovrebbe essere così:

# command-name

> Short, snappy description.
> Preferably one line; two are acceptable if necessary.

- Example description:

`command -opt1 -opt2 -arg1 {{arg_value}}`

- Example description:

`command -opt1 -opt2`

C’è un formattatore che applica il formato sopra. Funziona automaticamente in ogni richiesta pull, ma puoi installarlo per vedere come saranno i tuoi contributi:

$ sudo npm install tldr-lint
$ tldrl -f {{page.md}}

Puoi controllare più usi o tldrl digitando:

$ tldr tldrl

Sintassi dei simboli

Uso {{gettone}} sintassi per i valori forniti dall’utente per consentire ai client tldr di evidenziarli. Dovresti usare token composti da più parole snake_case.

Istruzioni per la scelta dei nomi dei simboli:

1. I valori dei simboli dovrebbero essere brevi e descrittivi. Per esempio: {{percorso_file}} o {{home/utente/.bashrc}}
2. Se l’esempio è più chiaro utilizzando un valore effettivo, invece di scrivere la variabile di input, il nome del parametro o altro, utilizzare il valore effettivo. Ad esempio: Usa ferma – h {{5}} Di stop -h {{time_in_HHmm}}
3. Per qualsiasi riferimento a percorsi di file o cartelle, utilizzare il formato {{percorso/verso/}}. Per esempio, ln -s {{percorso/al/file}} {{percorso/al/link simbolico}}. Nel caso di un possibile riferimento sia a un file che a una cartella, utilizzare {{percorso/al/file_o_cartella}}
4. Segue {{percorso/verso/}} convenzione quando è presente un comando relativo al percorso, a meno che il percorso del file non sia predefinito.
5. Se c’è un comando che si aspetta che un file abbia una certa estensione, mostralo. Esempio: unrar x {{file_compresso.rar}}. Se è richiesta un’estensione generica, utilizzare {{.ext}}

Queste sono solo linee guida, non regole ferree, prova solo a seguirle e rendi gli esempi il più intuitivi possibile.

Invio di una richiesta di prelievo

Puoi utilizzare il metodo che preferisci:

L’interfaccia web di Github

Il modo più semplice è modificare la pagina direttamente dall’interfaccia utente di Github. Puoi vedere alcune istruzioni sopra Qui.

Riga di comando

1. Effettua il fork del repository dall’interfaccia utente di Github
2. Clona il tuo fork sul tuo computer locale

   https://help.github.com/articles/editing-files-in-another-user-s-repository/

3. Crea un ramo di funzionalità

   git checkout -b {{branch_name}}

4. Apporta le tue modifiche
5. Confermare le modifiche

    git commit --all -m "{{commit_message}}"</>

6. Spingere alla forchetta

    git push origin {{branch_name}}</>

7. Vai alla pagina github per il tuo fork e fai clic sul pulsante di richiesta verde.

Invia solo le modifiche correlate nella stessa richiesta.

Per il messaggio di conferma, utilizzare questo comando:

<command>: type of change

Esempio: ls: aggiungi pagina

Puoi anche fare riferimento a il magazzino ufficiale per trovare altra documentazione.

Aggiornamento TLDR

È importante mantenere aggiornato il TLDR in modo da avere le informazioni più aggiornate. Aggiunge continuamente sempre più documentazione e puoi aggiornarla usando il seguente comando.

tldr --update

Uso online (sul web)

È inoltre possibile visualizzare la documentazione/guida dei comandi di Linux utilizzando versione online. Gli sviluppatori hanno un URL web che puoi utilizzare per cercare documentazione o aiuto per qualsiasi utilità/comando Linux. Vai al seguente URL e digita semplicemente il nome del comando/utility che desideri e premi “Invio”, ti verrà presentata la documentazione della community sul comando che stai cercando ed è un’interfaccia piuttosto carina.

Spero che questo articolo ti sia piaciuto, ho discusso il processo di installazione e utilizzo per il comando TLDR in questo tutorial. Puoi anche utilizzare la versione online di questa utility per migliorare la produttività quotidiana della riga di comando di Linux. Ti fa risparmiare un sacco di tempo e ti fornisce le informazioni necessarie nel modo più semplice e dettagliato possibile. Provalo oggi! facci sapere nella sezione commenti sulla tua esperienza con questa utility.