Using the label separator \n indicates that labels and strings to return are on alter...

[selector.git] / selector.1

diff --git a/selector.1 b/selector.1
index 6663558..5b54665 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.6" "February 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
 
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike


@@ -35,6 +35,15 @@ 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.
 
 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
+
+.B source bash-selector.sh --hist --cd
+
+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
 .SH "KEY BINDINGS"
 
 Keys corresponding to ASCII codes between " " and "~" add a character


@@ -59,107 +68,107 @@ 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
-start in case sensitive mode
+\fB-a\fR, \fB--case-sensitive\fR
+start in case-sensitive mode
+.TP
+\fB-j\fR, \fB--show-long-lines\fR
+print a long-line indicator at the end of truncated lines

 .TP
 .TP

-\fB-q\fR
+\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
 .TP
 \fB--\fR
 state that all following arguments are filenames
 .TP
 make a flash instead of a beep when there is an edition error
 .TP
 \fB--\fR
 state that all following arguments are filenames
 .TP

-\fB-t \fI<title>\fR
+\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
 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-r \fI<pattern>\fR, \fB--pattern \fI<pattern>\fR
+set a pattern

 .TP
 .TP

-\fB-v\fR
+\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
 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
-selection from the line to return
+\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. If the provided separator is "\\n",
+the lines to show to the user alternate with the lines to return

 .TP
 .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 <(history)

 
 To show a list of directories and insert a cd command to the selected
 
 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)
+one

 
 

-.SH "KEYBINDING IN BASH"
+.B selector -v -x \(dq\\\\n\(dq <(find . -type d | awk \(aq{print $0\(dq\\\\ncd \(dq$0}\(aq)

 
 

-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
+To select a line in a long text and returns the line number

 
 

-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.
+.B selector -v -x \(dq\\\\n\(dq <(awk < something.txt \(aq{ print $0\(dq\\\\n\(dqNR }\(aq)

 
 .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