Metadata-Version: 1.1
Name: tldr.py
Version: 0.3.0
Summary: A python client for tldr: simplified and community-driven man pages.
Home-page: https://github.com/lord63/tldr.py
Author: lord63
Author-email: lord63.j@gmail.com
License: MIT
Description: tldr.py
        =======
        
        |Latest Version| |Build Status| |Coverage Status| |Python Versions|
        
        Yet another python client for
        `tldr <https://github.com/tldr-pages/tldr>`__.
        
        Intro
        -----
        
        tldr.py is a python client for
        `tldr <https://github.com/tldr-pages/tldr>`__: simplified and
        community-driven man pages. Instead of the long man pages:
        
        .. figure:: https://cloud.githubusercontent.com/assets/5268051/10731428/5b5fd2fc-7c30-11e5-8cb1-4a3a24218ede.jpeg
           :alt: tar-man-page
        
           tar-man-page
        tldr will give you several simple yet powerful examples:
        
        .. figure:: https://cloud.githubusercontent.com/assets/5268051/10731475/95df13fc-7c30-11e5-97d8-8090b6146208.jpeg
           :alt: tar-tldr-page
        
           tar-tldr-page
        The command examples are not good? Don't worry, you can set up your own
        'tldr'! They are just markdown files and you can modify them at your
        ease. Don't forget to Share them with the community!
        
        One more thing, tldr is just a simple version for the man page, it's
        **NOT** an alternative. Sometimes, you should read the man pages
        patiently ;)
        
        Features highlight
        ------------------
        
        -  use local file, fast.
        -  support custom the output color.
        -  support fetch the latest tldr pages.
        -  support rebuild the index.
        
        Install
        -------
        
        ::
        
            $ (sudo) pip install tldr.py
        
        Usage
        -----
        
        Initialize
        ~~~~~~~~~~
        
        1. clone the tldr repo to somewhere(e.g. ~/code/tldr). We will use it
           when we look for a command usage.
        
           ::
        
               $ cd ~/code
               $ git clone git@github.com:tldr-pages/tldr.git
        
        2. init the configuration file.
        
           ::
        
               $ tldr init
               Input the tldr repo path(absolute path): (e.g. /home/lord63/code/tldr/)
               Input your platform(linux, osx or sunos): (e.g. linux)
               Initializing the config file at ~/.tldrrc
        
        and you configuration file should look like this:
        
        ::
        
            colors:
               command: cyan
               description: blue
               usage: green
            platform: linux
            repo_directory: /home/lord63/code/tldr
        
        Don't worry about the ``colors`` option, it is for the output when you
        look for a command, you can custom it by yourself.(Note that the color
        should be in ['black', 'red', 'green', 'yellow', 'blue', 'magenta',
        'cyan', 'white'])
        
        Use tldr
        ~~~~~~~~
        
        look for a command usage:
        
        ::
        
            $ tldr find {{command}}
        
        check for updates(so that we can get the latest man pages):
        
        ::
        
            $ tldr update
        
        Or you can use ``tldr --help`` to get the help message.
        
        FAQ
        ---
        
            Q: I want to add some custom command usages to a command, how to do
            it?
        
        A: Find the location of the command page; add the command usages; done.
        
            Q: I want to add some custom command pages, how?
        
        A: Add the comand pages to the right folder(e.g. /tldrrepo/pages/linux);
        rebuild the index; done.
        
            Q: I don't like the default color theme, how to change it?
        
        A: Edit the tldr configuration file at ``~/.tldrrc``; modify the color
        until you're happy with it.
        
            Q: I faided to update the tldr pages, why?
        
        A: Actually, ``tldr.py`` just tries to pull the latest tldr pages for
        you, no magic behinds it. So the reason why you faided to update is that
        ``tldr.py`` failed to pull the latest upstream, check the failing output
        and you may know the reason, e.g. you make some changes and haven't
        commit them yet. You can pull the pages by hand so you can have a better
        control on it.
        
        Contributing
        ------------
        
        -  It sucks? Why not help me improve it? Let me know the bad things.
        -  Want a new feature? Feel free to file an issue for a feature request.
        -  Find a bug? Open an issue please, or it's better if you can send me a
           pull request.
        
        Contributions are always welcome at any time! :sparkles: :cake:
        :sparkles:
        
        License
        -------
        
        MIT.
        
        .. |Latest Version| image:: http://img.shields.io/pypi/v/tldr.py.svg
           :target: https://pypi.python.org/pypi/tldr.py
        .. |Build Status| image:: https://travis-ci.org/lord63/tldr.py.svg
           :target: https://travis-ci.org/lord63/tldr.py
        .. |Coverage Status| image:: https://codecov.io/github/lord63/tldr.py/coverage.svg?branch=master
           :target: https://codecov.io/github/lord63/tldr.py?branch=master
        .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/tldr.py.svg
        
Keywords: tldr cli man command usage
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
