Command-line TLDR client that displays tldr-pages as manpages
Project description
tldr-man
A tldr-pages client that works just like man
tldr-man
is a command-line client for tldr-pages,
a collection of community-maintained help pages for command-line tools.
It differs from other clients because it displays its pages as man
pages.
This client is also able to integrate with the man
command to fall back to displaying a tldr-page for a command when
no manpage exists.
Features:
- Fully abides by the tldr-pages client specification.
- Supports all page languages, not just English pages.
- Displays tldr-pages in the same style as manpages.
- Integrates with
man
to provide a fallback for missing manpages. - Supports rendering markdown formatted tldr-pages with
--render
. - Local cache abides by the XDG base directory specification.
- Supports shell completion for
bash
,zsh
, andfish
shells. - And much more!
Installation
With Homebrew
Install tldr-man
with Homebrew:
brew install superatomic/tap/tldr-man
With Pip
Install tldr-man
with pip (version 3.10+):
pip install tldr-man
tldr-man
additionally depends on pandoc
being installed.
After installation, you can view a tldr-page with the tldr
command.
Usage
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 the Manpage Integration section):
tldr --manpath
Display usage information:
tldr --help
Setting languages
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 code
for your language (e.g. export LANGUAGE=es
),
or set the --language
option when running tldr
(e.g. tldr <COMMAND> --language es
).
Setting platforms
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 the top
command's tldr-page, run tldr 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.
Manpage Integration
The command man
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 to man
:
Bash and Zsh
export MANPATH="$MANPATH:$(tldr --manpath)"
Fish
set -gxa MANPATH (tldr --manpath)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tldr_man-1.5.2.tar.gz
.
File metadata
- Download URL: tldr_man-1.5.2.tar.gz
- Upload date:
- Size: 19.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.2 Darwin/21.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9846937efea7e6c9505545f8725773bb2a68185dc015479207da0b185b797dc3 |
|
MD5 | c50b7d53c21c06497410bcd622dd7fb4 |
|
BLAKE2b-256 | 9ed5145efae76326bb9b53a08b67c45f315336f0e193821ecde22e21a94785a5 |
File details
Details for the file tldr_man-1.5.2-py3-none-any.whl
.
File metadata
- Download URL: tldr_man-1.5.2-py3-none-any.whl
- Upload date:
- Size: 25.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.2 Darwin/21.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdd185bb3f386c9f87b9ec94b6439c34f2ebcb8add0cb5d323b63eeff59a2b02 |
|
MD5 | ac8d2a8f685f9bb21c5b63f54cfcaef5 |
|
BLAKE2b-256 | e6dfd26829d57a919c3a239f4aa14c205bbdda1e81588b9c962d46257dad0bab |