Cosmetics.

[selector.git] / selector.1

diff --git a/selector.1 b/selector.1
index 31f3832..bc83e45 100644 (file)
--- a/selector.1
+++ b/selector.1
@@ -1,4 +1,4 @@
-.TH "SELECTOR" 1 "July 2009" "Francois Fleuret" "User Commands"
+.TH "SELECTOR" "1.1.4" "June 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,18 +84,33 @@ 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

-\fB-c \fI<fg_modeline>,<bg_modeline>,<fg_highlight>,<bg_highlight>\fR,
-\fB--colors \fI<fg_modeline>,<bg_modeline>,<fg_highlight>,<bg_highlight>\fR
-select the modeline and highlight color numbers
+\fB-c \fI<colors>\fR, \fB--colors \fI<colors>\fR
+select the modeline and highlight color numbers with a color list of
+the form
+
+\fI<fg_modeline>,<bg_modeline>,<fg_highlight>,<bg_highlight>\fR

 .TP
 \fB-v\fR, \fB--inject-in-tty\fR
 inject the selected line into the tty input buffer
 .TP
 \fB-v\fR, \fB--inject-in-tty\fR
 inject the selected line into the tty input buffer


@@ -103,27 +118,24 @@ inject the selected line into the tty input buffer
 \fB-w\fR, \fB--add-control-qs\fR
 add ^Q between characters during tty injection to quote control characters
 .TP
 \fB-w\fR, \fB--add-control-qs\fR
 add ^Q between characters during tty injection to quote control characters
 .TP

-\fB-o \fI<output_filename>\fR, \fB--output-file \fI<output_filename>\fR
+\fB-o \fI<filename>\fR, \fB--output-file \fI<filename>\fR

 write the selected line into the specified file
 .TP
 write the selected line into the specified file
 .TP

-\fB-s \fI<pattern_separator>\fR, \fB--pattern-separator \fI<pattern_separator>\fR
-specify the symbol to separate the substrings in the search pattern
+\fB-s \fI<separator>\fR, \fB--pattern-separator \fI<separator>\fR
+specify the character to separate the substrings in the search pattern

 .TP
 .TP

-\fB-x \fI<label_separator>\fR, \fB--label-separator \fI<label_separator>\fR
-specify the symbol to separate what to show to the user during the
+\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
 .TP
 selection from the line to return
 .TP

-\fB-l \fI<max_number_of_lines>\fR, \fB--number-of-lines \fI<max_number_of_lines>\fR
+\fB-l \fI<number>\fR, \fB--number-of-lines \fI<number>\fR

 specify the maximum number of lines to take into account
 specify the maximum number of lines to take into account

-.TP
-\fB-f \fI<input_filename>\fR, \fB--input-file \fI<input_filename>\fR
-specify a file to search into (option kept for compatibility reasons)

 
 .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)


@@ -143,12 +155,12 @@ 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 \(aq\(dq\\C-[r\(dq:\(dq\\C-a\\C-kselector -q -b -i -d -v -w -l ${HISTSIZE} <(history)\\C-m\(dq\(aq
+bind \(aq\(dq\\C-[r\(dq:\(dq\\C-a\\C-kselector --bash <(history)\\C-m\(dq\(aq

 
 in your
 .IR ~/.bashrc .
 
 
 in your
 .IR ~/.bashrc .
 

-This bindings uses the control character ^A to put the cursor to the
+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.
 
 mostleft location and ^K to erase the current content of the readline
 buffer, and it simulates the enter key with ^M.
 


@@ -161,6 +173,9 @@ it out, simply press C-q followed by M-r in the console.
 There are modeline display problems if the pattern is too long. This
 program does not handle multibyte characters.
 
 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