[~] BACK

~~ TLDR ~~

** MANPAGES ARE DEAD **

[PRO] | [20221021] | [0] | [0x17]

Sandra Parsick gave a talk called "Per Shell durch die Techie-Galaxy" (here are the sheets: LINK) and there is a tool listed that I had almost forgotten about but think is pretty good. It's about tldr. Man pages are essential when using new tools. However, said man pages are also very extensive. There are certainly people who like to read through the whole thing, but I don't have the desire or the time to do so. This is where tldr comes into play.



tldr basically does nothing different than man, but instead of outputting the full content of the man page, there is a (hugely) condensed version with the most important parameters that are needed to easily use the respective tool. So if you need to quickly see how scp works, you can do that with tldr. But first, let's talk about installation.

Installation

tldr can be found in the nix packages and can be easily integrated into configuration.nix:

configuration.nix

Then of course rebuild and tldr is ready to use.

HOW

tldr is (yes, you know) a terminal tool. So tldr can be started with the command of the same name. So that the terminal doesn't just display information about tldr, we also give tldr the tool we want information about. Let's use a completely random tool, such as... ummm... Vim. It looks like this:

TERMINAL




With this command, tldr shows you the most important commands for Vim. A nice little tool that makes everyday life easier and saves time.

If you are missing a tldr-page then you can push it here:
tldr pages (Github)

Have fun with it.