TLDR: man, abbreviated.

TLDR

Do you find the man pages boring to read? Do you <Shift-g> to the end hunting for some real usage examples? Probably many Linux users do the same. Sometimes it makes sense, when you don’t need to re-understand the wheel. That’s why you should try the TLDR pages.

TLDR pages is a very useful and growing project that works as an alternative to the man pages with straightforward examples on how to use a command. You read it right, one-liner about the command and lots of useful examples.

TLDR pages is on GitHub. If you don’t find a command or example usage that you think could help others, you can submit a patch right away!

Note that TLDR pages are available only for commands, not for libc functions or similar projects. The commands are divided into 4 broad sections: common, Linux, Mac and Windows.

Installation

TLDR has a web client.

If you want to install a local client that runs from the cmdline, there are many alternatives. For Ubuntu we picked the following:

  1. bash client
    $ sudo curl -o /usr/local/bin/tldr https://raw.githubusercontent.com/raylee/tldr/master/tldr
    $ sudo chmod +x /usr/local/bin/tldr
  2. python client
    $ sudo pip install tldr.py

By default the pages are fetched from the web. So you just need to install any of the clients.

Usage

To fetch the TLDR page for ls, run:

$ tldr ls

You can check the help section of the client commands for more options like list all pages, output color, rebuild index, fetch from git master branch etc.

Rating

Features: 4.5/5
Usability: 5/5

Webpage: TLDR pages

Leave a Reply

Your email address will not be published. Required fields are marked *