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:
Niels Bom 2024-05-01 15:51:30 +02:00 committed by GitHub
parent 5d8a7ea7b2
commit c72416d570
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 0 deletions

View File

@ -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 |