command line client for tldr
Project description
A Python command line client for tldr.
tldr screenshot
Installation
$ pip install tldr
Usage
tldr <command>
Configuration
You can configure the behaviour and output of the tldr client by setting environment variables. For example, in the .bashrc file:
export TLDR_COLOR_BLANK="white" export TLDR_COLOR_NAME="cyan" export TLDR_COLOR_DESCRIPTION="white" export TLDR_COLOR_EXAMPLE="green" export TLDR_COLOR_COMMAND="red" export TLDR_COLOR_PARAMETER="white" export TLDR_CACHE_ENABLED=1 export TLDR_CACHE_MAX_AGE=720
Cache
TLDR_CACHE_ENABLED (default is 1):
If set to 1, the client will first try to load from cache, and fall back to fetching from the internet if the cache doesn’t exist or is too old.
If set to 0, the client will fetch from the internet, and fall back to the cache if the page cannot be fetched from the internet.
TLDR_CACHE_MAX_AGE (default is 24): maximum age of the cache in hours to be considered as valid when TLDR_CACHE_ENABLED is set to 1.
Cache location in order of precedence
$XDG_CACHE_HOME/tldr
$HOME/.cache/tldr
~/.cache/tldr
Previously, the cache resided in $HOME/.tldr_cache
If you are experiencing issues with tldr, consider deleting the cache files before trying other measures.
Colors
Values of the TLDR_COLOR_x variables may consist of three parts: * Font color, required: blue, green, yellow, cyan, magenta, white, grey, red * Background color: on_blue, on_cyan, on_magenta, on_white, on_grey, on_yellow, on_red, on_green * Additional effects, which depends on platform: reverse, blink, dark, concealed, underline, bold
Values of background color and additional effect may be omitted: * TLDR_COLOR_DESCRIPTION="white" for white text on default system background color without any effects * TLDR_COLOR_NAME="cyan dark" for dark cyan text on default system background color * TLDR_COLOR_PARAMETER="red on_yellow underline" for underlined red text on yellow background
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 Distributions
File details
Details for the file tldr-0.4.2.tar.gz.
File metadata
- Download URL: tldr-0.4.2.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e31f01c5feed771bbb23c0a5b79fc1f2f2b3078393e9ede2d7c3abd1d233a10a |
|
| MD5 | 8684aadd05bc38be015a245597e299e2 |
|
| BLAKE2b-256 | 70a47dde0bcc30b101987e5e35828ccab479791b6e6075058e14e825ea903b26 |
File details
Details for the file tldr-0.4.2-py3-none-any.whl.
File metadata
- Download URL: tldr-0.4.2-py3-none-any.whl
- Upload date:
- Size: 13.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 343a8b27268c37d31cc4de703f39233762850ad6696a168c8849858e46a0de2e |
|
| MD5 | c31178a52a80592b74accc8efd68ec31 |
|
| BLAKE2b-256 | 7e1b7a2332c533749c682929b01af574dca139483d4e33b1925701c1cf3b095b |
File details
Details for the file tldr-0.4.2-py2-none-any.whl.
File metadata
- Download URL: tldr-0.4.2-py2-none-any.whl
- Upload date:
- Size: 13.9 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7e345391119e9ff5248bfa22b50dd74b7549c724f9c10a47f983ac5e9ff1b6b7 |
|
| MD5 | bc998a06f31237e58b95168970eed7dc |
|
| BLAKE2b-256 | e2e90eff4fa24a0e980b7e1749dc2e5af1a7578cf175b4aa16d34f9c06e3f377 |
