Partha Talukdar
By Partha Talukdar

TLDR community pages to simplify man commands in linux.

TLDR community pages to simplify man commands in linux.

man command vs tldr

man command in Linux is used to display the user manual of any command that we can run on the terminal. It provides a detailed view of the command which includes NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXIT STATUS, RETURN VALUES, ERRORS, FILES, VERSIONS, EXAMPLES, AUTHORS and SEE ALSO.

$man [OPTION]... [COMMAND NAME]...

This is the syntax of the man command. Upon entering ‘man tar’ (tar command is used for compressing or extracting from compressed files in linux) a whole list of long descriptive details appear. To avoid going through such long descriptions, we can make use of tldr pages which are a community effort to simplify the beloved man pages.

What does tldr do ?

*Basic execution: tldr

*Example: tldr ls, tldr tar, tldr ps etc.

  • tldr tar on executing tldr tar only the relevant commands related to tar and their short description appears as shown below:

OUTPUT:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51


[c]reate an archive and write it to a [f]ile:

tar cf    



[c]reate a g[z]ipped archive and write it to a [f]ile:

tar czf    



[c]reate a g[z]ipped archive from a directory using relative paths:

tar czf  --directory= .



E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely:

tar xvf 



E[x]tract a (compressed) archive [f]ile into the target directory:

tar xf  --directory=



[c]reate a compressed archive and write it to a [f]ile, using [a]rchive suffix to determine the compression program:

tar caf    



Lis[t] the contents of a tar [f]ile [v]erbosely:

tar tvf 



E[x]tract files matching a pattern from an archive [f]ile:

tar xf  --wildcards ""



How to install tldr on your linux systems?

One of the most mature clients of tldr is node.JS and hence npm can be used to install tldr, simply install nodejs on your system and execute the below command:

npm install -g tldr

tdlr