Removed an unused parameter in previous_visible().
[selector.git] / selector.1
index 6663558..dd6d135 100644 (file)
@@ -1,4 +1,4 @@
-.TH "SELECTOR" 1 "July 2009" "Francois Fleuret" "User Commands"
+.TH "SELECTOR" "1.1.1" "April 2010" "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
@@ -59,70 +59,73 @@ case-insensitive modes.
 
 .SH "OPTIONS"
 .TP
 
 .SH "OPTIONS"
 .TP
-\fB-h\fR
+\fB-h\fR, \fB--help\fR
 display help and exit
 .TP
 display help and exit
 .TP
-\fB-m\fR
+\fB-m\fR, \fB--monochrome\fR
 force the monochrome mode
 .TP
 force the monochrome mode
 .TP
-\fB-i\fR
+\fB-i\fR, \fB--revert-order\fR
 revert the order of the lines
 .TP
 revert the order of the lines
 .TP
-\fB-b\fR
+\fB-b\fR, \fB--remove-bash-prefix\fR
 remove the numeric prefix from bash history
 .TP
 remove the numeric prefix from bash history
 .TP
-\fB-z\fR
+\fB-z\fR, \fB--remove-zsh-prefix\fR
 remove the time prefix from zsh history
 .TP
 remove the time prefix from zsh history
 .TP
-\fB-d\fR
+\fB-d\fR, \fB--remove-duplicates\fR
 remove duplicated lines (note that you can have two different lines
 with the same visible part if you use the -x option)
 .TP
 remove duplicated lines (note that you can have two different lines
 with the same visible part if you use the -x option)
 .TP
-\fB-e\fR
+\fB-e\fR, \fB--regexp\fR
 start in regexp mode
 .TP
 start in regexp mode
 .TP
-\fB-a\fR
+\fB-a\fR, \fB--case-sensitive\fR
 start in case sensitive mode
 .TP
 start in case sensitive mode
 .TP
-\fB-q\fR
+\fB-q\fR, \fB--no-beep\fR
 make a flash instead of a beep when there is an edition error
 .TP
 make a flash instead of a beep when there is an edition error
 .TP
-\fB--\fR
+\fB--\fR, \fB--rest-are-files\fR
 state that all following arguments are filenames
 .TP
 state that all following arguments are filenames
 .TP
-\fB-t \fI<title>\fR
+\fB--bash\fR
+standard setting for bash history search, same as as -b -i -d -v -w
+.TP
+\fB-t \fI<title>\fR, \fB--title \fI<title>\fR
 add a title in the modeline
 .TP
 add a title in the modeline
 .TP
-\fB-c \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
 .TP
-\fB-v\fR
+\fB-v\fR, \fB--inject-in-tty\fR
 inject the selected line into the tty input buffer
 .TP
 inject the selected line into the tty input buffer
 .TP
-\fB-w\fR
+\fB-w\fR, \fB--add-control-qs\fR
 add ^Q between characters during tty injection to quote control characters
 .TP
 add ^Q between characters during tty injection to quote control characters
 .TP
-\fB-o \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
-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
-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-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
-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 -l ${HISTSIZE} <(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)
@@ -160,6 +163,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