Fixed the syntax for examples.
[selector.git] / selector.1
index 5659e6c..840360e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "SELECTOR" "1.1.3" "May 2011" "Francois Fleuret" "User Commands"
+.TH "SELECTOR" "1.1.7" "July 2012" "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
@@ -35,6 +35,19 @@ character will be returned.
 Note that because this is an interactive command, the standard input
 can not be used as one of the input files.
 
+.SH "USING SELECTOR IN BASH"
+
+The selector command comes with a shell script for bash. If you add
+
+.RS
+.EX
+source bash-selector.sh --hist --cd
+.EE
+.RE
+
+in your \fB~/.bashrc\fR, it will remap M-r to the smart history search,
+and redefine cd so that M-c provides a smart cd history.
+
 .SH "KEY BINDINGS"
 
 Keys corresponding to ASCII codes between " " and "~" add a character
@@ -82,11 +95,17 @@ with the same visible part if you use the -x option)
 start in regexp mode
 .TP
 \fB-a\fR, \fB--case-sensitive\fR
-start in case sensitive mode
+start in case-sensitive mode
 .TP
-\fB-n\fR, \fB--exclamation-negates\fR
-substrings starting with an exclamation mark must be absent for a line
-to match
+\fB-j\fR, \fB--show-long-lines\fR
+print a long-line indicator at the end of truncated lines
+.TP
+\fB-y\fR, \fB--show-hits\fR
+highlight the part(s) of each line which match the substrings or regexp
+.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-q\fR, \fB--no-beep\fR
 make a flash instead of a beep when there is an edition error
@@ -102,6 +121,9 @@ standard setting for bash history search, same as
 \fB-t \fI<title>\fR, \fB--title \fI<title>\fR
 add a title in the modeline
 .TP
+\fB-r \fI<pattern>\fR, \fB--pattern \fI<pattern>\fR
+set a pattern
+.TP
 \fB-c \fI<colors>\fR, \fB--colors \fI<colors>\fR
 select the modeline and highlight color numbers with a color list of
 the form
@@ -122,7 +144,8 @@ specify the character to separate the substrings in the search pattern
 .TP
 \fB-x \fI<separator>\fR, \fB--label-separator \fI<separator>\fR
 specify the character to separate what to show to the user during the
-selection from the line to return
+selection from the line to return. If the provided separator is "\\n",
+the lines to show to the user alternate with the lines 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
@@ -131,38 +154,28 @@ specify the maximum number of lines to take into account
 
 To use selector to search into your bash history
 
-.B selector -q --bash <(history)
+.RS
+.EX
+selector -q --bash <(history)
+.EE
+.RE
 
 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
-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 --bash <(history)\\C-m\(dq\(aq
+one
 
-in your
-.IR ~/.bashrc .
+.RS
+.EX
+selector -v -x \(dq\\n\(dq <(find . -type d | awk \(aq{print $0\(dq\\ncd \(dq$0}\(aq)
+.EE
+.RE
 
-This binding 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.
+To select a line in a long text and returns the line number
 
-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.
+.RS
+.EX
+selector -v -x \(dq\\n\(dq <(awk < something.txt \(aq{ print $0\(dq\\n\(dqNR }\(aq)
+.EE
+.RE
 
 .SH "BUGS"