Monday, May 10, 2021

too long; didn't read

The tldr-pages project is a collection of community-maintained help pages for command-line tools, that aims to be a simpler, more approachable complement to traditional man pages.
- https://github.com/tldr-pages/tldr

(Also see: https://tldr.sh/)


Nice tool. Here's an example:

$ tldr df

  df

  Gives an overview of the filesystem disk space usage.
  More information: https://www.gnu.org/software/coreutils/df.

  - Display all filesystems and their disk usage:
    df

  - Display all filesystems and their disk usage in human readable form:
    df -h

  - Display the filesystem and its disk usage containing the given file or directory:
    df path/to/file_or_directory

  - Display statistics on the number of free inodes:
    df -i

  - Display filesystems but exclude the specified types:
    df -x squashfs -x tmpfs



The tldr tool was mentioned in the article "5 modern alternatives to essential Linux command-line tools".

 

I installed it in Debian and in Kubuntu with:

$ sudo apt install tldr

And, I added it in Arch with:

$ sudo pacman -S tldr

 

Looks like the tldr-pages project will nicely complement the (still) all-important man pages. It's very nice to have a few command examples at the fingertips, no question.