Added a short explanation for the new bash-selector.sh.

[selector.git] / selector.1

diff --git a/selector.1 b/selector.1
index 54805ad..0446d14 100644 (file)
--- a/selector.1
+++ b/selector.1
@@ -1,4 +1,4 @@
-.TH "SELECTOR" 1 "April 2010" "Francois Fleuret" "User Commands"
+.TH "SELECTOR" "1.1.4" "October 2011" "Francois Fleuret" "User Commands"

 
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike
 
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike


@@ -84,12 +84,25 @@ start in regexp mode
 \fB-a\fR, \fB--case-sensitive\fR
 start in case sensitive mode
 .TP
 \fB-a\fR, \fB--case-sensitive\fR
 start in case sensitive mode
 .TP

+\fB-u\fR, \fB--upper-case-makes-case-sensitive\fR
+using an upper case in the matching string makes the matching
+case-sensitive
+.TP
+\fB-n\fR, \fB--exclamation-negates\fR
+substrings starting with an exclamation mark must be absent for a line
+to match
+.TP

 \fB-q\fR, \fB--no-beep\fR
 make a flash instead of a beep when there is an edition error
 .TP
 \fB-q\fR, \fB--no-beep\fR
 make a flash instead of a beep when there is an edition error
 .TP

-\fB--\fR, \fB--rest-are-files\fR
+\fB--\fR

 state that all following arguments are filenames
 .TP
 state that all following arguments are filenames
 .TP

+\fB--bash\fR
+standard setting for bash history search, same as
+
+-b -i -d -v -w -l ${HISTSIZE}
+.TP

 \fB-t \fI<title>\fR, \fB--title \fI<title>\fR
 add a title in the modeline
 .TP
 \fB-t \fI<title>\fR, \fB--title \fI<title>\fR
 add a title in the modeline
 .TP


@@ -117,15 +130,24 @@ selection from the line to return
 .TP
 \fB-l \fI<number>\fR, \fB--number-of-lines \fI<number>\fR
 specify the maximum number of lines to take into account
 .TP
 \fB-l \fI<number>\fR, \fB--number-of-lines \fI<number>\fR
 specify the maximum number of lines to take into account

-.TP
-\fB-f \fI<filename>\fR, \fB--input-file \fI<filename>\fR
-specify a file to search into (option kept for compatibility reasons)
+
+.SH "USAGE WITH BASH"
+
+The selector command comes with a shell script for bash. If you add
+
+.B . bash-selector.sh
+
+in your
+.IR ~/.bashrc
+(do not forget the dot before the command name), it will remap M-r to
+the smart history search, and redefine cd to have M-c provide a smart
+cd history.

 
 .SH "EXAMPLES"
 
 To use selector to search into your bash history
 
 
 .SH "EXAMPLES"
 
 To use selector to search into your bash history
 

-.B selector -q -b -i -d -v -w -l ${HISTSIZE} <(history)
+.B selector -q --bash <(history)

 
 To show a list of directories and insert a cd command to the selected
 one (using @ as a separator)
 
 To show a list of directories and insert a cd command to the selected
 one (using @ as a separator)


@@ -138,31 +160,14 @@ file contains ^A)
 
 .B selector -v -x ^A <(awk < something.txt \(aq{ print $0\(dq^A\(dqNR }\(aq)
 
 
 .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
-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 \(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.
-

 .SH "BUGS"
 
 There are modeline display problems if the pattern is too long. This
 program does not handle multibyte characters.
 
 .SH "BUGS"
 
 There are modeline display problems if the pattern is too long. This
 program does not handle multibyte characters.
 

+The \fB-v\fR option does not work on FreeBSD 8.0 since the TIOCSTI
+ioctl request is broken.
+

 .SH "AUTHOR"
 
 Written by Francois Fleuret <francois@fleuret.org> and distributed
 .SH "AUTHOR"
 
 Written by Francois Fleuret <francois@fleuret.org> and distributed