Skip to content
Browse files

Try to be clearer in installation docs

  • Loading branch information...
1 parent 8272e6f commit 31f98665208f0b478d08d9209cbeffa29d151bd9 @rupa committed Jul 11, 2012
Showing with 21 additions and 25 deletions.
  1. +5 −7 README
  2. +11 −13 z.1
  3. +5 −5 z.sh
View
12 README
@@ -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:
View
24 z.1
@@ -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
View
10 z.sh
@@ -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

0 comments on commit 31f9866

Please sign in to comment.
Something went wrong with that request. Please try again.