A collection of simplified and community-driven man pages.
Install it with npm install -g tldr
or try the web client.
New to the command-line world? Or just a little rusty?
Or perhaps you can't always remember the arguments to lsof
, or tar
?
Maybe it doesn't help that the first option explained in man tar
is:
-b blocksize
Specify the block size, in 512-byte records, for tape drive I/O.
As a rule, this argument is only needed when reading from or writing to tape drives,
and usually not even then as the default block size of 20 records (10240 bytes) is very common.
Surely people could benefit from simplified man pages focused on practical examples. How about:
This repository is just that: an ever-growing collection of examples for the most common UNIX, Linux, macOS, SunOS and Windows commands.
You can access these pages on your computer using one of the following clients:
brew install tldr
brew install porras/tap/tlcr
pub global activate tldr
Preferences
> Downloads
> User Contributed
and find tldr pages
in the listtldr
command via a docker container: alias tldr='docker run --rm -it -v ~/.tldr/:/root/.tldr/ nutellinoit/tldr'
go get github.com/pranavraja/tldr
(or platform binaries)go get 4d63.com/tldr
or brew install 4d63/tldr/tldr
(or platform binaries)go get github.com/elecprog/tldr
(or platform binaries)go get github.com/isacikgoz/tldr
(or platform binaries)stack install tldr
or apt-get install tldr
on Debian-based distributionsnpm install -g tldr
opam install tldr
cpanm App::tldr
composer global require brainmaestro/tldr
pip install tldr
or pacman -S tldr
on Arch Linuxpip install tldr.py
or apt-get install tldr-py
on Debian-based distributionsdevtools::install_github('kirillseva/tldrrr')
gem install tldrb
cargo install tealdeer
There is also a comprehensive list of clients in our Wiki.
Contributions are most welcome! We strive to maintain a welcoming and collaborative community. Have a look at the contributing guidelines, and go ahead!
Cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.
Bro pages are a highly readable supplement to man pages. Bro pages show concise, common-case examples for Unix commands. The examples are submitted by the user base, and can be voted up or down; the best entries are what people see first when they look up a command.
eg
provides detailed examples with explanations on the command line.
Examples come from the repository, but eg
supports displaying
custom examples and commands alongside the defaults.
TL;DR stands for "Too Long; Didn't Read". It originates in Internet slang, where it is used to indicate that a long text (or parts of it) has been skipped as too lengthy. Read more in Wikipedia's TL;DR article.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。