Cosmetics.

[selector.git] / selector.1

diff --git a/selector.1 b/selector.1
index 7c31364..e80ccce 100644 (file)
--- a/selector.1
+++ b/selector.1
@@ -1,6 +1,6 @@
-.TH "SELECTOR" "1"
+.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] [<filename1> [<filename2> ...]]
@@ -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: the part of
+each line before that character will appear during the selection, and
+the part after that character will be returned.
 
 .SH "KEYS"
 .PP
@@ -46,17 +49,18 @@ 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
+start in the regexp mode
 .IP "\fB-a\fP" 10
-make the matching case sensitive
+start in the 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
@@ -74,17 +78,18 @@ 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 the label from the rest of the line
+specify the symbol to separate what to show to the user during the
+selection from the line to return
 .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 ${HISTSIZE} <(history)
 
 .SH "KEY-BINDING IN BASH"
 
@@ -93,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 ${HISTSIZE} <(history)\\C-m"'
 
 in your ~/.bashrc.
 
@@ -107,9 +112,8 @@ 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