README.md - refer to man pages
Not everybody's first instinct is to `man zoxide` so let's be explicit.
This commit is contained in:
parent
5d8a7ea7b2
commit
c72416d570
13
README.md
13
README.md
|
|
@ -41,6 +41,7 @@ zoxide works on all major shells.
|
||||||
[Getting started](#getting-started) •
|
[Getting started](#getting-started) •
|
||||||
[Installation](#installation) •
|
[Installation](#installation) •
|
||||||
[Configuration](#configuration) •
|
[Configuration](#configuration) •
|
||||||
|
[Usage](#usage) •
|
||||||
[Integrations](#third-party-integrations)
|
[Integrations](#third-party-integrations)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -427,6 +428,18 @@ Environment variables[^2] can be used for configuration. They must be set before
|
||||||
- When set to 1, `z` will resolve symlinks before adding directories to the
|
- When set to 1, `z` will resolve symlinks before adding directories to the
|
||||||
database.
|
database.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Zoxide uses [man pages](https://en.wikipedia.org/wiki/Man_page) for its documentation. To see them:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
man zoxide
|
||||||
|
# For the subcommands
|
||||||
|
man zoxide-query
|
||||||
|
```
|
||||||
|
|
||||||
|
You can find [these man pages online](https://www.mankier.com/1/zoxide) too.
|
||||||
|
|
||||||
## Third-party integrations
|
## Third-party integrations
|
||||||
|
|
||||||
| Application | Description | Plugin |
|
| Application | Description | Plugin |
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue