tldr is a community driven, open source project that aims to deliver a concise version of man pages for commonly used Unix and Linux commands.
How it Works
You view the documentation with the following command syntax:
Here is an example of the
tldr documentation for the
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
tldr requires a local install of Node.js.
tldr is installed with npm:
This command may need to be run with superuser privileges on your box.
The project already includes many Unix (including Mac OSX specific) and Linux commands. If you’d like to extend the current documentation or add additional pages, you can do so by forking the GitHub repository, creating the documentation in Markdown, and submitting a pull request back to the main repository.
Here is the GitHub Guide documentation on forks and pull requests for those who are unfamiliar (it’s simple).
tldr was spotted on The Changelog.