Skip to content

Commit

Permalink
document reliance on $PROMPT_COMMAND
Browse files Browse the repository at this point in the history
  • Loading branch information
rupa committed Aug 23, 2011
1 parent 7634453 commit cf4b1af
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,14 @@ ENVIRONMENT

An alias $_Z_CMD='_z 2>&1' is defined. If not set, $_Z_CMD defaults to z.

In bash, z uses the PROMPT_COMMAND environment variable to maintain its
database. Specifically it prepends:

_z --add "$(pwd -P 2>/dev/null)" 2>/dev/null;

to any existing PROMPT_COMMAND. zsh users need to manually set precmd() as
described in the installation instructions.


FILES
Data is stored in $_Z_DATA. If not set, $_Z_DATA defaults to $HOME/.z
Expand Down
8 changes: 8 additions & 0 deletions z.1
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,14 @@ A function \fB_z()\fR is defined.
.P
An alias \fB$_Z_CMD\fR='_z 2>&1' is defined. If not set, \fB$_Z_CMD\fR defaults
to \fBz\fR.
.P
In bash, \fBz\fR uses the \fBPROMPT_COMMAND\fR environment variable to maintain
its database. Specifically it prepends:
.P
\fB_z --add "$(pwd -P 2>/dev/null)" 2>/dev/null;\fR
.P
to any existing \fbPROMPT_COMMAND\fR. zsh users need to manually set
\fBprecmd()\fR as described in the installation instructions.

.SH FILES
Data is stored in \fB$_Z_DATA\fR. If not set, \fB$_Z_DATA\fR defaults to
Expand Down

0 comments on commit cf4b1af

Please sign in to comment.