Tutorial News Comments FAQ Related Articles

How to install TLDR - An alternate to Man pages

{{postValue.id}}

To install TLDR Pages &ndash An alternate to Linux man pages

TLDR pages is the pile of simplified and community driven man pages. It provides a result of a command with a light practical examples. Installation of TLDR is explained in this manual.


To Install the dependencies

Run the following command to install the epel repository

[root@linuxhelp1 ~]# yum install epel-release -y
Loaded plugins: fastestmirror, langpacks
Loading mirror speeds from cached hostfile
 * base: centos.excellmedia.net
 * extras: centos.excellmedia.net
 * updates: centos.excellmedia.net
Resolving Dependencies
-->  Running transaction check
--->  Package epel-release.noarch 0:7-6 will be installed
-->  Finished Dependency Resolution
.
.
.
Installed:
  epel-release.noarch 0:7-6                                                                                                            

Complete!

Now install the nodejs and npm package by using the following command.

[root@linuxhelp1 ~]# yum install nodejs npm -y
Loaded plugins: fastestmirror, langpacks
Loading mirror speeds from cached hostfile
 * base: centos.excellmedia.net
 * epel: epel.mirror.net.in
 * extras: centos.excellmedia.net
 * updates: centos.excellmedia.net
Resolving Dependencies
-->  Running transaction check
--->  Package nodejs.x86_64 0:0.10.42-4.el7 will be installed
-->  Processing Dependency: libuv.so.0.10()(64bit) for package: nodejs-0.10.42-4.el7.x86_64
--->  Package npm.noarch 0:1.3.6-5.el7 will be installed
-->  Processing Dependency: npm(npmlog) = 0.0.4 for package: npm-1.3.6-5.el7.noarch
-->  Processing Dependency: npm(npm-user-validate) = 0.0.3 for package: npm-1.3.6-5.el7.noarch
.
.
.
                      
  nodejs-oauth-sign.noarch 0:0.3.0-1.el7                               nodejs-once.noarch 0:1.1.1-5.el7                               
  nodejs-opener.noarch 0:1.3.0-7.el7                                   nodejs-osenv.noarch 0:0.0.3-5.el7                              
  nodejs-packaging.noarch 0:7-1.el7                                    nodejs-promzard.noarch 0:0.2.0-6.el7                           
  nodejs-proto-list.noarch 0:1.2.2-5.el7                               nodejs-qs.noarch 0:0.6.6-3.el7                                 
  nodejs-read.noarch 0:1.0.5-1.el7                                     nodejs-read-installed.noarch 0:0.2.4-1.el7                     
  nodejs-read-package-json.noarch 0:1.1.3-1.el7                        nodejs-request.noarch 0:2.25.0-1.el7                           
  nodejs-retry.noarch 0:0.6.0-5.el7                                    nodejs-rimraf.noarch 0:2.2.2-1.el7                             
  nodejs-semver.noarch 0:2.1.0-3.el7                                   nodejs-sha.noarch 0:1.2.1-1.el7                                
  nodejs-sigmund.noarch 0:1.0.0-5.el7                                  nodejs-slide.noarch 0:1.1.5-1.el7                              
  nodejs-sntp.noarch 0:0.2.4-1.el7                                     nodejs-tar.noarch 0:0.1.18-1.el7                               
  nodejs-tunnel-agent.noarch 0:0.3.0-1.el7                             nodejs-uid-number.noarch 0:0.0.3-7.el7                         
  nodejs-which.noarch 0:1.0.5-8.el7                                    openssl-devel.x86_64 1:1.0.1e-51.el7_2.5                       
  pcre-devel.x86_64 0:8.32-15.el7_2.1                                  perl-srpm-macros.noarch 0:1-8.el7                              
  redhat-rpm-config.noarch 0:9.1.0-68.el7.centos                       v8.x86_64 1:3.14.5.10-17.el7                                   
  v8-devel.x86_64 1:3.14.5.10-17.el7                                   zlib-devel.x86_64 0:1.2.7-15.el7                               

Dependency Updated:
  e2fsprogs.x86_64 0:1.42.9-7.el7              e2fsprogs-libs.x86_64 0:1.42.9-7.el7       glibc.x86_64 0:2.17-106.el7_2.6              
  glibc-common.x86_64 0:2.17-106.el7_2.6       krb5-libs.x86_64 0:1.13.2-12.el7_2         libcom_err.x86_64 0:1.42.9-7.el7             
  libgcc.x86_64 0:4.8.5-4.el7                  libgomp.x86_64 0:4.8.5-4.el7               libss.x86_64 0:1.42.9-7.el7                  
  libstdc++.x86_64 0:4.8.5-4.el7               openssl.x86_64 1:1.0.1e-51.el7_2.5         openssl-libs.x86_64 1:1.0.1e-51.el7_2.5      
  pcre.x86_64 0:8.32-15.el7_2.1                zlib.x86_64 0:1.2.7-15.el7                

Complete!


To install TLDR

Install the TLDR by using the following command.

[root@linuxhelp1 ~]# npm install -g tldr
npm http GET https://registry.npmjs.org/tldr
npm http 200 https://registry.npmjs.org/tldr
npm http GET https://registry.npmjs.org/tldr/-/tldr-1.6.0.tgz
npm http 200 https://registry.npmjs.org/tldr/-/tldr-1.6.0.tgz
npm http GET https://registry.npmjs.org/commander
npm http GET https://registry.npmjs.org/lodash.compact
npm http GET https://registry.npmjs.org/lodash.defaults
npm http GET https://registry.npmjs.org/lodash.unescape
npm http GET https://registry.npmjs.org/marked
npm http GET https://registry.npmjs.org/ms
.
.
.
??? ms@0.7.1
??? colors@1.1.2
??? wrench@1.5.9
??? marked@0.3.5
??? commander@2.9.0 (graceful-readlink@1.0.1)
??? lodash.defaults@4.0.1 (lodash.rest@4.0.4, lodash.assigninwith@4.1.0)
??? lodash.sample@4.1.1 (lodash.keys@4.0.8)
??? lodash.map@4.2.2 (lodash._baseeach@4.1.3, lodash._baseiteratee@4.5.2)
??? rimraf@2.5.4 (glob@7.0.5)
??? unzip2@0.2.5 (setimmediate@1.0.4, match-stream@0.0.2, readable-stream@1.0.34, pullstream@0.4.1, binary@0.3.0, fstream@0.1.31)
??? request@2.69.0 (oauth-sign@0.8.2, tunnel-agent@0.4.3, is-typedarray@1.0.0, aws-sign2@0.6.0, forever-agent@0.6.1, caseless@0.11.0, stringstream@0.0.5, isstream@0.1.2, json-stringify-safe@5.0.1, extend@3.0.0, aws4@1.4.1, node-uuid@1.4.7, qs@6.0.2, combined-stream@1.0.5, tough-cookie@2.2.2, mime-types@2.1.11, form-data@1.0.0-rc4, bl@1.0.3, hawk@3.1.3, har-validator@2.0.6, http-signature@1.1.1)


To Display the help page

[root@linuxhelp1 ~]# tldr --help

  Usage: tldr command [options]

  Simplified and community-driven man pages

  Options:

    -h, --help            output usage information
    -V, --version         output the version number
    -l, --list            List all commands for the chosen platform in the cache
    -a, --list-all        List all commands in the cache
    -1, --single-column   List single command per line (use with options -l or -a)
    -r, --random          Show a random command
    -e, --random-example  Show a random example
    -f, --render [file]   Render a specific markdown [file]
    -o, --os [type]       Override the operating system [linux, osx, sunos]
    --linux               Override the operating system with Linux
    --osx                 Override the operating system with OSX
    --sunos               Override the operating system with SunOS
    -u, --update          Update the local cache
    -c, --clear-cache     Clear the local cache

Examples

    $ tldr tar
    $ tldr du --os=linux
    $ tldr --list
    $ tldr --list-all
    $ tldr --random
    $ tldr --random-example

To control the cache

    $ tldr --update
    $ tldr --clear-cache

To render a local file (for testing)

    $ tldr --render /path/to/file.md


To display the ls command

[root@linuxhelp1 ~]# tldr ls

  ls
  List directory contents.

  - List files one per line:
    ls -1

  - List all files, including hidden files:
    ls -a

  - Long format list (permissions, ownership, size and modification date) of all files:
    ls -la

  - Long format list with size displayed using human readable units (KB, MB, GB):
    ls -lh

  - Long format list sorted by size (descending):
    ls -lS

  - Long format list of all files, sorted by modification date (oldest first):
    ls &ndash ltr


To display the tar command

[root@linuxhelp1 ~]# tldr tar

  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 czf 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

  - Extract a bzipped archive in the current directory:
    tar xjf source.tar.bz2

  - Create a compressed archive, using archive suffix to determine the compression program:
    tar caf target.tar.xz file1 file2 file3

  - List the contents of a tar file:
    tar tvf source.tar

Tags:
Author: 

Comments ( 0 )

No comments available

Frequently asked questions ( 5 )

Q

Can this one support for all type of linux distros

A

We can also install it from snap store, refer https://www.npmjs.com/package/tldr and find Install from snap store

Q

Need for more tools like this

A

Similarly you can use bropages & cheat

Q

Good tutorial keep up the good work

A

Thanks, keep following us at www.linuxhelp.com

Q

Why does Reddit love TLDR?

A

Since online forums can give way to lengthy debates and complex arguments, the TL;DR tag is used to help people locate summaries.

Q

How that works on Reddit?

A

Because so few people are reading long-form content or, worse yet, digging through pages and pages of irrelevant results to find the content they want, Reddit has capitalized on the TLDR phenomenon and created an entire TLDR section on their platform.

Back To Top!