Go to file
sabour_f 1e936f5388 make: add page 2016-01-04 12:59:09 +01:00
pages make: add page 2016-01-04 12:59:09 +01:00
scripts Remove lint-changed scipt, just make lint everything instead 2015-12-07 04:01:44 +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 Ignore .bundle folder 2015-12-23 15:52:44 +02:00
.travis.yml Optimize make lint task 2015-12-07 03:51:40 +02:00
CONTRIBUTING.md Improve Contributing Guidelines 2016-01-03 14:30:19 +02:00
Gemfile Travis CI integration: automatic linting, rebuilding index.json, building pages archive, and little other improvements 2015-12-04 16:54:05 +02:00
Gemfile.lock Update gems 2015-12-23 15:53:45 +02:00
LICENSE.md New README & CONTRIBUTING that apply to pages only 2014-03-04 23:39:34 +11:00
Makefile Add prerequisites task to Makefile which warns about installation of Ruby and bundler 2015-12-30 00:08:41 +02:00
README.md Add Rust client to README.md 2016-01-03 00:10:44 +07: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:

Let us know if you are building one and we can add it to this list!

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!