X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=selector.git;a=blobdiff_plain;f=selector.1;h=b32325a3c4c7f1eea185858cbeb6f2929f5e0751;hp=d463ab876cfbeff16709a9f7c65e1cada3eae9b4;hb=d91fa6b4c3833c1b6d5ad3019bf83979f71aee27;hpb=4940e37a8ae56beb0720577e44c469460a9af845 diff --git a/selector.1 b/selector.1 index d463ab8..b32325a 100644 --- a/selector.1 +++ b/selector.1 @@ -1,9 +1,9 @@ +.TH "SELECTOR" "1.1.2" "April 2010" "Francois Fleuret" "User Commands" + \" This man page was written by Francois Fleuret \" and is distributed under a Creative Commons Attribution-Share Alike \" 3.0 License. -.TH "SELECTOR" 1 "July 2009" "Francois Fleuret" "User Commands" - .SH "NAME" selector \- A simple command line utility for dynamic pattern selection @@ -14,17 +14,17 @@ selector \- A simple command line utility for dynamic pattern selection .SH "DESCRIPTION" -\fBselector\fP is a command line utility for dynamic string -selection. It reads the content of the specified files, and as the -user types a list of strings separated by ";" (or a regexp), the +\fBselector\fP is a command line utility for interactive real-time +pattern matching. It reads the content of the specified files, and as +the user types a list of strings separated by ";" (or a regexp), the display is updated in real time to show only the lines containing all the said strings (or matching the regexp). -This command was mainly designed as a way to search in the shell -history, for which it is substantially more efficient than the -standard readline ^R binding. With the -v option, it injects the -selected line into the tty input buffer, hence allowing the user to -edit the line and execute it as a standard command. +This command was mainly designed as a way to search efficiently in the +shell history, for which it is substantially better than the standard +readline ^R binding. With the -v option, it injects the selected line +into the tty input buffer, hence allowing the user to edit the line +and execute it as a standard command. 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 @@ -58,52 +58,87 @@ selection mode, and "^I" between the case-sensitive and case-insensitive modes. .SH "OPTIONS" -.IP "\fB-h\fP" 10 -display help and exits -.IP "\fB-m\fP" 10 +.TP +\fB-h\fR, \fB--help\fR +display help and exit +.TP +\fB-m\fR, \fB--monochrome\fR force the monochrome mode -.IP "\fB-i\fP" 10 -invert the order of the lines -.IP "\fB-b\fP" 10 +.TP +\fB-i\fR, \fB--revert-order\fR +revert the order of the lines +.TP +\fB-b\fR, \fB--remove-bash-prefix\fR remove the numeric prefix from bash history -.IP "\fB-z\fP" 10 +.TP +\fB-z\fR, \fB--remove-zsh-prefix\fR remove the time prefix from zsh history -.IP "\fB-d\fP" 10 +.TP +\fB-d\fR, \fB--remove-duplicates\fR remove duplicated lines (note that you can have two different lines with the same visible part if you use the -x option) -.IP "\fB-e\fP" 10 +.TP +\fB-e\fR, \fB--regexp\fR start in regexp mode -.IP "\fB-a\fP" 10 +.TP +\fB-a\fR, \fB--case-sensitive\fR start in case sensitive mode -.IP "\fB-q\fP" 10 +.TP +\fB-q\fR, \fB--no-beep\fR make a flash instead of a beep when there is an edition error -.IP "\fB--\fP" 10 +.TP +\fB--\fR, \fB--rest-are-files\fR state that all following arguments are filenames -.IP "\fB-t \fI\fP" 10 +.TP +\fB--bash\fR +standard setting for bash history search, same as + +-b -i -d -v -w -l ${HISTSIZE} +.TP +\fB-t \fI<title>\fR, \fB--title \fI<title>\fR add a title in the modeline -.IP "\fB-c \fI<fg_modeline> <bg_modeline> <fg_highlight> <bg_highlight>\fP" 10 -select the modeline and highlight color numbers -.IP "\fB-v\fP" 10 +.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 -.IP "\fB-w\fP" 10 +.TP +\fB-w\fR, \fB--add-control-qs\fR add ^Q between characters during tty injection to quote control characters -.IP "\fB-o \fI<output_filename>\fP" 10 +.TP +\fB-o \fI<filename>\fR, \fB--output-file \fI<filename>\fR write the selected line into the specified file -.IP "\fB-s \fI<pattern_separator>\fP" 10 -specify the symbol to separate the substrings in the search pattern -.IP "\fB-x \fI<label_separator>\fP" 10 -specify the symbol to separate what to show to the user during the +.TP +\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<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 -.IP "\fB-l \fI<max_number_of_lines>\fP" 10 +.TP +\fB-l \fI<number>\fR, \fB--number-of-lines \fI<number>\fR specify the maximum number of lines to take into account -.IP "\fB-f \fI<input_filename>\fP" 10 -specify a file to search into (option kept for compatibility reasons) -.SH "EXAMPLE" +.SH "EXAMPLES" + +To use selector to search into your bash history + +.B selector -q --bash <(history) -To use selector to search into your bash history, you can use +To show a list of directories and insert a cd command to the selected +one (using @ as a separator) -.B selector -q -b -i -d -v -w -l ${HISTSIZE} <(history) +.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) + +.B selector -v -x ^A <(awk < something.txt \(aq{ print $0\(dq^A\(dqNR }\(aq) .SH "KEYBINDING IN BASH" @@ -112,28 +147,31 @@ 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 '"\\C-[r":"\\C-a\\C-kselector -q -b -i -d -v -w -l ${HISTSIZE} <(history)\\C-m"' +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. -The control character "C-a" puts the cursor to the mostleft location, -"C-k" erases the current content of the readline buffer, and "C-m" -simulates the enter key. - .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" -The selector command was written by Francois Fleuret -<francois@fleuret.org> and is distributed under the terms of the GNU -General Public License version 3 as published by the Free Software -Foundation. This is free software: you are free to change and -redistribute it. There is NO WARRANTY, to the extent permitted by law. +Written by Francois Fleuret <francois@fleuret.org> and distributed +under the terms of the GNU General Public License version 3 as +published by the Free Software Foundation. This is free software: you +are free to change and redistribute it. There is NO WARRANTY, to the +extent permitted by law.