Moved the vt buffer injection to a separate function.
[selector.git] / selector.1
index cc9209a..91e1dc8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "SELECTORcg" "1"
+.TH "SELECTOR" "1"
 .SH "NAME"
 selector - A simple shell command for dynamic pattern selection
 .SH "SYNOPSIS"
@@ -11,18 +11,32 @@ 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.
 
-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
+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 quits.
+
+You can cancel the selection either by 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-t <color theme number>\fP" 10
-select a color them
+.IP "\fB-m\fP" 10
+force the monochrome mode
+.IP "\fB-t <color fg modeline> <color bg modeline> <color fg highlight> <color bg highlight>\fP" 10
+select a color them; each color is a positive number
 .IP "\fB-o <output filename>\fP" 10
 write the selected line into the specified file
 .IP "\fB-s <pattern separator>\fP" 10