.TH "SELECTOR" "1"
.SH "NAME"
selector - A simple shell command 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.

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
the PageUp and PageDown move by ten lines. The Home and End key moves
to the top and the bottom of the list respectively. The return key
select the current line and quit.

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-m\fP" 10
force the monochrome mode
.IP "\fB-t <color theme number>\fP" 10
select a color them
.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
.IP "\fB-f <input filename>\fP" 10
specify the file to search into

.SH "EXAMPLES"

To use selector to search into your shell history:

selector -f ${HISTFILE} -v

.SH "AUTHOR"
.PP
Written by Francois Fleuret <francois@fleuret.org>. Permission is
granted to copy, distribute and/or modify this document under the
terms of the GNU GPL.