X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=selector.1;h=d67955d553ce49b52132f9ccf0c4896346502c4d;hb=d21dcab62f2e81f22c0c7c721fdffbcf244ac349;hp=3b8a43341c2f26c0a959efd9bdaefe6da4322b0e;hpb=a65d22727b3540e5d3d3228f244f1cbe3e1bed0b;p=selector.git

diff --git a/selector.1 b/selector.1
index 3b8a433..d67955d 100644
--- a/selector.1
+++ b/selector.1
@@ -1,28 +1,45 @@
 .TH "SELECTOR" "1"
 .SH "NAME"
-selector - A simple shell command for dynamic pattern selection
+selector - A simple command line for dynamic pattern selection
 .SH "SYNOPSIS"
 .PP
 \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. As 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
+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.
 
 .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-i\fP" 10
+inverse the order of the lines
+.IP "\fB-z\fP" 10
+remove the time prefix from zsh history
+.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
@@ -34,9 +51,14 @@ specify the file to search into
 
 .SH "EXAMPLES"
 
-To use selector to search into your shell history:
+To use selector to search into your bash history, you can use
+
+.B selector -i -b -v -f <(history)
+
+.SH "BUGS"
 
-selector -f ${HISTFILE} -v
+Probably many. The main problem is the usage of Linux-specific ioctl()
+to put the selected line in the tty buffer.
 
 .SH "AUTHOR"
 .PP