Go to file
Waldir Pimenta b7926ee5db firefox: improve example descriptions (#3276)
Also fix the main description to conform to the style guide.
2019-09-21 22:39:37 +02:00
.github style-guide and PR template: add web link guidelines to checklists (#3030) 2019-05-18 17:43:29 +02:00
contributing-guides style guide: update wording of the page link (#3060) 2019-05-30 22:07:00 +02:00
pages firefox: improve example descriptions (#3276) 2019-09-21 22:39:37 +02:00
pages.fr/common awk: add french translation (#3186) 2019-07-16 02:24:02 +02:00
pages.it/common bitcoin-cli: add Italian translation. 2019-07-21 01:59:28 +02:00
pages.pt_BR BCP47 to POSIX: rename Brazilian Portuguese folder. 2019-08-26 09:53:30 +05:30
pages.ta/common cp,ls,mkdir,mv,rm,rmdir: add translations [Tamil] (#2512) 2018-11-05 22:46:16 +00:00
pages.zh wget: finish remaining Chinese translation 2019-08-26 01:09:41 +01:00
scripts Travis: separate building from deployment. 2019-07-11 17:01:05 +05:30
.editorconfig Travis CI integration: automatic linting, rebuilding index.json, building pages archive, and little other improvements 2015-12-04 16:54:05 +02:00
.gitignore Update macOS references 2017-07-28 21:13:30 +05:30
.markdownlintrc markdownlint: increase maximum line length to 250 2019-05-07 10:08:35 +02:00
.travis.yml Travis: separate building from deployment. 2019-07-11 17:01:05 +05:30
CLIENT-SPECIFICATION.md Client spec: clarify preferred page resolution method. 2019-08-23 17:49:44 +01:00
COMMUNITY-ROLES.md COMMUNITY-ROLES: fix usage of angle brackets (#2911) 2019-04-15 13:07:25 +01:00
CONTRIBUTING.md CONTRIBUTING: remove mention of BCP47 (#3255) 2019-08-26 09:43:23 +01:00
GOVERNANCE.md GOVERNANCE.md: link to the maintainer's guide 2018-11-27 17:34:47 +05:30
LICENSE.md unwrap copyright notice 2017-03-18 09:13:03 +00:00
MAINTAINERS.md Mark @andrik & @Aracki as current collaborators (#3053) 2019-05-26 02:59:02 +02:00
README.md README: add Vim client (#3191) 2019-07-13 07:03:25 +01:00
package.json package.json: lint all pages with markdownlint 2019-05-07 10:08:35 +02:00
screenshot.png Optimize screenshot size (#2866) 2019-04-29 22:44:01 +02:00

README.md

tldr

Build status Gitter chat Merged PRs Issue stats GitHub contributors license

A collection of simplified and community-driven man pages.

Install it with 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:

tldr screenshot

This repository is just that: an ever-growing collection of examples for the most common UNIX / Linux / macOS / SunOS commands.

Clients

You can access these pages on your computer using one of the following 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! We strive to maintain a welcoming and collaborative community. 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.

  • 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.

What does "tldr" mean?

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.