Automatic commit
[selector.git] / selector.1
1 .TH "SELECTORcg" "1"
2 .SH "NAME"
3 selector - A simple shell command for dynamic pattern selection
4 .SH "SYNOPSIS"
5 .PP
6 \fBselector\fP [\fBoptions\fP] -f <filename>
7 .SH "DESCRIPTION"
8 .PP
9 \fBselector\fP is a simple shell command which provides a dynamic
10 string selection. A you type a list of substring separated by ';', the
11 display is updated to show only the lines containing all the said
12 substrings.
13
14 The main usage of selector is as a super shell-history. With the
15 correct option, it will inject the selected line into the virtual tty
16 input buffer, hence allowing the user to edit the line and execute it
17 as a standard command.
18
19 .SH "OPTIONS"
20 .IP "\fB-h\fP" 10
21 display help and exits
22 .IP "\fB-v\fP" 10
23 inject the selected line into the tty input buffer
24 .IP "\fB-t <color theme number>\fP" 10
25 select a color them
26 .IP "\fB-o <output filename>\fP" 10
27 write the selected line into the specified file
28 .IP "\fB-s <pattern separator>\fP" 10
29 specify the symbol to separate the substrings in the search pattern
30 .IP "\fB-l <max number of lines>\fP" 10
31 specify the maximum number of lines to consider
32 .IP "\fB-f <input filename>\fP" 10
33 specify the file to search into
34
35 .SH "EXAMPLES"
36
37 To use selector to search into your shell history:
38
39 selector -f ${HISTFILE} -v
40
41 .SH "AUTHOR"
42 .PP
43 Written by Francois Fleuret <francois@fleuret.org>. Permission is
44 granted to copy, distribute and/or modify this document under the
45 terms of the GNU GPL.