TLDR pages
Simplified and community-driven man pages
The TLDR pages are a community effort to simplify the beloved man pages with practical examples.
Try the live demo below, have a look at the PDF version, or follow the installation instructions.
§ Installation
As of now, our most mature client is the node.js one, which you can easily install from NPM:
npm install -g tldr
You can also try any of the many other TLDR clients that have sprouted from the community:
| Client | Installation instructions |
|---|---|
| Web client | Visit https://tldr.ostera.io |
| Node.js client | npm install -g tldr |
| Ruby client | gem install tldrb |
| Haskell client | stack install tldr |
| Python client | pip install tldr.py |
| C++ client |
brew install tldr
|
| Android client | tldr-viewer on Google Play |
| iOS client | TLDR Man Page in App Store |
| Dash for OSX |
open Preferences > Downloads > User Contributed and find tldr pages in the list
|
| Bash client | bpkg install pepa65/tldr |
There are more clients listed in the TLDR clients wiki page.
§ Contributing
This repository is an ever-growing collection of examples for the most common UNIX, Linux, OSX, SunOS and Windows commands.
You're encouraged to create or edit pages
in the pages/ folder
at the project's repository
and submit a pull request.
Just keep in mind the Contributing guidelines.