Cosmetics.
[selector.git] / selector.1
index 81c4aa4..10cf637 100644 (file)
@@ -3,7 +3,7 @@
 selector - A simple command line for dynamic pattern selection
 .SH "SYNOPSIS"
 .PP
-\fBselector\fP [\fBoptions\fP] -f <filename>
+\fBselector\fP [\fBoptions\fP] [<filename1> [<filename2> ...]]
 .SH "DESCRIPTION"
 .PP
 \fBselector\fP is a command line dynamic string selection. As you type
@@ -19,23 +19,25 @@ command history. With the correct option, it will inject the selected
 line into the virtual tty input buffer, hence allowing the user to
 edit the line and execute it as a standard command.
 
+Selector is also a good tool to test regexp quickly.
+
 Keys corresponding to ASCII codes between ' ' and '~' add a character
-to the pattern string. The Delete key, Backspace key, ^D and ^H delete
-one character from the pattern string.
+to the pattern string. The Backspace key, ^H and ^? delete the
+character on the left of the cursor, while Delete key and ^D delete
+the character at cursor location.
 
 The Up and Down cursor keys move the selected line accordingly, and
 PageUp and PageDown move by ten lines. The Home and End key move to
 the top and the bottom of the list respectively. The return key
 selects the current line and exits.
 
-You can cancel the selection either by interrupting the command with
-^C or by typing ^G.
+The shortcuts ^A, ^E, ^U, and ^K do somehow what they do in readline,
+and you can cancel the selection by either interrupting the command
+with ^C or by typing ^G.
 
 .SH "OPTIONS"
 .IP "\fB-h\fP" 10
 display help and exits
-.IP "\fB-v\fP" 10
-inject the selected line into the tty input buffer
 .IP "\fB-m\fP" 10
 force the monochrome mode
 .IP "\fB-i\fP" 10
@@ -48,26 +50,35 @@ remove the time prefix from zsh history
 remove duplicated lines
 .IP "\fB-e\fP" 10
 start with the regexp mode activated
+.IP "\fB-a\fP" 10
+make the matching case sensitive
+.IP "\fB--\fP" 10
+state that all following arguments are filenames
+.IP "\fB-t <title>\fP" 10
+add a title in the modeline
 .IP "\fB-c <fg modeline> <bg modeline> <fg highlight> <bg highlight>\fP" 10
-select the modline and highlight color numbers
+select the modeline and highlight color numbers
+.IP "\fB-v\fP" 10
+inject the selected line into the tty input buffer
 .IP "\fB-o <output filename>\fP" 10
 write the selected line into the specified file
 .IP "\fB-s <pattern separator>\fP" 10
 specify the symbol to separate the substrings in the search pattern
 .IP "\fB-l <max number of lines>\fP" 10
-specify the maximum number of lines to consider
+specify the maximum number of lines to take into account
 .IP "\fB-f <input filename>\fP" 10
-specify the file to search into
+specify a file to search into (option kept for compatibility reasons)
 
 .SH "EXAMPLES"
 
 To use selector to search into your bash history, you can use
 
-.B selector -d -i -b -v -f <(history)
+.B selector -d -i -b -v <(history)
 
 .SH "BUGS"
 
-Probably many.
+Modeline display problems if the pattern is too long. Probably many
+others.
 
 .SH "AUTHOR"
 .PP