X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=selector.1;h=b52a4b43e9255d9f71c4ac271fbc4101998cd034;hb=27783ac87a15916381959b883e28c97959700970;hp=d463ab876cfbeff16709a9f7c65e1cada3eae9b4;hpb=4940e37a8ae56beb0720577e44c469460a9af845;p=selector.git

diff --git a/selector.1 b/selector.1
index d463ab8..b52a4b4 100644
--- a/selector.1
+++ b/selector.1
@@ -58,53 +58,83 @@ selection mode, and "^I" between the case-sensitive and
 case-insensitive modes.
 
 .SH "OPTIONS"
-.IP "\fB-h\fP" 10
-display help and exits
-.IP "\fB-m\fP" 10
+.TP
+\fB-h\fR
+display help and exit
+.TP
+\fB-m\fR
 force the monochrome mode
-.IP "\fB-i\fP" 10
-invert the order of the lines
-.IP "\fB-b\fP" 10
+.TP
+\fB-i\fR
+revert the order of the lines
+.TP
+\fB-b\fR
 remove the numeric prefix from bash history
-.IP "\fB-z\fP" 10
+.TP
+\fB-z\fR
 remove the time prefix from zsh history
-.IP "\fB-d\fP" 10
+.TP
+\fB-d\fR
 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
+.TP
+\fB-e\fR
 start in regexp mode
-.IP "\fB-a\fP" 10
+.TP
+\fB-a\fR
 start in case sensitive mode
-.IP "\fB-q\fP" 10
+.TP
+\fB-q\fR
 make a flash instead of a beep when there is an edition error
-.IP "\fB--\fP" 10
+.TP
+\fB--\fR
 state that all following arguments are filenames
-.IP "\fB-t \fI<title>\fP" 10
+.TP
+\fB-t \fI<title>\fR
 add a title in the modeline
-.IP "\fB-c \fI<fg_modeline> <bg_modeline> <fg_highlight> <bg_highlight>\fP" 10
+.TP
+\fB-c \fI<fg_modeline> <bg_modeline> <fg_highlight> <bg_highlight>\fR
 select the modeline and highlight color numbers
-.IP "\fB-v\fP" 10
+.TP
+\fB-v\fR
 inject the selected line into the tty input buffer
-.IP "\fB-w\fP" 10
+.TP
+\fB-w\fR
 add ^Q between characters during tty injection to quote control characters
-.IP "\fB-o \fI<output_filename>\fP" 10
+.TP
+\fB-o \fI<output_filename>\fR
 write the selected line into the specified file
-.IP "\fB-s \fI<pattern_separator>\fP" 10
+.TP
+\fB-s \fI<pattern_separator>\fR
 specify the symbol to separate the substrings in the search pattern
-.IP "\fB-x \fI<label_separator>\fP" 10
+.TP
+\fB-x \fI<label_separator>\fR
 specify the symbol to separate what to show to the user during the
 selection from the line to return
-.IP "\fB-l \fI<max_number_of_lines>\fP" 10
+.TP
+\fB-l \fI<max_number_of_lines>\fR
 specify the maximum number of lines to take into account
-.IP "\fB-f \fI<input_filename>\fP" 10
+.TP
+\fB-f \fI<input_filename>\fR
 specify a file to search into (option kept for compatibility reasons)
 
-.SH "EXAMPLE"
+.SH "EXAMPLES"
 
-To use selector to search into your bash history, you can use
+To use selector to search into your bash history
 
 .B selector -q -b -i -d -v -w -l ${HISTSIZE} <(history)
 
+To show a list of directories and insert a cd command to the selected
+one (using @ as a separator)
+
+.B selector -v -x @ <(find . -type d | awk \(aq{print $0\(dq@cd \(dq$0}\(aq)
+
+To select a line in a long text and returns the line number (this
+command uses ^A as a separator, hence there will be problems if the
+file contains ^A)
+
+.B selector -v -x ^A <(awk < something.txt \(aq{ print $0\(dq^A\(dqNR }\(aq)
+
 .SH "KEYBINDING IN BASH"
 
 You can associate selector to a single key in bash by using the
@@ -112,19 +142,19 @@ 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 -q -b -i -d -v -w -l ${HISTSIZE} <(history)\\C-m"'
+bind \(aq\(dq\\C-[r\(dq:\(dq\\C-a\\C-kselector -q -b -i -d -v -w -l ${HISTSIZE} <(history)\\C-m\(dq\(aq
 
 in your
 .IR ~/.bashrc .
 
+This bindings uses the control character ^A to put the cursor to the
+mostleft location and ^K to erase the current content of the readline
+buffer, and it simulates the enter key with ^M.
+
 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 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. This
@@ -132,8 +162,8 @@ program does not handle multibyte characters.
 
 .SH "AUTHOR"
 
-The selector command was written by Francois Fleuret
-<francois@fleuret.org> and is distributed under the terms of the GNU
-General Public License version 3 as published by the Free Software
-Foundation. This is free software: you are free to change and
-redistribute it. There is NO WARRANTY, to the extent permitted by law.
+Written by Francois Fleuret <francois@fleuret.org> and distributed
+under the terms of the GNU General Public License version 3 as
+published by the Free Software Foundation. This is free software: you
+are free to change and redistribute it. There is NO WARRANTY, to the
+extent permitted by law.