X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=selector.1;h=12f16ab7785ff5d54f750bba85d32d7ac02a082d;hb=e5cac5f305479e8c1003117cc226d6dea9f9adde;hp=4e1d26db91e55c2ddafd7492b2f55d1b07964484;hpb=a6c319c9adcbde67f7eb7208ccbec70ea8210f8b;p=selector.git

diff --git a/selector.1 b/selector.1
index 4e1d26d..12f16ab 100644
--- a/selector.1
+++ b/selector.1
@@ -7,7 +7,7 @@ selector - A simple command line utility for dynamic pattern selection
 .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,
+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.
 
@@ -16,28 +16,32 @@ 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.
 
-Selector is also a good tool to test regexps.
+Selector is also a good tool to test regexps, or a way to display
+menus. The -x option allows to specify a label delimiter: Only the
+part of each line before that character will appear during the
+selection, but the full line 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
+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.
+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 shortcuts ^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.
+The shortcuts "^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 case-insensitive
-modes.
+The "^R" key switches between the standard multi-substring mode and
+the regexp mode, and "^I" between the case-sensitive and
+case-insensitive modes.
 
 .SH "OPTIONS"
 .IP "\fB-h\fP" 10
@@ -45,13 +49,14 @@ display help and exits
 .IP "\fB-m\fP" 10
 force the monochrome mode
 .IP "\fB-i\fP" 10
-inverse the order of the lines
+invert the order of the lines
 .IP "\fB-b\fP" 10
 remove the numeric prefix from bash history
 .IP "\fB-z\fP" 10
 remove the time prefix from zsh history
 .IP "\fB-d\fP" 10
-remove duplicated lines
+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 with the regexp mode activated
 .IP "\fB-a\fP" 10
@@ -66,50 +71,51 @@ add a title in the modeline
 select the modeline and highlight color numbers
 .IP "\fB-v\fP" 10
 inject the selected line into the tty input buffer
+.IP "\fB-w\fP" 10
+add ^Q between characters during tty injection to quote control characters
 .IP "\fB-o <output filename>\fP" 10
 write the selected line into the specified file
 .IP "\fB-s <pattern separator>\fP" 10
 specify the symbol to separate the substrings in the search pattern
+.IP "\fB-x <label separator>\fP" 10
+specify the symbol to separate what to show to the user during the
+selection from the rest of the line
 .IP "\fB-l <max number of lines>\fP" 10
 specify the maximum number of lines to take into account
 .IP "\fB-f <input filename>\fP" 10
 specify a file to search into (option kept for compatibility reasons)
 
-.SH "EXAMPLES"
+.SH "EXAMPLE"
 
 To use selector to search into your bash history, you can use
 
-.B selector -d -i -b -v <(history)
+.B selector -q -b -i -d -v -w -l 10000 <(history)
 
-.SH "INTERACTION WITH READLINE"
+.SH "KEY-BINDING IN BASH"
 
-For better efficiency, you can associate selector to a one key in the
-shell through the use of the readline configuration file. To do so,
-you have first to pick a key and check the character sequences
-associated to it.
+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
 
-You can do that by typing at the console prompt Control-q followed by
-the key you want to use. For instance, if you want to use Alt-r, you
-may get ^[r. Then, you have to add in the readline configuration file
-~/.inputrc the following:
+bind '"\\C-[r":"\\C-a\\C-kselector -q -b -i -d -v -w -l 10000 <(history)\\C-m"'
 
-"^[r": "^A^K selector -q -b -i -d -v -l 10000 <(history)^M"
+in your ~/.bashrc.
 
-Note that you have to put the actual control characters in the
-configuration file, not a '^' followed by a character. To do so with
-Emacs for instance, you have to use the C-q key followed by another
-key: C-q C-a inserts "^A", C-q C-[ inserts "^[", etc.
+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 characters in this line are there to erase the current
-line before invoking the selector.
+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.
+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 <francois@fleuret.org>. Permission is
-granted to copy, distribute and/or modify this document under the
-terms of the GNU GPL.
+Written by Francois Fleuret <francois@fleuret.org>, and distributed
+under a Creative Commons Attribution-Share Alike 3.0 License.