Tldr

From Gentoo Wiki
Jump to:navigation Jump to:search

tldr (from the acronym "too long didn't read"), is a succinct help system for CLI commands. Complementary to man pages and "--info" documentation, it provides quick reference and can be a handy way to jog memory about basic command functionality.

Installation

app-text/tldr is available via the GURU repository.

To install it:

Enable the GURU repository:

root #eselect repository enable guru

Sync the repository:

root #emaint sync -r guru

Install the package:

root #emerge --ask app-text/tldr

Usage

Display a help page for a specific command:

root #tldr <command>

Update the local cache:

root #tldr --update

See also

  • Info — used to view and navigate info pages that contain computer program documentation. It is part of the Texinfo documentation system.
  • Man page — contains system reference documentation. It is found on most Unix-like systems.