Cosmetics.
[selector.git] / selector.1
index 03b1e03..0af244d 100644 (file)
@@ -1,15 +1,18 @@
 .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 ';' or a regexp, the display is updated
+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.
 
 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,34 +26,48 @@ 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.
+The ^U key erases the current pattern, and you can cancel the
+selection by either 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-m\fP" 10
 force the monochrome mode
-.IP "\fB-t <color theme number>\fP" 10
-select a color them
+.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-d\fP" 10
+remove duplicated lines
+.IP "\fB-e\fP" 10
+start with the regexp mode activated
+.IP "\fB-c <fg modeline> <bg modeline> <fg highlight> <bg highlight>\fP" 10
+select the modeline and highlight color numbers
+.IP "\fB-v\fP" 10
+inject the selected line into the tty input buffer
 .IP "\fB-o <output filename>\fP" 10
 write the selected line into the specified file
 .IP "\fB-s <pattern separator>\fP" 10
 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 consider
+specify the maximum number of lines to take into account
 .IP "\fB-f <input filename>\fP" 10
 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 -d -i -b -v -f <(history)
+
+.SH "BUGS"
 
-selector -f ${HISTFILE} -v
+Probably many.
 
 .SH "AUTHOR"
 .PP