This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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.

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 History

This version
History Node

0.3

History Node

0.2

History Node

0.1.3.1

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
tldr-0.3-py2-none-any.whl (10.5 kB) Copy SHA256 Checksum SHA256 py2 Wheel Aug 15, 2016
tldr-0.3-py3-none-any.whl (10.5 kB) Copy SHA256 Checksum SHA256 py3 Wheel Aug 15, 2016
tldr-0.3.tar.gz (7.2 kB) Copy SHA256 Checksum SHA256 Source Aug 15, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting