Juicy lil' bytes

TLDR | Community-Driven Concise Linux and Unix Man Pages

tldr is a community driven, open source project that aims to deliver a concise version of man pages for commonly used Unix and Linux commands.

How it Works

You view the documentation with the following command syntax:

1
tldr <command>

Here is an example of the tldr documentation for the tar executable:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
$ tldr tar

 Archiving utility
 Optional compression with gzip / bzip

 - create an archive from files

   tar cf target.tar file1 file2 file3

 - create a gzipped archive

   tar cfz target.tar.gz file1 file2 file3

 - extract an archive in a target folder

   tar xf source.tar -C folder

 - extract a gzipped archive in the current directory

   tar xzf source.tar.gz

Install

tldr requires a local install of Node.js.

tldr is installed with npm:

1
npm install -g tldr

This command may need to be run with superuser privileges on your box.

Contribute

The project already includes many Unix (including Mac OSX specific) and Linux commands. If you’d like to extend the current documentation or add additional pages, you can do so by forking the GitHub repository, creating the documentation in Markdown, and submitting a pull request back to the main repository.

Here is the GitHub Guide documentation on forks and pull requests for those who are unfamiliar (it’s simple).

Source

tldr was spotted on The Changelog.