This commit is contained in:
Ajeet D'Souza 2021-04-15 19:16:47 +05:30
parent cc4bbb63d3
commit 5ac3e3201d
3 changed files with 14 additions and 7 deletions

View File

@ -5,12 +5,13 @@ zoxide-add - add a new directory or increment its rank
.B zoxide add \fIPATH\fR .B zoxide add \fIPATH\fR
.SH DESCRIPTION .SH DESCRIPTION
If the directory is not already in the database, this command creates a new If the directory is not already in the database, this command creates a new
entry for it with a default score of 1, otherwise, it increments the existing entry for it with a default score of \fI1\fR, otherwise, it increments the
score by 1. It then sets the last updated field of the entry to the current existing score by \fI1\fR. It then sets the last updated field of the entry to the
time. current time. After this, it runs the \fBAGING\fR algorithm on the database. See
.sp
After this, it runs the \fBAGING\fR algorithm on the database. See
\fBzoxide\fR(1) for more about the algorithm. \fBzoxide\fR(1) for more about the algorithm.
.sp
If you'd like to prevent a directory from being added to the database, see the
\fB_ZO_EXCLUDE_DIRS\fR environment variable in \fBzoxide\fR(1).
.SH OPTIONS .SH OPTIONS
.TP .TP
.B -h, --help .B -h, --help

View File

@ -3,6 +3,9 @@
zoxide-remove - remove a directory from the database zoxide-remove - remove a directory from the database
.SH SYNOPSIS .SH SYNOPSIS
.B zoxide remove \fIPATH [OPTIONS]\fR .B zoxide remove \fIPATH [OPTIONS]\fR
.SH DESCRIPTION
If you'd like to permanently exclude a directory from the database, see the
\fB_ZO_EXCLUDE_DIRS\fR environment variable in \fBzoxide\fR(1).
.SH OPTIONS .SH OPTIONS
.TP .TP
.B -h, --help .B -h, --help

View File

@ -72,8 +72,8 @@ When set to \fI1\fR, z will print the matched directory before navigating
to it. to it.
.TP .TP
.B _ZO_EXCLUDE_DIRS .B _ZO_EXCLUDE_DIRS
Excludes the specified directories from the database. This is provided as a Prevents the specified directories from being added to the database. This is
list of globs, separated by OS-specific characters: provided as a list of globs, separated by OS-specific characters:
.TS .TS
tab(|); tab(|);
l l. l l.
@ -83,6 +83,9 @@ l l.
T} T}
Windows|\fI;\fR eg. $HOME;$HOME/private/* Windows|\fI;\fR eg. $HOME;$HOME/private/*
.TE .TE
.sp
After setting this up, you might need to use \fBzoxide-remove\fR(1) to remove
any existing entries from the database.
.TP .TP
.B _ZO_FZF_OPTS .B _ZO_FZF_OPTS
Custom options to pass to fzf. See \fBman fzf\fR for the list of options. Custom options to pass to fzf. See \fBman fzf\fR for the list of options.