Added the ^I keystroke to switch the case-sensitivity. Added a check
[selector.git] / selector.1
index 58b6757..c349ace 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
@@ -12,16 +12,20 @@ in real time to show only the lines containing all the said strings,
 or matching the regexp.
 
 The ^R key switches between the standard multi-substring mode and the
-regexp mode.
+regexp mode, and ^I between the case-sensitive and case-insensitive
+modes.
 
 The main usage of selector is as an efficient search in the shell
 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
@@ -49,6 +53,8 @@ remove duplicated lines
 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
@@ -62,17 +68,18 @@ 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 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