Skip to content

Commit

Permalink
add install instructions
Browse files Browse the repository at this point in the history
closes #13
  • Loading branch information
rupa committed Jul 10, 2015
1 parent 3007042 commit 252b9f1
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,17 @@ AVAILABILITY
bash, vim


INSTALLATION
Put v somewhere in $PATH (e.g. /usr/local/bin/).
For the manual page, put v.1 somewhere in $MANPATH (e.g.
/usr/local/man/man1/).


DESCRIPTION
v uses viminfo's list of recently edited files to open one quickly no
v uses viminfo's list of recently edited files to open one quickly no
matter where you are in the filesystem.

By default, it will open the most recently edited file matching all of
By default, it will open the most recently edited file matching all of
the provided regular expressions.


Expand All @@ -38,16 +44,16 @@ EXAMPLES


NOTES
Shell variables, such as $, must be escaped if used in regular expres
Shell variables, such as $, must be escaped if used in regular expres-
sions.

Behavior
The default behavior is to open the most recent file that matches the
The default behavior is to open the most recent file that matches the
search terms, even if there are multiple matches.

You may find it useful to alias vl='v -l'. When there are multiple
matches, this will prompt for a choice, rather than editing the first
match. The author is still not sure which behavior should be the
You may find it useful to alias vl='v -l'. When there are multiple
matches, this will prompt for a choice, rather than editing the first
match. The author is still not sure which behavior should be the
default, and has chosen one provisionally.


Expand Down
6 changes: 6 additions & 0 deletions v.1
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ v [\-a] [\-l] [\-[0\-9]] [\-\-debug] [\-\-help] [regex1 regex2 ... regexn]
.SH AVAILABILITY
bash, vim

.SH INSTALLATION
Put \fBv\fR somewhere in $PATH (e.g. /usr/local/bin/).
.br
For the manual page, put \fBv.1\fR somewhere in $MANPATH (e.g.
/usr/local/man/man1/).

.SH DESCRIPTION
\fBv\fR uses viminfo's list of recently edited files to open one quickly no
matter where you are in the filesystem.
Expand Down

0 comments on commit 252b9f1

Please sign in to comment.