@@ -46,25 +46,24 @@ The default prefix for installation is `/usr/local/bin`.
46
46
47
47
Building the ` tldr ` client is pretty straightforward.
48
48
49
- #### Requirements
49
+ ### Requirements
50
50
51
51
- ` clang ` /` gcc `
52
52
- ` libcurl ` (` brew install curl ` / ` apt-get install libcurl-dev ` / ` apt-get install libcurl4-openssl-dev ` )
53
53
- ` libzip ` (` brew install libzip ` / ` apt-get install libzip-dev ` )
54
54
- ` pkg-config ` (` brew install pkg-config ` / ` apt-get install pkg-config ` )
55
55
56
- #### Compiling
56
+ ### Compiling
57
57
58
58
The [ ` Makefile ` ] ( https://github.com/tldr-pages/tldr-c-client/blob/master/Makefile )
59
59
in the root directory has all you need for building the project.
60
60
61
61
Just call ` make ` and ` tldr ` will build itself.
62
62
63
- ```
63
+ ``` shell
64
64
make
65
65
```
66
66
67
-
68
67
## Autocompletion
69
68
70
69
Autocompletion is supported for ` bash ` , ` zsh ` , and ` fish ` and can be added by sourcing
@@ -73,7 +72,7 @@ the correct autocompletion file.
73
72
The files ` autocomplete.zsh ` , ` autocomplete.bash ` , and ` autocomplete.fish ` can be found in the ` autocomplete `
74
73
folder in the root of the repository.
75
74
76
- #### Installation
75
+ ### Installation
77
76
78
77
To install the autocompletion, just move the script for your shell to an easy
79
78
to access the directory (like your home directory), and source it in your ` .bashrc ` or ` .zshrc ` .
@@ -85,20 +84,24 @@ mv autocomplete/complete.zsh ~/.tldr.complete
85
84
echo " source ~/.tldr.complete" >> ~ /.zshrc
86
85
```
87
86
88
-
89
87
## Usage
90
88
91
- ```
92
- usage: ./ tldr [-v] [OPTION]... SEARCH
89
+ ``` shell
90
+ usage: tldr [-v] [OPTION]... SEARCH
93
91
94
92
available commands:
95
- -v print verbose output
96
- --version print version and exit
97
- -h, --help print this help and exit
98
- -u, --update update local database
99
- -c, --clear-cache clear local database
100
- -p, --platform=PLATFORM select platform, supported are linux / osx / sunos / common
93
+ -v print verbose output
94
+ --version print version and exit
95
+ -h, --help print this help and exit
96
+ -u, --update update local database
97
+ -c, --clear-cache clear local database
98
+ -l, --list list all entries in the local database
99
+ -p, --platform=PLATFORM select platform, supported are linux / osx / sunos / windows / common
100
+ --linux show command page for Linux
101
+ --osx show command page for OSX
102
+ --sunos show command page for SunOS
101
103
-r, --render=PATH render a local page for testing purposes
104
+ -C, --color force color display
102
105
` ` `
103
106
104
107
# # Configuration
0 commit comments