Man vs TLDR : avantages de la commande TLDR et conseils d’utilisation pratiques

Pour clarifier les choses, cet article aborde les commandes manet tldrdans l’environnement Linux. Bien que les pages de manuel soient complètes, elles peuvent sembler écrasantes pour les nouveaux arrivants. Alternativement, la commande tldr offre des résumés concis et faciles à suivre des commandes Linux.

Ce guide explorera ce que tldrc’est, comment l’utiliser et pourquoi cela peut être une option plus conviviale par rapport à la mancommande classique.

Comprendre le commandement de l’homme

La mancommande, abréviation de manual, sert de méthode standard pour accéder à la documentation des commandes dans les systèmes de type Unix. L’exécution mansuivie d’un nom de commande récupère la page de manuel associée à cette commande, fournissant des informations détaillées sur ses fonctions, ses options et ses exemples.

Par exemple, entrer la commande suivante donne un aperçu complet de la lscommande :

Cette action ouvre une longue page de manuel affichant toutes les options disponibles, organisées en plusieurs sections telles que NAME , SYNOPSIS , DESCRIPTION , OPTIONS et EXAMPLES . Bien que cette structure facilite la navigation, le contenu extensif peut être décourageant.

Bien que la mancommande fournisse des informations précieuses pour les utilisateurs expérimentés, elle peut être écrasante pour les débutants et même certains utilisateurs intermédiaires en raison du volume d’informations présentées.

Qu’est-ce que Tldr exactement ?

tldr, qui signifie « trop long ; je n’ai pas lu », est une expression familière utilisée sur Internet pour résumer de longs textes. Contrairement aux pages de manuel traditionnelles, les pages tldr mettent l’accent sur les options les plus pratiques, complétées par des exemples simples et concrets.

Par exemple, lors de l’exécution tldrde suivi de lsdans votre terminal, la commande tldr présente un bref résumé de la lscommande, y compris ses options les plus fréquemment utilisées :

Comme illustré, les pages tldr sont concises et ciblées, ce qui permet aux nouveaux utilisateurs de comprendre et d’utiliser efficacement les commandes plus facilement.

Premiers pas avec Tldr

Pour accéder facilement aux pages tldr, vous devez installer un client compatible. Le client principal pour tldr est Node.js, qui est le client d’origine de l’initiative tldr. Pour des options client supplémentaires sur différentes plateformes, consultez la page wiki des clients TLDR .

Node.js peut être installé via le gestionnaire de paquets adapté à votre distribution Linux. Par exemple, sur des systèmes basés sur Debian comme Linux Mint ou Ubuntu, utilisez la commande suivante :

Une fois Node.js et son gestionnaire de paquets npm installés, vous pouvez configurer globalement le client tldr à l’aide de cette commande :

Si vous préférez un package Snap, vous pouvez installer tldr en exécutant :

Après l’installation, le client tldr vous permet d’afficher des pages de manuel de ligne de commande simplifiées et faciles à comprendre. Par exemple, pour accéder à un bref aperçu de la tarcommande, tapez simplement :

Vous pouvez également rechercher des commandes en utilisant l’ --searchoption avec des mots-clés :

De plus, la liste de toutes les commandes disponibles peut être effectuée avec l’ -loption :

En entrant simplement tldrdans votre terminal, vous pouvez explorer toutes les options disponibles pour la commande tldr :

Si une option basée sur le Web vous convient mieux, le site Web officiel du tldr propose un contenu similaire formaté pour la navigation. Il comprend des fonctionnalités telles qu’une barre de recherche avec des suggestions automatiques ainsi que des libellés indiquant si les commandes sont spécifiques à Linux ou à macOS.

De plus, chaque page d’aide renvoie à sa source sur GitHub, où vous pouvez proposer des modifications ou des améliorations à l’aide des outils intégrés de GitHub. Aucune connaissance approfondie de Git n’est requise.

Les avantages de Tldr par rapport à Man

Les pages TLDR sont conçues pour une lecture et une compréhension simples. Elles éliminent les complexités inutiles et se concentrent uniquement sur les informations essentielles nécessaires pour utiliser efficacement une commande.

Contrairement aux pages de manuel, qui abordent souvent toutes les options et tous les détails imaginables, les pages tldr mettent en évidence des cas d’utilisation pratiques. Ces exemples pratiques montrent comment implémenter des commandes dans des contextes réels, facilitant ainsi la compréhension des concepts présentés.

Tldr est également indépendant de la plate-forme, compatible avec Windows, macOS et Linux, améliorant ainsi son utilité dans divers environnements.

Conclusion

Que vous soyez un novice désireux de commencer ou un expert à la recherche d’un récapitulatif rapide, tldr est une ressource précieuse à ajouter à votre boîte à outils.

Néanmoins, gardez à l’esprit que la commande tldr ne doit pas remplacer complètement les pages de manuel. Pour une compréhension complète et technique, les pages de manuel traditionnelles continuent de servir de documents de référence essentiels.

Crédit image : Unsplash . Toutes les modifications et captures d’écran par Haroon Javed.