TLDR pages
source link: https://tldr.sh/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
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 |
| Perl client | cpanm App::tldr |
| Python client | pip install tldr / pacman -S tldr |
| C client | brew install tldr |
| Rust client | cargo install tealdeer / yay -S tealdeer |
| iOS client | TLDR Man Page on App Store |
| Dash for macOS |
open Preferences > Downloads > User Contributed and find tldr pages in the list
|
| Bash client | bpkg install pepa65/tldr |
| Go client | go get -u github.com/isacikgoz/tldr |
| Terminal-format-only POSIX shell script | git clone https://github.com/avih/tldr-fmt |
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, macOS, 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.
§ License
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK