When using the -x option, the part of the line after the separator is not returned.
[selector.git] / selector.1
index 7953edd..11edc9f 100644 (file)
@@ -17,9 +17,9 @@ 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, or a way to display
 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: Only the
-part of each line before that character will appear during the
-selection, but the full line will be returned.
+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
 
 .SH "KEYS"
 .PP
@@ -55,11 +55,12 @@ remove the numeric prefix from bash history
 .IP "\fB-z\fP" 10
 remove the time prefix from zsh history
 .IP "\fB-d\fP" 10
 .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
 .IP "\fB-e\fP" 10
-start with the regexp mode activated
+start in the regexp mode
 .IP "\fB-a\fP" 10
 .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
 .IP "\fB-q\fP" 10
 make a flash instead of a beep when there is an edition error
 .IP "\fB--\fP" 10
@@ -77,7 +78,8 @@ 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
 .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
 .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
@@ -87,7 +89,7 @@ specify a file to search into (option kept for compatibility reasons)
 
 To use selector to search into your bash history, you can use
 
 
 To use selector to search into your bash history, you can use
 
-.B selector -q -b -i -d -v -w -l 10000 <(history)
+.B selector -q -b -i -d -v -w -l ${HISTSIZE} <(history)
 
 .SH "KEY-BINDING IN BASH"
 
 
 .SH "KEY-BINDING IN BASH"
 
@@ -96,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
 
 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 10000 <(history)\\C-m"'
+bind '"\\C-[r":"\\C-a\\C-kselector -q -b -i -d -v -w -l ${HISTSIZE} <(history)\\C-m"'
 
 in your ~/.bashrc.
 
 
 in your ~/.bashrc.