diff options
Diffstat (limited to 'plugins/z/z.1')
-rw-r--r-- | plugins/z/z.1 | 35 |
1 files changed, 23 insertions, 12 deletions
diff --git a/plugins/z/z.1 b/plugins/z/z.1 index 022a4b35d..cc99910bf 100644 --- a/plugins/z/z.1 +++ b/plugins/z/z.1 @@ -4,7 +4,7 @@ NAME z \- jump around .SH SYNOPSIS -z [\-chlrt] [regex1 regex2 ... regexn] +z [\-chlrtx] [regex1 regex2 ... regexn] .SH AVAILABILITY bash, zsh @@ -13,12 +13,14 @@ DESCRIPTION Tracks your most used directories, based on 'frecency'. .P After a short learning phase, \fBz\fR will take you to the most 'frecent' -directory that matches ALL of the regexes given on the command line. +directory that matches ALL of the regexes given on the command line, in order. + +For example, \fBz foo bar\fR would match \fB/foo/bar\fR but not \fB/bar/foo\fR. .SH OPTIONS .TP \fB\-c\fR -restrict matches to subdirectories of the current directory. +restrict matches to subdirectories of the current directory .TP \fB\-h\fR show a brief help message @@ -31,13 +33,16 @@ match by rank only .TP \fB\-t\fR match by recent access only +.TP +\fB\-x\fR +remove the current directory from the datafile .SH EXAMPLES .TP 14 \fBz foo\fR cd to most frecent dir matching foo .TP 14 \fBz foo bar\fR -cd to most frecent dir matching foo and bar +cd to most frecent dir matching foo, then bar .TP 14 \fBz -r foo\fR cd to highest ranked dir matching foo @@ -76,10 +81,13 @@ Set \fB$_Z_NO_RESOLVE_SYMLINKS\fR to prevent symlink resolution. Set \fB$_Z_NO_PROMPT_COMMAND\fR to handle \fBPROMPT_COMMAND/precmd\fR yourself. .RE .RS -Set \fB$_Z_EXCLUDE_DIRS\fR to an array of directories to exclude. +Set \fB$_Z_EXCLUDE_DIRS\fR to an array of directory trees to exclude. +.RE +.RS +Set \fB$_Z_OWNER\fR to allow usage when in 'sudo -s' mode. .RE .RS -(These settings should go in .bashrc/.zshrc before the lines added above.) +(These settings should go in .bashrc/.zshrc before the line added above.) .RE .RS Install the provided man page \fBz.1\fR somewhere like \fB/usr/local/man/man1\fR. @@ -88,12 +96,12 @@ Install the provided man page \fBz.1\fR somewhere like \fB/usr/local/man/man1\fR Aging: The rank of directories maintained by \fBz\fR undergoes aging based on a simple formula. The rank of each entry is incremented every time it is accessed. When -the sum of ranks is greater than 6000, all ranks are multiplied by 0.99. Entries -with a rank lower than 1 are forgotten. +the sum of ranks is over 9000, all ranks are multiplied by 0.99. Entries with a +rank lower than 1 are forgotten. .SS Frecency: -Frecency is a portmantaeu of 'recent' and 'frequency'. It is a weighted rank -that depends on how often and how recently something occured. As far as I +Frecency is a portmanteau of 'recent' and 'frequency'. It is a weighted rank +that depends on how often and how recently something occurred. As far as I know, Mozilla came up with the term. .P To \fBz\fR, a directory that has low ranking but has been accessed recently @@ -131,7 +139,7 @@ The environment variable \fB$_Z_NO_RESOLVE_SYMLINKS\fR can be set to prevent resolving of symlinks. If it is not set, symbolic links will be resolved when added to the datafile. .P -In bash, \fBz\fR prepends a command to the \fBPROMPT_COMMAND\fR environment +In bash, \fBz\fR appends a command to the \fBPROMPT_COMMAND\fR environment variable to maintain its database. In zsh, \fBz\fR appends a function \fB_z_precmd\fR to the \fBprecmd_functions\fR array. .P @@ -139,8 +147,11 @@ The environment variable \fB$_Z_NO_PROMPT_COMMAND\fR can be set if you want to handle \fBPROMPT_COMMAND\fR or \fBprecmd\fR yourself. .P The environment variable \fB$_Z_EXCLUDE_DIRS\fR can be set to an array of -directories to exclude from tracking. \fB$HOME\fR is always excluded. +directory trees to exclude from tracking. \fB$HOME\fR is always excluded. Directories must be full paths without trailing slashes. +.P +The environment variable \fB$_Z_OWNER\fR can be set to your username, to +allow usage of \fBz\fR when your sudo enviroment keeps \fB$HOME\fR set. .SH FILES Data is stored in \fB$HOME/.z\fR. This can be overridden by setting the |