21cb9ac9e1
By having an index for the pages, it'd allow clients to build autocomplete's and show an index of pages making only one request (think `tldr list`). Subsequent caching of this file would prevent further requests. Included is a makefile to easily rebuild the index. It could be tailored in case the pages structure changed. In a particular case, the web client would benefit greatly from an index. It'd know exactly what folder a command is in and thus the number of requests would drop from 4 to 1. |
||
|---|---|---|
| pages | ||
| .editorconfig | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| LICENSE.md | ||
| Makefile | ||
| README.md | ||
| screenshot.png | ||
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:
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:
- Node.js client :
npm install -g tldr - Python client :
pip install tldr - Go client :
go get github.com/pranavraja/tldror platform binaries - Exilir client: binaries available soon
- C++ client:
brew tap tldr-pages/tldr && brew install tldr - Android client: available on Google Play – Web client: try tldr on your browser here!
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?
Contribution are most welcome! Have a look over here for some rough guidelines.