tldr pages

From Gentoo Wiki
Jump to:navigation Jump to:search
This article is a stub. Please help out by expanding it - how to get started.

tldr pages ("too long didn't read") is a project to provide brief documentation for CLI commands.

Complementary to man pages and Info documentation, tldr pages provide a quick reference with examples. They can be a handy way to jog memory about basic command functionality, but don't aim to provide comprehensive documentation.

Available software

Ebuilds for two tldr pages clients are currently available in the GURU repository. See the GURU guide and emerge for installation instructions.

Name Homepage Description
app-misc/tealdeer::guru https://github.com/tealdeer-rs/tealdeer Command-line tldr pages client in Rust.
app-text/tldr::guru https://github.com/tldr-pages/tldr-python-client/ Python command-line tldr pages client.

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.