X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=selector.1;h=fa215b00c61d95145fe1327b8d50bb8819cebed9;hb=c6f848650dccbecb05229e86c180bd7837872185;hp=11edc9fd6b4431b4d5e77752acd4bef56772fc7d;hpb=5ff0b55cd6a1c39f3d711036319244e18151d46f;p=selector.git diff --git a/selector.1 b/selector.1 index 11edc9f..fa215b0 100644 --- a/selector.1 +++ b/selector.1 @@ -1,20 +1,29 @@ -.TH "SELECTOR" "1" +\" This man page was written by Francois Fleuret +\" and is distributed under a Creative Commons Attribution-Share Alike +\" 3.0 License. + +.TH "SELECTOR" 1 "" "Francois Fleuret" + .SH "NAME" -selector - A simple command line utility for dynamic pattern selection + +selector \- A simple command line utility for dynamic pattern selection + .SH "SYNOPSIS" -.PP + \fBselector\fP [\fBoptions\fP] [ [ ...]] + .SH "DESCRIPTION" -.PP + \fBselector\fP is a command line utility for dynamic string selection. As you type 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. -The main usage of selector is as an efficient search in the shell -command history. With the correct option, it will inject the selected -line into the virtual 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 in the shell +history, for which it is substantially more efficient than the +standard readline ^R bidding. The -v option will inject the selected +line into the tty input buffer, allowing the user to edit the line and +execute it as a standard command. Selector is also a good tool to test regexps, or a way to display menus. The -x option allows to specify a label delimiter: the part of @@ -22,25 +31,25 @@ each line before that character will appear during the selection, and the part after that character will be returned. .SH "KEYS" -.PP Keys corresponding to ASCII codes between " " and "~" add a character to the pattern string. The Backspace key, "^H" and "^?" delete the character immediately on the left of the cursor, while the Delete key and "^D" delete the character at cursor location. -The Up and Down cursor keys move the selected line accordingly, and -PageUp and PageDown move by ten lines. The Home and End key move to -the top and the bottom of the list respectively. The return key -selects the current line and exits. +The Left and Right cursor keys move the editing cursor +accordingly. The Up and Down cursor keys move the selected line one +entry at a time, and PageUp and PageDown move it by ten entries. The +Home and End key move to the top and the bottom of the list +respectively. The return key selects the current line and exits. -The shortcuts "^A", "^E", "^U", and "^K" do somehow what they do in +The keys "^A", "^E", "^U", and "^K" do somehow what they do in readline, and you can exit selector without doing anything by either interrupting the command with "^C" or by typing "^G" or the Escape key. -The "^R" key switches between the standard multi-substring mode and -the regexp mode, and "^I" between the case-sensitive and +The key "^R" switches between the multi-substring and the regexp +selection mode, and "^I" between the case-sensitive and case-insensitive modes. .SH "OPTIONS" @@ -58,9 +67,9 @@ remove the time prefix from zsh history 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 -start in the regexp mode +start in regexp mode .IP "\fB-a\fP" 10 -start in the case-sensitive mode +start in case sensitive mode .IP "\fB-q\fP" 10 make a flash instead of a beep when there is an edition error .IP "\fB--\fP" 10 @@ -91,7 +100,7 @@ To use selector to search into your bash history, you can use .B selector -q -b -i -d -v -w -l ${HISTSIZE} <(history) -.SH "KEY-BINDING IN BASH" +.SH "KEYBINDING IN BASH" You can associate selector to a single key in bash by using the command 'bind' in your bash initialization file. For instance, to @@ -116,6 +125,8 @@ There are modeline display problems if the pattern is too long. This program does not handle multibyte characters. .SH "AUTHOR" -.PP -Written by Francois Fleuret , and distributed -under a Creative Commons Attribution-Share Alike 3.0 License. + +The selector command was written by Francois Fleuret + and is distributed under the terms of the GNU +General Public License version 3 as published by the Free Software +Foundation.