Permalink
Browse files

document reliance on $PROMPT_COMMAND

  • Loading branch information...
1 parent 7634453 commit cf4b1afd71101a3e4fe5fe04e4dfcf337f38fa07 @rupa committed Aug 23, 2011
Showing with 16 additions and 0 deletions.
  1. +8 −0 README
  2. +8 −0 z.1
View
8 README
@@ -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
View
8 z.1
@@ -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

0 comments on commit cf4b1af

Please sign in to comment.