dc9547925f
For completeness: the -0 option is actually used to specify the input record separator (as an octal number). Without it, the record separator is the newline character, i.e. the files are processed line by line (which doesn't allow find-replace expressions that include newlines to work). According to the [documentation](http://perldoc.perl.org/perlrun.html#Command-Switches), using plain `-0` is not guaranteed to have the effect of parsing the entire file, because if the file does contain characters with octal value equal to the parameter passed to (or implied by) the -0 option, these characters will be treated as line breaks. However, if the value exceeds 377<sub>8</sub> (i.e. 255), it won't be matched to characters on the file. 777 is the preferred convention within that exceptional range, as the highest value that keeps to 3 octal digits. Here we're forgoing such details and using -0 anyway, since for most cases this will be enough. |
||
|---|---|---|
| .github | ||
| pages | ||
| scripts | ||
| .editorconfig | ||
| .gitignore | ||
| .markdownlintrc | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| LICENSE.md | ||
| MAINTAINERS | ||
| package.json | ||
| README.md | ||
| screenshot.png | ||
tldr
A collection of simplified and community-driven man pages.
Install it with sudo npm install -g tldr
or try the web client.
What is tldr?
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 / OSX / SunOS commands.
Clients
You can access these pages on your computer using one of the following clients:
- Alfred Workflow
- Android clients:
- tldr-viewer, available on Google Play
- tldroid, available on Google Play
- Bash clients:
- C++ client:
brew install tldr - Crystal client:
brew install porras/tap/tlcr - Dart client:
pub global activate tldr - Elixir client (binaries not yet available)
- Emacs client, available on MELPA
- Go client:
go get github.com/pranavraja/tldr(or platform binaries) - iOS clients:
- tldr-man-page, available on App Store
- tldr-pages, available on App Store
- Haskell client :
stack install tldr - Node.js client :
npm install -g tldr - Perl5 client:
cpanm App::tldr - Python clients:
- tldr-python-client :
pip install tldr - tldr.py:
pip install tldr.py
- tldr-python-client :
- R client:
devtools::install_github('kirillseva/tldrrr') - Ruby client:
gem install tldrb - Rust clients:
- Web clients:
There is also a comprehensive list of clients in our Wiki.
Contributing
- Your favourite command isn't covered?
- You can think of more examples for an existing command?
Contributions are most welcome! Have a look at the contributing guidelines and go ahead!
Similar projects
-
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.
What does "tldr" mean?
TL;DR stands for "Too Long; Didn't Read". It originates in Internet slang, where it is used to indicate parts of the text skipped as too lengthy. Read more in the TLDR article on Wikipedia.