Last Updated on 2024-09-28 by Clay
man is the traditional documentation tool for UNIX/Linux systems, but the detailed nature of its output can be overwhelming for users who just want a quick reference on how to use a command. Therefore, a simplified version called tldr was created (short for "too long, didn't read"). It focuses on providing concise, easy-to-understand command documentation.
Installation
For most Linux distributions, you can install it using the built-in package manager:
sudo apt install tldr # Ubuntu/Debian
sudo pacman -S tldr # Arch
brew install tldr # macOS
Or
tldr lsHow to Use
After installation, it's a good idea to check the version number to make sure it's properly installed.
tldr --version
Output:
0.6.4
Next, it's best to update the local cache to avoid running into issues where no documentation is available for commands.
tldr --updateAfter that, you can read the documentation for various common commands!
tldr watch
Output:
This way, you can quickly read command descriptions in a more concise format anytime you need it. Awesome!