tldr

Qu'est-ce que les pages tldr ?

Le projet tldr-pages est une collection de pages d'aide gérées par la communauté pour les outils de ligne de commande, qui vise à être un complément plus simple et plus accessible aux pages de manuel traditionnelles.

Peut-être êtes-vous nouveau dans le monde de la ligne de commande. Peut-être êtes-vous juste un peu rouillé ou ne vous souvenez-vous pas toujours des arguments de commandes comme lsof ou tar ?

Cela n'aide certainement pas que, dans le passé, la première option expliquée dans man tar était :

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

Il existe de la place pour des pages d'aide plus simples axées sur des exemples pratiques. Que diriez-vous de :

Ce référentiel n'est que cela : une collection toujours croissante d'exemples pour les outils de ligne de commande UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD, SunOS, Android et Windows les plus courants.

Comment puis-je l'utiliser ?

Conseil

Pour naviguer sans installer de client sur votre ordinateur, consultez le client Web sur https://tldr.inbrowser.app (avec prise en charge hors ligne via PWA).

Un moyen populaire et pratique d'accéder à ces pages sur votre ordinateur consiste à installer le client Node.js officiel :

npm install -g tldr

Alternativement, vous pouvez également utiliser le client Python officiel, qui peut être installé via pip3 (ou d'autres gestionnaires de packages) :

pip3 install tldr

Les utilisateurs Linux et Mac peuvent également installer le client Rust officiel à l'aide de Homebrew (ou d'autres gestionnaires de packages sur d'autres systèmes d'exploitation) :

brew install tlrc

Vous avez ensuite un accès direct à une aide simplifiée et facile à lire pour les commandes, telles que tar , accessible en tapant tldr tar au lieu du man tar standard.

Si vous ne souhaitez installer aucun logiciel, consultez plutôt la version PDF.

Note

Des fichiers PDF pour les traductions sont disponibles pour la plupart des langues. Vous pouvez les trouver dans les ressources de la dernière version.

Il existe également divers autres clients fournis par la communauté, à la fois pour la ligne de commande et pour d'autres plates-formes. Pour une liste complète des clients, rendez-vous sur notre Wiki.

Comment puis-je contribuer aux pages tldr ?

Toutes les contributions sont les bienvenues !

Voici quelques façons de contribuer :

• Ajout de votre commande préférée qui n'est pas couverte.
• Ajouter des exemples ou améliorer le contenu d'une page existante.
• Ajout des pages demandées à partir de nos problèmes avec l'étiquette d'aide recherchée.
• Traduire des pages dans différentes langues.

Toutes les pages tldr sont écrites en Markdown afin qu'elles puissent être modifiées assez facilement et les modifications peuvent être soumises dans des demandes d'extraction ici en utilisant Git sur la ligne de commande ou en utilisant l'interface Web GitHub.

Nous nous efforçons de maintenir une communauté accueillante et collaborative. Si c'est la première fois que vous contribuez, jetez un œil aux directives de contribution et allez-y !

Si vous souhaitez contribuer aux traductions, vous pouvez visiter https://lukwebsforge.github.io/tldri18n/ pour voir la progression globale de toutes les traductions et quelles traductions sont manquantes ou obsolètes.

Vous êtes également invités à nous rejoindre sur le chatroom matriciel !

Projets similaires

• Les pages d'interface de ligne de commande vous permettent d'écrire des pages d'aide standardisées pour la CLI, les répertoires et les configurations.

• Cheat vous permet de créer et d'afficher des aide-mémoire interactifs sur la ligne de commande. Il a été conçu pour rappeler aux administrateurs système Unix les options des commandes qu'ils utilisent fréquemment, mais pas assez souvent pour les mémoriser.

• cheat.sh Regroupe les aide-mémoire de plusieurs sources (y compris les pages tldr) dans une interface unifiée.

• devhints Les aide-mémoire de Rico ne se concentrent pas uniquement sur la ligne de commande et incluent une pléthore d'autres aide-mémoire liés à la programmation.

• par exemple, fournit des exemples détaillés avec des explications sur la ligne de commande. Les exemples proviennent du référentiel, mais prennent eg en charge l'affichage d'exemples et de commandes personnalisés à côté des valeurs par défaut.

• kb est un gestionnaire de base de connaissances minimaliste en ligne de commande. kb peut être utilisé pour organiser vos notes et aide-mémoire de manière minimaliste et propre. Il prend également en charge les fichiers non texte.

• navi est un outil de aide-mémoire interactif qui vous permet de parcourir des exemples spécifiques ou de compléter des commandes à la volée.

• les bropages (obsolètes) sont un supplément très lisible aux pages de manuel. Il montre des exemples concis et courants de commandes Unix. Les exemples sont soumis par la base d'utilisateurs et peuvent être votés pour ou contre ; les meilleures entrées sont celles que les gens voient en premier lorsqu'ils recherchent une commande.

Que signifie « tldr » ?

TL;DR signifie « Trop long ; je n'ai pas lu ». Il est originaire d'un argot Internet, où il est utilisé pour indiquer qu'un long texte (ou des parties de celui-ci) a été ignoré car trop long. Pour en savoir plus, consultez l'article de How-To Geek.