Go to file
Leandro Ostera 4f8751d7ad Fixes trailing whitespace 2016-02-06 12:09:16 +01:00
pages Fixes trailing whitespace 2016-02-06 12:09:16 +01:00
scripts Fix #717. Update index.json format 2016-01-24 10:54:27 +02:00
.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 Use NodeJS NPM package markdownlint instead of Ruby gem mdl 2016-01-19 22:28:54 +02:00
.markdownlintrc Use NodeJS NPM package markdownlint instead of Ruby gem mdl 2016-01-19 22:28:54 +02:00
.travis.yml Use NodeJS NPM package markdownlint instead of Ruby gem mdl 2016-01-19 22:28:54 +02:00
CONTRIBUTING.md Fix Contributing Guidelines: remove make mentions, add npm mentions 2016-01-29 15:50:48 +02:00
LICENSE.md New README & CONTRIBUTING that apply to pages only 2014-03-04 23:39:34 +11:00
README.md Merge pull request #679 from igorshubovych/more-clients 2016-02-03 16:28:18 +01:00
package.json Use NodeJS NPM package markdownlint instead of Ruby gem mdl 2016-01-19 22:28:54 +02:00
screenshot.png New README & CONTRIBUTING that apply to pages only 2014-03-04 23:39:34 +11:00

README.md

tldr

[![Build Status][travis-image]][travis-url] [![Gitter chat][gitter-image]][gitter-url] [travis-url]: https://travis-ci.org/tldr-pages/tldr [travis-image]: https://img.shields.io/travis/tldr-pages/tldr.svg [gitter-url]: https://gitter.im/tldr-pages/tldr [gitter-image]: https://img.shields.io/gitter/room/tldr-pages/tldr.svg

tldr is a collection of simplified and community-driven man pages.

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.

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 "show me the common usages" man pages. What about:

tldr screenshot

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:

There is also a comprehensive list of clients in 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.