neurolit/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:

Note: sorry for now there are no Linux entries. Please come contribute over here if you have ideas how we can handle multiple platforms efficiently!

Installing

$ npm install -g tldr

Contributing

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

Just open an issue or send a pull request, it's all Markdown stored right here on Github.

The rough guidelines are:

• each command's description should short and sweet
• give around 5 examples of the most common usages
• when in doubt, keep new command-line users in mind

Dev notes

• To run the tests:

npm test

• To try out new fetching/rendering logic locally

npm start
npm run example