Try to be clearer in installation docs

This commit is contained in:
rupa committed 2012-07-11 17:07:54 -04:00
1 parent 8272e6ff7f
commit 31f9866520
3 files changed
+21 -25

No files matched your search

+5 -7
View File
@@ -39,13 +39,6 @@ EXAMPLES
NOTES
Installation:
Optionally:
Set $_Z_CMD in .bashrc/.zshrc to change the command (default z).
Set $_Z_DATA to change the datafile (default $HOME/.z).
Set $_Z_NO_RESOLVE_SYMLINKS to prevent symlink resolution.
Set $_Z_NO_PROMPT_COMMAND if you're handling PROMPT_COMMAND yourself.
(These settings should go before the lines below.)
Put something like this in your $HOME/.bashrc:
. /path/to/z.sh
@@ -62,6 +55,11 @@ NOTES
PROFIT!!
Optionally:
Set $_Z_CMD in .bashrc/.zshrc to change the command (default z).
Set $_Z_DATA to change the datafile (default $HOME/.z).
Set $_Z_NO_RESOLVE_SYMLINKS to prevent symlink resolution.
Set $_Z_NO_PROMPT_COMMAND if you're handling PROMPT_COMMAND yourself.
(These settings should go before the lines added above.)
Install the provided man page z.1 somewhere like /usr/local/man/man1.
Aging:
+11 -13
View File
@@ -39,17 +39,6 @@ directory that matches ALL of the regexes given on the command line.
\fBInstallation:\fR
.P
Optionally:
Set \fB$_Z_CMD\fR in .bashrc/.zshrc to change the command (default \fBz\fR).
.br
Set \fB$_Z_DATA\fR to change the datafile (default \fB$HOME/.z\fR).
.br
Set \fB$_Z_NO_RESOLVE_SYMLINKS\fR to prevent symlink resolution.
.br
Set \fB$_Z_NO_PROMPT_COMMAND\fR if you're handling \fBPROMPT_COMMAND\fR yourself.
.br
(These settings should go before the lines below.)
.P
Put something like this in your \fB$HOME/.bashrc\fR:
.P
\fB. /path/to/z.sh\fR
@@ -66,9 +55,18 @@ Put something like this in your \fB$HOME/.zshrc\fR:
PROFIT!!
.P
Optionally:
Install the provided man page \fBz.1\fR somewhere like \fB/usr/local/man/man1\fB.
Set \fB$_Z_CMD\fR in .bashrc/.zshrc to change the command (default \fBz\fR).
.br
Set \fB$_Z_DATA\fR to change the datafile (default \fB$HOME/.z\fR).
.br
Set \fB$_Z_NO_RESOLVE_SYMLINKS\fR to prevent symlink resolution.
.br
Set \fB$_Z_NO_PROMPT_COMMAND\fR if you're handling \fBPROMPT_COMMAND\fR yourself.
.br
(These settings should go before the lines added above.)
.br
Install the provided man page \fBz.1\fR somewhere like \fB/usr/local/man/man1\fB.
.P
\fBAging:\fR
.P
The rank of directories maintained by \fBz\fR undergoes aging based on a simple
+5 -5
View File
@@ -3,11 +3,6 @@
# maintains a jump-list of the directories you actually use
#
# INSTALL:
# * optionally:
# set $_Z_CMD in .bashrc/.zshrc to change the command (default z).
# set $_Z_DATA in .bashrc/.zshrc to change the datafile (default ~/.z).
# set $_Z_NO_RESOLVE_SYMLINKS to prevent symlink resolution.
# set $_Z_NO_PROMPT_COMMAND if you're handling PROMPT_COMMAND yourself.
# * put something like this in your .bashrc:
# . /path/to/z.sh
# * put something like this in your .zshrc:
@@ -17,6 +12,11 @@
# }
# * cd around for a while to build up the db
# * PROFIT!!
# * optionally:
# set $_Z_CMD in .bashrc/.zshrc to change the command (default z).
# set $_Z_DATA in .bashrc/.zshrc to change the datafile (default ~/.z).
# set $_Z_NO_RESOLVE_SYMLINKS to prevent symlink resolution.
# set $_Z_NO_PROMPT_COMMAND if you're handling PROMPT_COMMAND yourself.
#
# USE:
# * z foo # cd to most frecent dir matching foo