Automatic commit

[selector.git] / selector.1

diff --git a/selector.1 b/selector.1
index 8963977..4d3c350 100644 (file)
--- a/selector.1
+++ b/selector.1
@@ -6,24 +6,23 @@ selector - A simple shell command for dynamic pattern selection
 \fBselector\fP [\fBoptions\fP] -f <filename>
 .SH "DESCRIPTION"
 .PP
-\fBselector\fP is a simple shell command which provides a dynamic
-string selection. A you type a list of substring separated by ';', the
-display is updated to show only the lines containing all the said
-substrings.
+\fBselector\fP is a command line dynamic string selection. A you type
+a list of strings separated by ';', the display is updated in real
+time to show only the lines containing all the said strings.
 
-The main usage of selector is as a super shell-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.
+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.
 
 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.
 
-The up and down cursor keys move the selected line accordingly, and
-the PageUp and PageDown move by ten lines. The Home and End key moves
-to the top and the bottom of the list respectively. The return key
-select the current line and quit.
+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.
@@ -35,8 +34,8 @@ display help and exits
 inject the selected line into the tty input buffer
 .IP "\fB-m\fP" 10
 force the monochrome mode
-.IP "\fB-t <color theme number>\fP" 10
-select a color them
+.IP "\fB-c <fg modeline> <bg modeline> <fg highlight> <bg highlight>\fP" 10
+select the display colors for the modeline and the highlighted line
 .IP "\fB-o <output filename>\fP" 10
 write the selected line into the specified file
 .IP "\fB-s <pattern separator>\fP" 10
@@ -52,6 +51,11 @@ To use selector to search into your shell history:
 
 selector -f ${HISTFILE} -v
 
+.SH "BUGS"
+
+Probably many. The main problem is the usage of Linux-specific ioctl()
+to put the selected line in the tty buffer.
+
 .SH "AUTHOR"
 .PP
 Written by Francois Fleuret <francois@fleuret.org>. Permission is