Remplacer les pages de manuel par Tealdeer sous Linux

Les pages de manuel étaient ma ressource de prédilection lorsque j’ai commencé à explorer Linux. Certainement, man est la commande la plus fréquemment utilisée lorsqu’un débutant commence à se familiariser avec le monde de la ligne de commande. Mais les pages de manuel, avec leurs listes étendues d’options et d’arguments, peuvent être difficiles à déchiffrer, ce qui rend difficile la compréhension de tout ce que vous vouliez savoir. Si vous voulez une solution plus simple avec une sortie basée sur des exemples, je pense tldr est la meilleure option.

Qu’est-ce que Tealdeer ?

Tealdeer est une merveilleuse implémentation de tldr dans Rust. Il s’agit d’une page de manuel communautaire qui donne des exemples très simples du fonctionnement des commandes. La meilleure partie de Tealdeer est qu’il a pratiquement toutes les commandes que vous utiliseriez normalement.

Installer Tealdeer

Sous Linux, vous pouvez installer Tealdeer à partir de votre référentiel de logiciels. Par exemple, sur Feutre:

$ sudo dnf install tealdeer

Sur macOS, utilisez MacPorts ou Homebrew.

Alternativement, vous pouvez créer et installer l’outil avec le gestionnaire de packages Cargo de Rust :

$ cargo install tealdeer

Utiliser Tealdeer

Saisie tldr --list renvoie la liste des pages de manuel prises en charge par tldr, comme touch, tar, dnf, docker, zcat, zgrep, etc:

$ tldr --list
2to3
7z
7za
7zr
[
a2disconf
a2dismod
a2dissite
a2enconf
a2enmod
a2ensite
a2query
[...]

Utilisant tldr avec une commande spécifique (comme tar) affiche des pages de manuel basées sur des exemples qui décrivent toutes les options que vous pouvez faire avec cette commande :

$ tldr tar
  Archiving utility.
  Often combined with a compression method, such as gzip or bzip2.
  More information: <https://www.gnu.org/software/tar>.
  [c]reate an archive and write it to a [f]ile:
      tar cf target.tar file1 file2 file3
  [c]reate a g[z]ipped archive and write it to a [f]ile:
      tar czf target.tar.gz file1 file2 file3
  [c]reate a g[z]ipped archive from a directory using relative paths:
      tar czf target.tar.gz --directory=path/to/directory .
  E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely:
      tar xvf source.tar[.gz|.bz2|.xz]
  E[x]tract a (compressed) archive [f]ile into the target directory:
      tar xf source.tar[.gz|.bz2|.xz] --directory=directory
  [c]reate a compressed archive and write it to a [f]ile, using [a]rchive suffix to determine the compression program:
      tar caf target.tar.xz file1 file2 file3

Pour contrôler le cache :

    $ tldr --update
    $ tldr --clear-cache

Vous pouvez donner de la couleur à la sortie de Tealdeer avec le --color option, en la définissant sur always, auto, et never. La valeur par défaut est auto, mais j’aime la couleur de contexte ajoutée fournie, donc je rends le mien permanent avec cet ajout à mon ~/.bashrc déposer:

alias tldr='tldr --color always'

Conclusion

La beauté de Tealdeer est que vous n’avez pas besoin d’une connexion réseau pour l’utiliser, sauf lorsque vous mettez à jour le cache. Ainsi, même si vous êtes hors ligne, vous pouvez toujours rechercher et découvrir votre nouvelle commande préférée. Pour plus d’informations, consultez l’outil Documentation.

Utiliseriez-vous Tealdeer ? Ou l’utilisez-vous déjà ? Faites-nous savoir ce que vous pensez dans les commentaires ci-dessous.