Merge branch 'master' of ssh://fleuret@login.idiap.ch/homes/fleuret/public/git/selector

[selector.git] / selector.1

diff --git a/selector.1 b/selector.1
index 83c9b43..81c4aa4 100644 (file)
--- a/selector.1
+++ b/selector.1
@@ -1,14 +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 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.
+\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
@@ -35,11 +39,17 @@ inject the selected line into the tty input buffer
 .IP "\fB-m\fP" 10
 force the monochrome mode
 .IP "\fB-i\fP" 10
-inverse line order
+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 display colors for the modeline and the highlighted line
+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
@@ -51,14 +61,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
 
-.B selector \-i \-v \-f ${HISTFILE}
+.B selector -d -i -b -v -f <(history)
 
 .SH "BUGS"
 
-Probably many. The main problem is the usage of Linux-specific ioctl()
-to put the selected line in the tty buffer.
+Probably many.
 
 .SH "AUTHOR"
 .PP