Update documentation

This commit is contained in:
mataha 2024-06-11 01:01:56 +02:00
parent 9d9d605d50
commit 3cc6de20ac
3 changed files with 14 additions and 18 deletions

View File

@ -135,9 +135,6 @@ zoxide can be installed in 4 easy steps:
<details> <details>
<summary>Windows</summary> <summary>Windows</summary>
> zoxide works with PowerShell, as well as shells running in Cygwin, Git
> Bash, and MSYS2.
>
> The recommended way to install zoxide is via `winget`: > The recommended way to install zoxide is via `winget`:
> >
> ```sh > ```sh
@ -409,7 +406,7 @@ When calling `zoxide init`, the following flags are available:
- `--cmd` - `--cmd`
- Changes the prefix of the `z` and `zi` commands. - Changes the prefix of the `z` and `zi` commands.
- `--cmd j` would change the commands to (`j`, `ji`). - `--cmd j` would change the commands to (`j`, `ji`).
- `--cmd cd` would replace the `cd` command. - `--cmd cd` would replace the `cd` command (highly recommended on `cmd.exe`).
- `--hook <HOOK>` - `--hook <HOOK>`
- Changes how often zoxide increments a directory's score: - Changes how often zoxide increments a directory's score:
@ -421,8 +418,8 @@ When calling `zoxide init`, the following flags are available:
- `--no-cmd` - `--no-cmd`
- Prevents zoxide from defining the `z` and `zi` commands. - Prevents zoxide from defining the `z` and `zi` commands.
- These functions will still be available in your shell as `__zoxide_z` and - These functions will still be available in your shell (not on `cmd.exe`)
`__zoxide_zi`, should you choose to redefine them. as `__zoxide_z` and `__zoxide_zi`, should you choose to redefine them.
### Environment variables ### Environment variables
@ -440,17 +437,16 @@ Environment variables[^2] can be used for configuration. They must be set before
| Windows | `%LOCALAPPDATA%` | `C:\Users\Alice\AppData\Local` | | Windows | `%LOCALAPPDATA%` | `C:\Users\Alice\AppData\Local` |
- `_ZO_ECHO` - `_ZO_ECHO`
- When set to 1, `z` will print the matched directory before navigating to - When set to 1, `z` will print the matched directory after navigating to it.
it.
- `_ZO_EXCLUDE_DIRS` - `_ZO_EXCLUDE_DIRS`
- Excludes the specified directories from the database. - Excludes the specified directories from the database.
- This is provided as a list of [globs][glob], separated by OS-specific - This is provided as a list of [globs][glob], separated by OS-specific
characters: characters:
| OS | Separator | Example | | OS | Separator | Example |
| ------------------- | --------- | ----------------------- | | ------------------- | --------- | ------------------------- |
| Linux / macOS / BSD | `:` | `$HOME:$HOME/private/*` | | Linux / macOS / BSD | `:` | `$HOME:$HOME/private/*` |
| Windows | `;` | `$HOME;$HOME/private/*` | | Windows | `;` | `%HOME%;%HOME%/private/*` |
- By default, this is set to `"$HOME"`. - By default, this is set to `"$HOME"`.
- `_ZO_FZF_OPTS` - `_ZO_FZF_OPTS`

View File

@ -98,8 +98,8 @@ Changes the prefix of the \fBz\fR and \fBzi\fR commands.
.br .br
\fB--cmd j\fR would change the commands to (\fBj\fR, \fBji\fR). \fB--cmd j\fR would change the commands to (\fBj\fR, \fBji\fR).
.br .br
\fB--cmd cd\fR would replace the \fBcd\fR command (doesn't work on Nushell / \fB--cmd cd\fR would replace the \fBcd\fR command (highly recommended on
POSIX shells). \fBcmd.exe\fR).
.TP .TP
.B -h, --help .B -h, --help
Print help information. Print help information.
@ -116,8 +116,8 @@ l l.
.TP .TP
.B --no-cmd .B --no-cmd
Prevents zoxide from defining the \fBz\fR and \fBzi\fR commands. These functions Prevents zoxide from defining the \fBz\fR and \fBzi\fR commands. These functions
will still be available in your shell as \fB__zoxide_z\fR and \fB__zoxide_zi\fR, will still be available in your shell (not on \fBcmd.exe\fR) as \fB__zoxide_z\fR
should you choose to redefine them. and \fB__zoxide_zi\fR, should you choose to redefine them.
.SH REPORTING BUGS .SH REPORTING BUGS
For any issues, feature requests, or questions, please visit: For any issues, feature requests, or questions, please visit:
.sp .sp

View File

@ -70,7 +70,7 @@ T}
.TE .TE
.TP .TP
.B _ZO_ECHO .B _ZO_ECHO
When set to 1, \fBz\fR will print the matched directory before navigating to it. When set to 1, \fBz\fR will print the matched directory after navigating to it.
.TP .TP
.B _ZO_EXCLUDE_DIRS .B _ZO_EXCLUDE_DIRS
Prevents the specified directories from being added to the database. This is Prevents the specified directories from being added to the database. This is
@ -82,7 +82,7 @@ l l.
\fBLinux/macOS/BSD\fR|T{ \fBLinux/macOS/BSD\fR|T{
\fB:\fR, eg. \fB$HOME:$HOME/private/*\fR \fB:\fR, eg. \fB$HOME:$HOME/private/*\fR
T} T}
\fBWindows\fR|\fB;\fR, eg. \fB$HOME;$HOME/private/*\fR \fBWindows\fR|\fB;\fR, eg. \fB%HOME%;%HOME%/private/*\fR
.TE .TE
.sp .sp
By default, this is set to \fB$HOME\fR. After setting this up, you might need By default, this is set to \fB$HOME\fR. After setting this up, you might need