Changed the color option description to make clear it takes numbers as
[selector.git] / selector.1
index 91e1dc8..c1762c1 100644 (file)
@@ -1,15 +1,14 @@
 .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 an efficient search in the shell
 command history. With the correct option, it will inject the selected
@@ -23,7 +22,7 @@ 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.
+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,16 @@ 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 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-i\fP" 10
+inverse the order of the lines
+.IP "\fB-b\fP" 10
+remove the numeric prefix from bash history
+.IP "\fB-z\fP" 10
+remove the time prefix from zsh history
+.IP "\fB-r\fP" 10
+remove duplicated lines
+.IP "\fB-c <fg modeline> <bg modeline> <fg highlight> <bg highlight>\fP" 10
+select the modline and highlight color numbers
 .IP "\fB-o <output filename>\fP" 10
 write the selected line into the specified file
 .IP "\fB-s <pattern separator>\fP" 10
@@ -48,9 +55,13 @@ 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
 
-selector -f ${HISTFILE} -v
+.B selector -r -i -b -v -f <(history)
+
+.SH "BUGS"
+
+Probably many.
 
 .SH "AUTHOR"
 .PP