TLDR - Pages de manuel faciles à comprendre pour les commandes Linux

L’un des moyens les plus couramment utilisés et les plus fiables d’obtenir de l’aide sous les systèmes de type Unix est d’utiliser les pages de manuel, qui sont la documentation standard de chaque système de type Unix et qui correspondent à des manuels en ligne pour les programmes, les fonctions, les bibliothèques, les appels système, les normes formelles et les conventions, les formats de fichiers, etc.

Cependant, les pages de manuel souffrent de nombreux défauts, dont l’un est qu’elles sont trop longues et que certaines personnes n’aiment tout simplement pas lire trop de texte à l’écran.

Le TLDR (signifie « Trop long ; Didn’t Read") est un projet communautaire qui fournit une documentation concise et simplifiée pour diverses commandes Linux.

TLDR vise à offrir des exemples rapides et pratiques d’utilisation des commandes, ce qui permet aux utilisateurs de comprendre et d’utiliser plus facilement les commandes sans avoir à se plonger dans des manuels détaillés ou de longues explications.

TLDR est généralement accessible via la ligne de commande à l’aide de la commande « tldr », suivie du nom de la commande que vous souhaitez apprendre.

$ tldr ls

TLDR est un argot Internet, ce qui signifie qu’un message, un article, un commentaire ou quoi que ce soit comme une page de manuel était trop long, et celui qui a utilisé l’expression ne l’a pas lue pour cette raison. Le contenu des pages TLDR est librement disponible sous la licence permissive MIT.

Dans ce court article, nous allons montrer comment installer et utiliser les pages TLDR sous Linux.

Comment installer des pages TLDR dans les systèmes Linux

Pour accéder facilement aux pages TLDR, vous devez installer l’un des clients pris en charge appelé Node.js, qui est le client d’origine du projet tldr-pages.

Pour installer Node.js, vous pouvez utiliser le gestionnaire de paquets spécifique à votre distribution.

$ 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]    

Une fois Node.js et npm installés, vous pouvez procéder à l’installation de TLDR à l’aide de la commande npm comme indiqué.

$ sudo npm install -g tldr

TLDR est également disponible sous forme de package Snap, à installer et à exécuter.

$ sudo snap install tldr

Après avoir installé le client TLDR, vous pouvez afficher les pages de manuel de n’importe quelle commande, par exemple, la commande tar ici (vous pouvez utiliser n’importe quelle autre commande ici) :

$ tldr tar

Voici un autre exemple d’accès à la page de manuel résumée pour la commande ls.

$ tldr ls

Pour répertorier toutes les commandes de la plate-forme choisie dans le cache, utilisez l’indicateur -l.

$ tldr -l 

Pour répertorier toutes les commandes prises en charge dans le cache, utilisez l’indicateur -a.

$ tldr -a

Vous pouvez mettre à jour ou effacer le cache local en l’exécutant.

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

Pour rechercher des pages à l’aide de mots-clés, utilisez les options -s, par exemple.

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

Pour changer le thème de couleur (simple, base16, ocean), utilisez l’indicateur -t.

$ tldr -t ocean

Vous pouvez également afficher une commande aléatoire, avec l’indicateur -r.

$ tldr -r   

Vous pouvez voir une liste complète des options prises en charge en l’exécutant.

$ tldr -h

Vous pouvez trouver une liste de toutes les applications clientes prises en charge et dédiées pour différentes plates-formes, sur la page wiki des clients TLDR.

C’est tout pour l’instant ! Les pages TLDR sont des exemples pratiques résumés de commandes fournies par la communauté. Dans ce court article, nous avons montré comment installer et utiliser les pages TLDR sous Linux.

Utilisez le formulaire de commentaires pour partager vos réflexions sur TLDR ou partagez avec nous des programmes similaires.