Go to file
Waldir Pimenta 54aa2b7520 COMMUNITY-ROLES: add links; clarify last section (#2508) 2018-10-28 17:02:02 +00:00
.github PULL_REQUEST_TEMPLATE: fix punctuation 2018-01-09 22:53:43 +00:00
contributing-guides style-guide.md: add tip to view file locally (#1928) 2018-01-30 11:45:22 +05:30
pages dot: Aid consistency (#2493) 2018-10-28 16:57:08 +00:00
scripts scripts: fix a typo (#2404) 2018-10-07 17:17:30 +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 Use NodeJS NPM package markdownlint instead of Ruby gem mdl 2016-01-19 22:28:54 +02:00
.travis.yml add documentation about Travis token (#1902) 2018-01-18 16:08:23 +00:00
COMMUNITY-ROLES.md COMMUNITY-ROLES: add links; clarify last section (#2508) 2018-10-28 17:02:02 +00:00
CONTRIBUTING.md link to GOVERNANCE.md from README.md and CONTRIBUTING.md 2017-12-27 23:33:55 +00:00
GOVERNANCE.md GOVERNANCE: number principles to allow x-refs (#2350) 2018-09-24 11:15:15 +01:00
LICENSE.md unwrap copyright notice 2017-03-18 09:13:03 +00:00
MAINTAINERS.md MAINTAINERS.md: clarify; use semantic linebreaks (#2402) 2018-10-06 17:57:34 +05:30
README.md Added Docker images section (#2300) 2018-09-06 15:23:45 +01:00
package.json Using tldr bot on a separate server 2017-05-09 17:24:31 +05:30
screenshot.png Updating screenshot (#957) 2016-07-16 09:12:59 +01:00

README.md

tldr

Build status Gitter chat Merged PRs Issue stats GitHub contributors Number of files 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.