Metadata-Version: 1.1
Name: tldr
Version: 0.5
Summary: command line client for tldr
Home-page: https://github.com/tldr-pages/tldr-python-client
Author: Felix Yan
Author-email: felixonmars@gmail.com
License: MIT
Description: # tldr-python-client
        
        [![PyPI Release](https://img.shields.io/pypi/v/tldr.svg)](https://pypi.python.org/pypi/tldr)
        [![Build Status](https://travis-ci.org/tldr-pages/tldr-python-client.svg)](https://travis-ci.org/tldr-pages/tldr-python-client)
        
        A `Python` command line client for [tldr](https://github.com/tldr-pages/tldr).
        
        ![tldr screenshot](http://raw.github.com/tldr-pages/tldr/master/screenshot.png)
        
        ## Installation
        
        ### from PyPI
        
            $ pip install tldr
            
        ### from Arch Linux repository
        
            $ sudo pacman -S tldr
        
        ### from Fedora packages repository
        
            $ sudo dnf 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
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: SunOS/Solaris
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Utilities
Classifier: Topic :: System
