Metadata-Version: 2.1
Name: tldr
Version: 1.1.0
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?branch=master)](https://travis-ci.org/tldr-pages/tldr-python-client)
        
        Python command-line client for [tldr pages](https://github.com/tldr-pages/tldr).
        
        ![tldr screenshot](http://raw.github.com/tldr-pages/tldr/master/images/screenshot.png)
        
        ## Installation
        
        ### from PyPI
        
        ```bash
        pip install tldr
        ```
        
        ### from Arch Linux repository
        
        ```bash
        sudo pacman -S tldr
        ```
        
        ### from Fedora packages repository
        
        ```bash
        sudo dnf install tldr
        ```
        
        ## Usage
        
        ```
        usage: tldr [-u] [-p PLATFORM] [-s SOURCE] [-c] [-r] [-L LANGUAGE] command
        
        Python command line client for tldr
        
        positional arguments:
          command               command to lookup
        
        optional arguments:
          -h, --help            show this help message and exit
          -v, --version         show program's version number and exit
          -u, --update_cache    Update the local cache of pages and exit
          -p PLATFORM, --platform PLATFORM
                                Override the operating system [linux, osx, sunos,
                                windows, common]
          -s SOURCE, --source SOURCE
                                Override the default page source
          -c, --color           Override color stripping
          -r, --render          Render local markdown files
          -l, --list            List all available commands for operating system    
          -L LANGUAGE, --language LANGUAGE
                                Override the default language
        ```
        
        ## Configuration
        
        You can configure the behavior and output of the `tldr` client by setting environment variables. For example, in the `.bashrc` file:
        
        ```bash
        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
        export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/master/pages"
        export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip"
        ```
        
        ### Cache
        
        Cache is downloaded from `TLDR_DOWNLOAD_CACHE_LOCATION` (defaults to the one described in [the client specification](https://github.com/tldr-pages/tldr/blob/master/CLIENT-SPECIFICATION.md#caching)), unzipped and extracted into the [local cache directory](#cache-location). Pages are loaded directly from `TLDR_PAGES_SOURCE_LOCATION` if `tldr <command>` is used.
        
        * `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`
        
        If you are experiencing issues with *tldr*, consider deleting the cache files before trying other measures.
        
        #### Autocomplete
        
        `argcomplete` is required for autocompletion. See the `argcomplete` [docs](https://pypi.org/project/argcomplete/) for how to enable `argcomplete`. Cache will also need to be enabled and downloaded.
        
        ### SSL Inspection
        
        For networks that sit behind a proxy, it may be necessary to disable SSL verification for the client to function. Setting the following:
        
        * `TLDR_ALLOW_INSECURE=1` 
        
        will disable SSL certificate inspection. This __should be avoided__ unless absolutely necessary.
        
        ### Colors
        
        Values of the `TLDR_COLOR_x` variables may consist of three parts:
        * Font color: `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`
        
        You may specify as many additional effects as you want, while only one of font and background color.
        
        Any of the values of above may be omitted. For example, you can do similar things as the following:
        * `TLDR_COLOR_NAME=""` use default system font color with default background color without any effects
        * `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_NAME="on_red"` for default system font color on red background color
        * `TLDR_COLOR_PARAMETER="red on_yellow underline"` for underlined red text on yellow background
        * `TLDR_COLOR_NAME="bold underline"` for default system font and background colors with underline and bolded effects
        
        ### Language
        
        The language that tldr will use is dependent on a number of factors. If you specify a language via the
        `--language` flag, tldr will attempt to use that language and only that language. Otherwise, it will
        default to language set using `LANGUAGE` and `LANG` (ignoring the value `C` and `POSIX`).
        If neither are set, then tldr will always attempt to get the `en` page. Finally, if `LANG` is set, it uses `LANGUAGE`, if set,
        first as the priority list to try languages in, followed by `LANG` if not included in `LANGUAGE`
        and `en` as fallback (assuming it does not already appear somewhere in `LANGUAGE` or `LANG`).
        All language values should be set to a value that follows [RFC 1766](https://tools.ietf.org/html/rfc1766.html),
        with the special exception of `C` and `POSIX` which is ignored.
        
        ### Remote source
        
        If you wish to use your own instance of the tldr pages instead of the default repository, you
        can either use the `--source` flag when using tldr or by specifying the following environment variables:
        
        * `TLDR_PAGES_SOURCE_LOCATION` to control where to get individual pages from
          * defaults to `https://raw.githubusercontent.com/tldr-pages/tldr/master/pages`
          * it can also point to local directory using `file:///path/to/directory`
        * `TLDR_DOWNLOAD_CACHE_LOCATION` to control where to pull a zip of all pages from
          * defaults to `https://tldr-pages.github.io/assets/tldr.zip`
        
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 :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Utilities
Classifier: Topic :: System
Requires-Python: ~=3.5
Description-Content-Type: text/markdown
