Pages de manuel trop complexes ? Essayez tldr pour apprendre les commandes Linux
Sommaire
Points clés à retenir
-
tldr simplifie l'aide aux commandes Linux avec des pages concises et accessibles et des exemples clés.
-
Installez tldr à l'aide de npm ou Homebrew, puis utilisez des commandes telles que « tldr grep » pour accéder rapidement à l'aide sur les commandes.
-
Le site Web tldr propose les mêmes pages détaillées que l'outil de ligne de commande, avec la saisie semi-automatique de recherche et des liens GitHub.
Les pages de manuel sont la source d'aide ultime sur les commandes Linux, mais elles sont très denses et pas du tout adaptées aux débutants. Entrez tldr, une commande qui facilite grandement l'utilisation de la ligne de commande.
Qu’est-ce que tldr et pourquoi est-il meilleur que l’homme ?
Tldr fonctionne comme man, le moyen par défaut d'obtenir de l'aide sur les commandes Linux. Son nom fait référence à l'initialisme Internet courant TL;DR, abréviation de « Too Long ; Didn't Read ». Au lieu des pages de manuel, la commande tldr affiche les pages tldr qui sont des alternatives beaucoup plus accessibles.
Chaque page tldr commence par le nom de la commande, une description en une phrase de ce qu'elle fait et une URL pour des informations plus détaillées, généralement une version de la page de manuel correspondante.
Voici la fonctionnalité la plus précieuse de tldr : une liste d'exemples. Bien que les pages de manuel contiennent des exemples, ils se trouvent généralement tout en bas ou dans un format d'utilisation qui n'est pas toujours facile à comprendre. Tldr élève les exemples et inclut juste le bon nombre : suffisamment pour couvrir les cas les plus importants, mais pas au point de devenir compliqué.
Prenez cd, par exemple, une commande que vous utilisez probablement plus que presque toutes les autres. Vous pensez peut-être tout savoir sur cet outil extrêmement simple, mais tldr pourrait vous aider à découvrir certaines utilisations cachées :
Le « répertoire personnel de l'utilisateur » et « précédemment choisi » sont des variantes très utiles dont vous ne connaissez peut-être pas l'existence.
Comment installer et utiliser tldr
Les pages tldr sont écrites en Markdown et, comme effet secondaire, il existe de nombreux programmes clients différents que vous pouvez utiliser pour les afficher. Un client console est le plus logique, puisque vous êtes probablement déjà sur la ligne de commande lorsque vous recherchez de l'aide.
Le client de console d'origine nécessite npm, le gestionnaire de packages de nœuds JavaScript. Si vous avez npm, vous pouvez l'utiliser pour installer tldr comme ceci :
npm install -g tldr
L'installation npm est l'itinéraire recommandé. Si vous n'avez pas npm et souhaitez installer d'une autre manière, vous pouvez utiliser Homebrew (« brew install tldr ») ou vous référer à la liste complète des clients sur la page GitHub de tldr.
Une fois installé, utilisez tldr et transmettez-lui le nom d'une commande, comme vous le feriez avec man, par exemple
tldr grep
Vous pouvez rechercher dans les pages tldr tout texte pouvant apparaître dans un exemple ou dans la description d'une commande. Utilisez simplement l'option « –search » comme ceci :
tldr --search "change permissions"
Si vous souhaitez voir combien de commandes tldr couvre pour votre plate-forme, vous pouvez utiliser l'option « –list ». Par défaut, toutes les commandes seront affichées sur une seule grande ligne séparée par des virgules. Ajoutez « -1 » pour en afficher un par ligne.
tldr --list
Vous pouvez même, sans surprise, utiliser tldr pour obtenir de l'aide sur lui-même :
tldr tldr
Vous verrez des exemples couvrant tous les cas, y compris des options d'aide spécifiques à une langue et des informations pour des plates-formes spécifiques.
Avec tldr installé, essayez d'ajouter « tldr –random » à votre .bashrc ou équivalent. L'option –random affiche des informations sur une commande aléatoire ; il y a aussi « –random-example » pour montrer un seul exemple d'utilisation. Désormais, chaque fois que vous ouvrez un nouveau terminal, il vous présentera une nouvelle commande.
Le site Web tldr est presque aussi bon
L'outil de ligne de commande fournit les pages tldr exactement là où vous le souhaitez : sur la ligne de commande. Mais le site officiel propose sa propre interface avec tous les mêmes détails, formatée pour votre navigateur.
Ce n'est peut-être pas toujours aussi pratique que la commande, mais le site Web inclut quelques touches intéressantes.
-
La recherche est entièrement automatique et met en évidence les commandes spécifiques à Linux ou Mac.
-
Chaque page renvoie à sa source correspondante sur GitHub. Si jamais vous avez envie de contribuer au projet, c’est un excellent point de départ. Vous pouvez même utiliser les outils intégrés de GitHub pour soumettre vos modifications directement sur le site, sans avoir à apprendre quoi que ce soit sur git.