-.TH "SELECTOR" 1 "July 2009" "Francois Fleuret" "User Commands"
+.TH "SELECTOR" "1.1.8" "February 2013" "Francois Fleuret" "User Commands"
\" This man page was written by Francois Fleuret <francois@fleuret.org>
\" and is distributed under a Creative Commons Attribution-Share Alike
Selector is also a handy tool to test regexps, or to display menus
with many possible choices. For the latter, the -x option allows to
-specify a label delimiter: the part of each line before that character
-will appear during the selection, but only the part after that
-character will be returned.
+show different strings than the ones returned.
Note that because this is an interactive command, the standard input
-can not be used as one of the input files.
+cannot be used as one of the input files.
+
+.SH "USING SELECTOR IN BASH"
+
+The selector command comes with a shell script for bash. If you add
+
+.P
+.nf
+.B source bash-selector.sh --hist --cd
+
+.fi
+in your \fB~/.bashrc\fR, it will remap M-r to the smart history search,
+and redefine \fBcd\fR so that M-c provides a smart cd history.
+
+This script relies on readline being configured with the default
+emacs-style key bindings. You may have to hack a bit if you want to
+use it with the vi-style mode.
.SH "KEY BINDINGS"
start in regexp mode
.TP
\fB-a\fR, \fB--case-sensitive\fR
-start in case sensitive mode
+start in case-sensitive mode
+.TP
+\fB-j\fR, \fB--show-long-lines\fR
+print a long-line indicator at the end of truncated lines
+.TP
+\fB-y\fR, \fB--show-hits\fR
+highlight the part(s) of each line which match(es) the substrings or regexp
+.TP
+\fB-u\fR, \fB--upper-case-makes-case-sensitive\fR
+using an upper case in the matching string makes the matching
+case-sensitive
.TP
\fB-q\fR, \fB--no-beep\fR
make a flash instead of a beep when there is an edition error
.TP
-\fB--\fR, \fB--rest-are-files\fR
+\fB--\fR
state that all following arguments are filenames
.TP
+\fB--bash\fR
+standard setting for bash history search, same as
+
+-b -i -d -v -w -l ${HISTSIZE}
+.TP
+\fB--delete-regexp \fI<regexp>\fR
+deletes in every line the portion matching the regexp
+.TP
\fB-t \fI<title>\fR, \fB--title \fI<title>\fR
add a title in the modeline
.TP
-\fB-c \fI<fg_modeline>,<bg_modeline>,<fg_highlight>,<bg_highlight>\fR,
-\fB--colors \fI<fg_modeline>,<bg_modeline>,<fg_highlight>,<bg_highlight>\fR
-select the modeline and highlight color numbers
+\fB-r \fI<pattern>\fR, \fB--pattern \fI<pattern>\fR
+set a pattern
+.TP
+\fB-c \fI<colors>\fR, \fB--colors \fI<colors>\fR
+select the modeline and highlight color numbers with a color list of
+the form
+
+\fI<fg_modeline>,<bg_modeline>,<fg_highlight>,<bg_highlight>\fR
.TP
\fB-v\fR, \fB--inject-in-tty\fR
inject the selected line into the tty input buffer
\fB-w\fR, \fB--add-control-qs\fR
add ^Q between characters during tty injection to quote control characters
.TP
-\fB-o \fI<output_filename>\fR, \fB--output-file \fI<output_filename>\fR
+\fB-o \fI<filename>\fR, \fB--output-file \fI<filename>\fR
write the selected line into the specified file
.TP
-\fB-s \fI<pattern_separator>\fR, \fB--pattern-separator \fI<pattern_separator>\fR
-specify the symbol to separate the substrings in the search pattern
+\fB-s \fI<separator>\fR, \fB--pattern-separator \fI<separator>\fR
+specify the character to separate the substrings in the search pattern
.TP
-\fB-x \fI<label_separator>\fR, \fB--label-separator \fI<label_separator>\fR
-specify the symbol to separate what to show to the user during the
-selection from the line to return
+\fB-x \fI<separator>\fR, \fB--label-separator \fI<separator>\fR
+specify the character to separate what to show to the user during the
+selection from the line to return. If the provided separator is "\\n",
+the lines to show to the user alternate with the lines to return
.TP
-\fB-l \fI<max_number_of_lines>\fR, \fB--number-of-lines \fI<max_number_of_lines>\fR
+\fB-l \fI<number>\fR, \fB--number-of-lines \fI<number>\fR
specify the maximum number of lines to take into account
-.TP
-\fB-f \fI<input_filename>\fR, \fB--input-file \fI<input_filename>\fR
-specify a file to search into (option kept for compatibility reasons)
.SH "EXAMPLES"
To use selector to search into your bash history
-.B selector -q -b -i -d -v -w -l ${HISTSIZE} <(history)
+.P
+.nf
+.B selector -q --bash <(history)
+.fi
To show a list of directories and insert a cd command to the selected
-one (using @ as a separator)
-
-.B selector -v -x @ <(find . -type d | awk \(aq{print $0\(dq@cd \(dq$0}\(aq)
-
-To select a line in a long text and returns the line number (this
-command uses ^A as a separator, hence there will be problems if the
-file contains ^A)
+one
-.B selector -v -x ^A <(awk < something.txt \(aq{ print $0\(dq^A\(dqNR }\(aq)
+.P
+.nf
+.B selector -v -x \(dq\\n\(dq <(find . -type d | awk \(aq{ print $0\(dq\\ncd \(dq$0 }\(aq)
-.SH "KEYBINDING IN BASH"
+.fi
+To select a line in a long text and write the line number in /tmp/nb
-You can associate selector to a single key in bash by using the
-command 'bind' in your bash initialization file. For instance, to
-associate it to M-r (that is, the "Alt" and "r" key pressed together),
-just add something like
-
-bind \(aq\(dq\\C-[r\(dq:\(dq\\C-a\\C-kselector -q -b -i -d -v -w -l ${HISTSIZE} <(history)\\C-m\(dq\(aq
-
-in your
-.IR ~/.bashrc .
-
-This bindings uses the control character ^A to put the cursor to the
-mostleft location and ^K to erase the current content of the readline
-buffer, and it simulates the enter key with ^M.
-
-Note that depending on the configuration of your system, the sequence
-associated to the M-r key, which is here "C-[r", may differ. To figure
-it out, simply press C-q followed by M-r in the console.
+.P
+.nf
+.B selector -o /tmp/nb -x \(dq\\n\(dq <(awk < something.txt \(aq{ print $0\(dq\\n\(dqNR }\(aq)
.SH "BUGS"
There are modeline display problems if the pattern is too long. This
program does not handle multibyte characters.
+The \fB-v\fR option does not work on FreeBSD 8.0 since the TIOCSTI
+ioctl request is broken.
+
.SH "AUTHOR"
Written by Francois Fleuret <francois@fleuret.org> and distributed
projects / selector.git / blobdiff