Cosmetics.

[selector.git] / selector.1

diff --git a/selector.1 b/selector.1
index 0cdac89..12f16ab 100644 (file)
--- a/selector.1
+++ b/selector.1
@@ -16,7 +16,10 @@ 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
@@ -33,7 +36,8 @@ 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".
+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
@@ -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,20 +71,25 @@ 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 "KEY-BINDING IN BASH"
 
@@ -88,7 +98,7 @@ 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 -d -i -b -v <(history)\\C-m"'
+bind '"\\C-[r":"\\C-a\\C-kselector -q -b -i -d -v -w -l 10000 <(history)\\C-m"'
 
 in your ~/.bashrc.
 
@@ -102,12 +112,10 @@ simulates the enter key.
 
 .SH "BUGS"
 
-There are modeline display problems if the pattern is too long. If a
-line contains control characters, the returned line has been converted
-to printable characters.
+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.