Repository files navigation

tldr-man is a command-line client fortldr-pages,a collection of community-maintained help pages for command-line tools.It differs from other clients because it displays its pages asman pages.

This client is also able to integrate with theman command to fall back to displaying a tldr-page for a command whenno manpage exists.

Features:

• Fully abides by thetldr-pages client specification.
• Supports all page languages, not just English pages.
• Displays tldr-pages in the same style as manpages.
• Integrates withman to provide a fallback for missing manpages.
• Supports rendering markdown formatted tldr-pages with--render.
• Local cache abides by theXDG base directory specification.
• Supports shell completion forbash,zsh, andfish shells.
• And much more!

Installtldr-man withHomebrew:

brew install superatomic/tap/tldr-man

Installtldr-man with pip (version 3.10+):

pip install tldr-man

tldr-man additionally depends onpandoc being installed.

After installation, you can view a tldr-page with thetldr command.

Display a tldr-page for a command:

tldr<COMMAND>

Update the local page cache:

tldr --update

Render a page locally:

tldr --render path/to/page.md

Print tldr manpage paths as a colon-separated list (see theManpage Integration section):

tldr --manpath

Display usage information:

tldr --help

As specified by the tldr-pages client specification,tldr-pages from other languages can be displayed by this client(falling back to English if the page doesn't exist for that language).

To do so, set any of the environment variables$LANG,$LANGUAGE, or$TLDR_LANGUAGE to the two-letter language codefor your language (e.g.export LANGUAGE=es),or set the--language option when runningtldr (e.g.tldr <COMMAND> --language es).

By default, tldr-pages will be displayed based on your current platform.To directly specify what platform's page to use, use the--platform flag.

For example, to display the macOS version of thetop command's tldr-page, runtldr top --platform macos.This is the default behavior on macOS,but--platform macos is required to show the macOS version of this page on other platforms.

The commandman can be set up to fall back to displaying tldr-pages if no manpages are found.

To do so,add the provided line to your shell's startup script (e.g.~/.bash_profile,~/.zshenv,~/.config/fish/config.fish)to add this behavior toman:

export MANPATH="$MANPATH:$(tldr --manpath)"

set -gxa MANPATH (tldr --manpath)