emanuell / tldr

Simplified and community-driven man pages

What is this?

New to the command-line world? Or just a little rusty? Or, like me, 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.

I'm sure people could benefit from simplified "show me the common usages" man pages. What about:

Installing

$ npm install -g tldr

Note: TLDR is still in early versions. We try to minimise breaking changes, but if you run into issues please try to download the latest package again.

Contributing

• Your favourite command isn't covered?
• You can think of more examples?
• New features?

Contribution are most welcome! Have a look over here for a few rough guidelines.