selector.1

   1 .TH "SELECTOR" "1.1.7" "July 2012" "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 interactive real-time
  18 pattern matching. It reads the content of the specified files, and as
  19 the 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 efficiently in the
  24 shell history, for which it is substantially better than the standard
  25 readline ^R binding. With the -v option, it injects the selected line
  26 into the tty input buffer, hence allowing the user to edit the line
  27 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 "USING SELECTOR IN BASH"
  39
  40 The selector command comes with a shell script for bash. If you add
  41
  42 .RS
  43 .EX
  44 source bash-selector.sh --hist --cd
  45 .EE
  46 .RE
  47
  48 in your \fB~/.bashrc\fR, it will remap M-r to the smart history search,
  49 and redefine cd so that M-c provides a smart cd history.
  50
  51 .SH "KEY BINDINGS"
  52
  53 Keys corresponding to ASCII codes between " " and "~" add a character
  54 to the pattern string. The Backspace key, "^H" and "^?" delete the
  55 character immediately on the left of the cursor, while the Delete key
  56 and "^D" delete the character at cursor location.
  57
  58 The Left and Right cursor keys move the editing cursor
  59 accordingly. The Up and Down cursor keys move the selected line one
  60 entry at a time, and PageUp and PageDown move it by ten entries. The
  61 Home and End key move to the top and the bottom of the list
  62 respectively. The return key selects the current line and exits.
  63
  64 The keys "^A", "^E", "^U", and "^K" do somehow what they do in
  65 readline, and you can exit selector without doing anything by either
  66 interrupting the command with "^C" or by typing "^G" or the Escape
  67 key.
  68
  69 The key "^R" switches between the multi-substring and the regexp
  70 selection mode, and "^I" between the case-sensitive and
  71 case-insensitive modes.
  72
  73 .SH "OPTIONS"
  74 .TP
  75 \fB-h\fR, \fB--help\fR
  76 display help and exit
  77 .TP
  78 \fB-m\fR, \fB--monochrome\fR
  79 force the monochrome mode
  80 .TP
  81 \fB-i\fR, \fB--revert-order\fR
  82 revert the order of the lines
  83 .TP
  84 \fB-b\fR, \fB--remove-bash-prefix\fR
  85 remove the numeric prefix from bash history
  86 .TP
  87 \fB-z\fR, \fB--remove-zsh-prefix\fR
  88 remove the time prefix from zsh history
  89 .TP
  90 \fB-d\fR, \fB--remove-duplicates\fR
  91 remove duplicated lines (note that you can have two different lines
  92 with the same visible part if you use the -x option)
  93 .TP
  94 \fB-e\fR, \fB--regexp\fR
  95 start in regexp mode
  96 .TP
  97 \fB-a\fR, \fB--case-sensitive\fR
  98 start in case-sensitive mode
  99 .TP
 100 \fB-j\fR, \fB--show-long-lines\fR
 101 print a long-line indicator at the end of truncated lines
 102 .TP
 103 \fB-y\fR, \fB--show-hits\fR
 104 highlight the part(s) of each line which match the substrings or regexp
 105 .TP
 106 \fB-u\fR, \fB--upper-case-makes-case-sensitive\fR
 107 using an upper case in the matching string makes the matching
 108 case-sensitive
 109 .TP
 110 \fB-q\fR, \fB--no-beep\fR
 111 make a flash instead of a beep when there is an edition error
 112 .TP
 113 \fB--\fR
 114 state that all following arguments are filenames
 115 .TP
 116 \fB--bash\fR
 117 standard setting for bash history search, same as
 118
 119 -b -i -d -v -w -l ${HISTSIZE}
 120 .TP
 121 \fB-t \fI<title>\fR, \fB--title \fI<title>\fR
 122 add a title in the modeline
 123 .TP
 124 \fB-r \fI<pattern>\fR, \fB--pattern \fI<pattern>\fR
 125 set a pattern
 126 .TP
 127 \fB-c \fI<colors>\fR, \fB--colors \fI<colors>\fR
 128 select the modeline and highlight color numbers with a color list of
 129 the form
 130
 131 \fI<fg_modeline>,<bg_modeline>,<fg_highlight>,<bg_highlight>\fR
 132 .TP
 133 \fB-v\fR, \fB--inject-in-tty\fR
 134 inject the selected line into the tty input buffer
 135 .TP
 136 \fB-w\fR, \fB--add-control-qs\fR
 137 add ^Q between characters during tty injection to quote control characters
 138 .TP
 139 \fB-o \fI<filename>\fR, \fB--output-file \fI<filename>\fR
 140 write the selected line into the specified file
 141 .TP
 142 \fB-s \fI<separator>\fR, \fB--pattern-separator \fI<separator>\fR
 143 specify the character to separate the substrings in the search pattern
 144 .TP
 145 \fB-x \fI<separator>\fR, \fB--label-separator \fI<separator>\fR
 146 specify the character to separate what to show to the user during the
 147 selection from the line to return. If the provided separator is "\\n",
 148 the lines to show to the user alternate with the lines to return
 149 .TP
 150 \fB-l \fI<number>\fR, \fB--number-of-lines \fI<number>\fR
 151 specify the maximum number of lines to take into account
 152
 153 .SH "EXAMPLES"
 154
 155 To use selector to search into your bash history
 156
 157 .RS
 158 .EX
 159 selector -q --bash <(history)
 160 .EE
 161 .RE
 162
 163 To show a list of directories and insert a cd command to the selected
 164 one
 165
 166 .RS
 167 .EX
 168 selector -v -x \(dq\\n\(dq <(find . -type d | awk \(aq{print $0\(dq\\ncd \(dq$0}\(aq)
 169 .EE
 170 .RE
 171
 172 To select a line in a long text and returns the line number
 173
 174 .RS
 175 .EX
 176 selector -v -x \(dq\\n\(dq <(awk < something.txt \(aq{ print $0\(dq\\n\(dqNR }\(aq)
 177 .EE
 178 .RE
 179
 180 .SH "BUGS"
 181
 182 There are modeline display problems if the pattern is too long. This
 183 program does not handle multibyte characters.
 184
 185 The \fB-v\fR option does not work on FreeBSD 8.0 since the TIOCSTI
 186 ioctl request is broken.
 187
 188 .SH "AUTHOR"
 189
 190 Written by Francois Fleuret <francois@fleuret.org> and distributed
 191 under the terms of the GNU General Public License version 3 as
 192 published by the Free Software Foundation. This is free software: you
 193 are free to change and redistribute it. There is NO WARRANTY, to the
 194 extent permitted by law.