1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2024-10-31 12:17:58 +01:00
📚 Collaborative cheatsheets for console commands
Find a file
Leandro Ostera 2ba4397edc Updates vim and vimtutor pages (#926)
* Updates vim and vimtutor pages

* Easy peasy.

* Use <Enter> instead of <Cr>

* Show help command.

We might not be able to help you move around
but the interactive help provided by vim is
pretty good, so helping people find it might
be a good idea.

* Reorder commands and lowercase help
2016-08-21 16:00:09 +02:00
pages Updates vim and vimtutor pages (#926) 2016-08-21 16:00:09 +02:00
scripts Added code to export to PDF (#861) 2016-05-09 14:16:43 +01: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 clarify .gitignore comments 2016-06-24 13:58:58 +01: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 CONTRIBUTING.md: Add token conventions (#981) 2016-08-12 09:45:35 +02:00
LICENSE.md New README & CONTRIBUTING that apply to pages only 2014-03-04 23:39:34 +11:00
package.json Simplify markdownlint check 2016-03-03 13:10:43 +02:00
README.md Updating screenshot (#957) 2016-07-16 09:12:59 +01:00
screenshot.png Updating screenshot (#957) 2016-07-16 09:12:59 +01:00

tldr

Build Status Gitter chat Issue Stats

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