|
3 | 3 | [](https://pypi.python.org/pypi/tldr) |
4 | 4 | [](https://travis-ci.org/tldr-pages/tldr-python-client) |
5 | 5 |
|
6 | | -A `Python` command line client for [tldr](https://github.com/tldr-pages/tldr). |
| 6 | +Python command-line client for [tldr pages](https://github.com/tldr-pages/tldr). |
7 | 7 |
|
8 | 8 |  |
9 | 9 |
|
10 | 10 | ## Installation |
11 | 11 |
|
12 | 12 | ### from PyPI |
13 | 13 |
|
14 | | - pip install tldr |
| 14 | +```bash |
| 15 | +pip install tldr |
| 16 | +``` |
15 | 17 |
|
16 | 18 | ### from Arch Linux repository |
17 | 19 |
|
18 | | - sudo pacman -S tldr |
| 20 | +```bash |
| 21 | +sudo pacman -S tldr |
| 22 | +``` |
19 | 23 |
|
20 | 24 | ### from Fedora packages repository |
21 | 25 |
|
22 | | - sudo dnf install tldr |
| 26 | +```bash |
| 27 | +sudo dnf install tldr |
| 28 | +``` |
23 | 29 |
|
24 | 30 | ## Usage |
25 | 31 |
|
@@ -51,15 +57,17 @@ optional arguments: |
51 | 57 |
|
52 | 58 | You can configure the behavior and output of the `tldr` client by setting environment variables. For example, in the `.bashrc` file: |
53 | 59 |
|
54 | | - export TLDR_COLOR_NAME="cyan" |
55 | | - export TLDR_COLOR_DESCRIPTION="white" |
56 | | - export TLDR_COLOR_EXAMPLE="green" |
57 | | - export TLDR_COLOR_COMMAND="red" |
58 | | - export TLDR_COLOR_PARAMETER="white" |
59 | | - export TLDR_CACHE_ENABLED=1 |
60 | | - export TLDR_CACHE_MAX_AGE=720 |
61 | | - export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/master/pages" |
62 | | - export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip" |
| 60 | +```bash |
| 61 | +export TLDR_COLOR_NAME="cyan" |
| 62 | +export TLDR_COLOR_DESCRIPTION="white" |
| 63 | +export TLDR_COLOR_EXAMPLE="green" |
| 64 | +export TLDR_COLOR_COMMAND="red" |
| 65 | +export TLDR_COLOR_PARAMETER="white" |
| 66 | +export TLDR_CACHE_ENABLED=1 |
| 67 | +export TLDR_CACHE_MAX_AGE=720 |
| 68 | +export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/master/pages" |
| 69 | +export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip" |
| 70 | +``` |
63 | 71 |
|
64 | 72 | ### Cache |
65 | 73 |
|
|
0 commit comments