selector.1

   1 .TH "SELECTOR" 1 "" "Francois Fleuret"
   2 .SH "NAME"
   3 selector \- A simple command line utility for dynamic pattern selection
   4 .SH "SYNOPSIS"
   5 .PP
   6 \fBselector\fP [\fBoptions\fP] [<filename1> [<filename2> ...]]
   7 .SH "DESCRIPTION"
   8 .PP
   9 \fBselector\fP is a command line utility for dynamic string
  10 selection. As you type a list of strings separated by ";" or a regexp,
  11 the display is updated in real time to show only the lines containing
  12 all the said strings, or matching the regexp.
  13
  14 The main usage of selector is as an efficient search in the shell
  15 command history. With the correct option, it will inject the selected
  16 line into the virtual tty input buffer, hence allowing the user to
  17 edit the line and execute it as a standard command.
  18
  19 Selector is also a good tool to test regexps, or a way to display
  20 menus. The -x option allows to specify a label delimiter: the part of
  21 each line before that character will appear during the selection, and
  22 the part after that character will be returned.
  23
  24 .SH "KEYS"
  25 .PP
  26
  27 Keys corresponding to ASCII codes between " " and "~" add a character
  28 to the pattern string. The Backspace key, "^H" and "^?" delete the
  29 character immediately on the left of the cursor, while the Delete key
  30 and "^D" delete the character at cursor location.
  31
  32 The Up and Down cursor keys move the selected line accordingly, and
  33 PageUp and PageDown move by ten lines. The Home and End key move to
  34 the top and the bottom of the list respectively. The return key
  35 selects the current line and exits.
  36
  37 The shortcuts "^A", "^E", "^U", and "^K" do somehow what they do in
  38 readline, and you can exit selector without doing anything by either
  39 interrupting the command with "^C" or by typing "^G" or the Escape
  40 key.
  41
  42 The "^R" key switches between the standard multi-substring mode and
  43 the regexp mode, and "^I" between the case-sensitive and
  44 case-insensitive modes.
  45
  46 .SH "OPTIONS"
  47 .IP "\fB-h\fP" 10
  48 display help and exits
  49 .IP "\fB-m\fP" 10
  50 force the monochrome mode
  51 .IP "\fB-i\fP" 10
  52 invert the order of the lines
  53 .IP "\fB-b\fP" 10
  54 remove the numeric prefix from bash history
  55 .IP "\fB-z\fP" 10
  56 remove the time prefix from zsh history
  57 .IP "\fB-d\fP" 10
  58 remove duplicated lines (note that you can have two different lines
  59 with the same visible part if you use the -x option)
  60 .IP "\fB-e\fP" 10
  61 start in the regexp mode
  62 .IP "\fB-a\fP" 10
  63 start in the case-sensitive mode
  64 .IP "\fB-q\fP" 10
  65 make a flash instead of a beep when there is an edition error
  66 .IP "\fB--\fP" 10
  67 state that all following arguments are filenames
  68 .IP "\fB-t <title>\fP" 10
  69 add a title in the modeline
  70 .IP "\fB-c <fg modeline> <bg modeline> <fg highlight> <bg highlight>\fP" 10
  71 select the modeline and highlight color numbers
  72 .IP "\fB-v\fP" 10
  73 inject the selected line into the tty input buffer
  74 .IP "\fB-w\fP" 10
  75 add ^Q between characters during tty injection to quote control characters
  76 .IP "\fB-o <output filename>\fP" 10
  77 write the selected line into the specified file
  78 .IP "\fB-s <pattern separator>\fP" 10
  79 specify the symbol to separate the substrings in the search pattern
  80 .IP "\fB-x <label separator>\fP" 10
  81 specify the symbol to separate what to show to the user during the
  82 selection from the line to return
  83 .IP "\fB-l <max number of lines>\fP" 10
  84 specify the maximum number of lines to take into account
  85 .IP "\fB-f <input filename>\fP" 10
  86 specify a file to search into (option kept for compatibility reasons)
  87
  88 .SH "EXAMPLE"
  89
  90 To use selector to search into your bash history, you can use
  91
  92 .B selector -q -b -i -d -v -w -l ${HISTSIZE} <(history)
  93
  94 .SH "KEY-BINDING IN BASH"
  95
  96 You can associate selector to a single key in bash by using the
  97 command 'bind' in your bash initialization file. For instance, to
  98 associate it to M-r (that is, the "Alt" and "r" key pressed together),
  99 just add something like
 100
 101 bind '"\\C-[r":"\\C-a\\C-kselector -q -b -i -d -v -w -l ${HISTSIZE} <(history)\\C-m"'
 102
 103 in your ~/.bashrc.
 104
 105 Note that depending on the configuration of your system, the sequence
 106 associated to the M-r key, which is here "C-[r", may differ. To figure
 107 it out, simply press C-q followed by M-r in the console.
 108
 109 The control character "C-a" puts the cursor to the mostleft location,
 110 "C-k" erases the current content of the readline buffer, and "C-m"
 111 simulates the enter key.
 112
 113 .SH "BUGS"
 114
 115 There are modeline display problems if the pattern is too long. This
 116 program does not handle multibyte characters.
 117
 118 .SH "AUTHOR"
 119 .PP
 120 Written by Francois Fleuret <francois@fleuret.org>, and distributed
 121 under a Creative Commons Attribution-Share Alike 3.0 License.