| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,85 @@ |
| 1 |
+.TH FZY 1 "2014-09-11" "fzy 0.1beta" |
|
| 2 |
+.SH NAME |
|
| 3 |
+fzy \- A fuzzy text selector menu for the terminal. |
|
| 4 |
+.SH SYNOPSIS |
|
| 5 |
+.B fzy |
|
| 6 |
+.IR [OPTION]... |
|
| 7 |
+.SH DESCRIPTION |
|
| 8 |
+.B fzy is a fuzzy text selector/file finder for the terminal using a search |
|
| 9 |
+similar to that of TextMate or CmdT. |
|
| 10 |
+ |
|
| 11 |
+fzy reads a list of newline-separated items from stdin to be displayed as a |
|
| 12 |
+menu in the terminal. |
|
| 13 |
+Upon pressing ENTER, the currently selected item is printed to stdout. |
|
| 14 |
+ |
|
| 15 |
+Entering text narrows the items using fuzzy matching. Results are sorted using |
|
| 16 |
+heuristics for the best match. |
|
| 17 |
+ |
|
| 18 |
+.SH OPTIONS |
|
| 19 |
+.TP |
|
| 20 |
+.BR \-l ", " \-\-lines =\fILINES\fR |
|
| 21 |
+How many lines of items to display. If unspecified, defaults to 10 lines. |
|
| 22 |
+. |
|
| 23 |
+.TP |
|
| 24 |
+.BR \-s ", " \-\-show-scores |
|
| 25 |
+Show the scores for each item. |
|
| 26 |
+. |
|
| 27 |
+.TP |
|
| 28 |
+.BR \-t ", " \-\-tty =\fITTY\fR |
|
| 29 |
+Use TTY instead of the default tty device (/dev/tty). |
|
| 30 |
+. |
|
| 31 |
+.TP |
|
| 32 |
+.BR \-e ", " \-\-show-matches =\fIQUERY\fR |
|
| 33 |
+Non-interactive mode. Print the matches in sorted order for QUERY to stdout. |
|
| 34 |
+. |
|
| 35 |
+.TP |
|
| 36 |
+.BR \-h ", " \-\-help |
|
| 37 |
+Usage help. |
|
| 38 |
+. |
|
| 39 |
+.TP |
|
| 40 |
+.BR \-v ", " \-\-version |
|
| 41 |
+Usage help. |
|
| 42 |
+. |
|
| 43 |
+.SH KEYS |
|
| 44 |
+. |
|
| 45 |
+.TP |
|
| 46 |
+.BR "ENTER" |
|
| 47 |
+Print the selected item to stdout and exit |
|
| 48 |
+.TP |
|
| 49 |
+.BR "Up Arrow, Ctrl+p" |
|
| 50 |
+Select the previous item |
|
| 51 |
+.TP |
|
| 52 |
+.BR "Down Arrow, Ctrl+n" |
|
| 53 |
+Select the next item |
|
| 54 |
+.TP |
|
| 55 |
+Tab |
|
| 56 |
+Replace the current search string with the selected item |
|
| 57 |
+.TP |
|
| 58 |
+.BR "Backspace, Ctrl+h" |
|
| 59 |
+Delete the character before the cursor |
|
| 60 |
+.TP |
|
| 61 |
+.BR Ctrl+w |
|
| 62 |
+Delete the word before the cursor |
|
| 63 |
+.TP |
|
| 64 |
+.BR Ctrl+u |
|
| 65 |
+Delete the entire line |
|
| 66 |
+. |
|
| 67 |
+.SH USAGE EXAMPLES |
|
| 68 |
+. |
|
| 69 |
+.TP |
|
| 70 |
+.BR "ls | fzy" |
|
| 71 |
+Present a menu of items in the current directory |
|
| 72 |
+.TP |
|
| 73 |
+.BR "ls | fzy -l 25" |
|
| 74 |
+Same as above, but show 25 lines of items |
|
| 75 |
+.TP |
|
| 76 |
+.BR "vi $(find -type f | fzy)" |
|
| 77 |
+List files under the current directory and open the one selected in vi. |
|
| 78 |
+.TP |
|
| 79 |
+.BR "cd $(find -type d | fzy)" |
|
| 80 |
+Present all directories under current path, and change to the one selected. |
|
| 81 |
+.TP |
|
| 82 |
+.BR "git checkout $(git branch | cut -c 3- | fzy)" |
|
| 83 |
+Same as above, but switching git branches. |
|
| 84 |
+.SH AUTHOR |
|
| 85 |
+John Hawthorn <john.hawthorn@gmail.com> |
git.rcrnstn.net