selector.1

   1 .TH "SELECTOR" 1 "July 2009" "Francois Fleuret" "User Commands"
   2
   3 \" This man page was written by Francois Fleuret <francois@fleuret.org>
   4 \" and is distributed under a Creative Commons Attribution-Share Alike
   5 \" 3.0 License.
   6
   7 .SH "NAME"
   8
   9 selector \- A simple command line utility for dynamic pattern selection
  10
  11 .SH "SYNOPSIS"
  12
  13 \fBselector\fP [\fIoptions\fR] [\fI<filename1>\fR [\fI<filename2>\fR ...]]
  14
  15 .SH "DESCRIPTION"
  16
  17 \fBselector\fP is a command line utility for dynamic string
  18 selection. It reads the content of the specified files, and as the
  19 user types a list of strings separated by ";" (or a regexp), the
  20 display is updated in real time to show only the lines containing all
  21 the said strings (or matching the regexp).
  22
  23 This command was mainly designed as a way to search in the shell
  24 history, for which it is substantially more efficient than the
  25 standard readline ^R binding. With the -v option, it injects the
  26 selected line into the tty input buffer, hence allowing the user to
  27 edit the line and execute it as a standard command.
  28
  29 Selector is also a handy tool to test regexps, or to display menus
  30 with many possible choices. For the latter, the -x option allows to
  31 specify a label delimiter: the part of each line before that character
  32 will appear during the selection, but only the part after that
  33 character will be returned.
  34
  35 Note that because this is an interactive command, the standard input
  36 can not be used as one of the input files.
  37
  38 .SH "KEY BINDINGS"
  39
  40 Keys corresponding to ASCII codes between " " and "~" add a character
  41 to the pattern string. The Backspace key, "^H" and "^?" delete the
  42 character immediately on the left of the cursor, while the Delete key
  43 and "^D" delete the character at cursor location.
  44
  45 The Left and Right cursor keys move the editing cursor
  46 accordingly. The Up and Down cursor keys move the selected line one
  47 entry at a time, and PageUp and PageDown move it by ten entries. The
  48 Home and End key move to the top and the bottom of the list
  49 respectively. The return key selects the current line and exits.
  50
  51 The keys "^A", "^E", "^U", and "^K" do somehow what they do in
  52 readline, and you can exit selector without doing anything by either
  53 interrupting the command with "^C" or by typing "^G" or the Escape
  54 key.
  55
  56 The key "^R" switches between the multi-substring and the regexp
  57 selection mode, and "^I" between the case-sensitive and
  58 case-insensitive modes.
  59
  60 .SH "OPTIONS"
  61 .TP
  62 \fB-h\fR
  63 display help and exit
  64 .TP
  65 \fB-m\fR
  66 force the monochrome mode
  67 .TP
  68 \fB-i\fR
  69 revert the order of the lines
  70 .TP
  71 \fB-b\fR
  72 remove the numeric prefix from bash history
  73 .TP
  74 \fB-z\fR
  75 remove the time prefix from zsh history
  76 .TP
  77 \fB-d\fR
  78 remove duplicated lines (note that you can have two different lines
  79 with the same visible part if you use the -x option)
  80 .TP
  81 \fB-e\fR
  82 start in regexp mode
  83 .TP
  84 \fB-a\fR
  85 start in case sensitive mode
  86 .TP
  87 \fB-q\fR
  88 make a flash instead of a beep when there is an edition error
  89 .TP
  90 \fB--\fR
  91 state that all following arguments are filenames
  92 .TP
  93 \fB-t \fI<title>\fR
  94 add a title in the modeline
  95 .TP
  96 \fB-c \fI<fg_modeline> <bg_modeline> <fg_highlight> <bg_highlight>\fR
  97 select the modeline and highlight color numbers
  98 .TP
  99 \fB-v\fR
 100 inject the selected line into the tty input buffer
 101 .TP
 102 \fB-w\fR
 103 add ^Q between characters during tty injection to quote control characters
 104 .TP
 105 \fB-o \fI<output_filename>\fR
 106 write the selected line into the specified file
 107 .TP
 108 \fB-s \fI<pattern_separator>\fR
 109 specify the symbol to separate the substrings in the search pattern
 110 .TP
 111 \fB-x \fI<label_separator>\fR
 112 specify the symbol to separate what to show to the user during the
 113 selection from the line to return
 114 .TP
 115 \fB-l \fI<max_number_of_lines>\fR
 116 specify the maximum number of lines to take into account
 117 .TP
 118 \fB-f \fI<input_filename>\fR
 119 specify a file to search into (option kept for compatibility reasons)
 120
 121 .SH "EXAMPLES"
 122
 123 To use selector to search into your bash history
 124
 125 .B selector -q -b -i -d -v -w -l ${HISTSIZE} <(history)
 126
 127 To show a list of directories and insert a cd command to the selected
 128 one (using @ as a separator)
 129
 130 .B selector -v -x @ <(find . -type d | awk \(aq{print $0\(dq@cd \(dq$0}\(aq)
 131
 132 To select a line in a long text and returns the line number (this
 133 command uses ^A as a separator, hence there will be problems if the
 134 file contains ^A)
 135
 136 .B selector -v -x ^A <(awk < something.txt \(aq{ print $0\(dq^A\(dqNR }\(aq)
 137
 138 .SH "KEYBINDING IN BASH"
 139
 140 You can associate selector to a single key in bash by using the
 141 command 'bind' in your bash initialization file. For instance, to
 142 associate it to M-r (that is, the "Alt" and "r" key pressed together),
 143 just add something like
 144
 145 bind \(aq\(dq\\C-[r\(dq:\(dq\\C-a\\C-kselector -q -b -i -d -v -w -l ${HISTSIZE} <(history)\\C-m\(dq\(aq
 146
 147 in your
 148 .IR ~/.bashrc .
 149
 150 This bindings uses the control character ^A to put the cursor to the
 151 mostleft location and ^K to erase the current content of the readline
 152 buffer, and it simulates the enter key with ^M.
 153
 154 Note that depending on the configuration of your system, the sequence
 155 associated to the M-r key, which is here "C-[r", may differ. To figure
 156 it out, simply press C-q followed by M-r in the console.
 157
 158 .SH "BUGS"
 159
 160 There are modeline display problems if the pattern is too long. This
 161 program does not handle multibyte characters.
 162
 163 .SH "AUTHOR"
 164
 165 Written by Francois Fleuret <francois@fleuret.org> and distributed
 166 under the terms of the GNU General Public License version 3 as
 167 published by the Free Software Foundation. This is free software: you
 168 are free to change and redistribute it. There is NO WARRANTY, to the
 169 extent permitted by law.