Set the file mode creation default to user only.
[selector.git] / selector.1
index ab2df59..c90fdbf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "SELECTOR" "1.1.6" "February 2012" "Francois Fleuret" "User Commands"
+.TH "SELECTOR" "1.1.7" "February 2013" "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
@@ -28,9 +28,7 @@ and execute it as a standard command.
 
 Selector is also a handy tool to test regexps, or to display menus
 with many possible choices. For the latter, the -x option allows to
 
 Selector is also a handy tool to test regexps, or to display menus
 with many possible choices. For the latter, the -x option allows to
-specify a label delimiter: the part of each line before that character
-will appear during the selection, but only the part after that
-character will be returned.
+show different strings than the ones 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.
@@ -39,10 +37,17 @@ can not be used as one of the input files.
 
 The selector command comes with a shell script for bash. If you add
 
 
 The selector command comes with a shell script for bash. If you add
 
+.P
+.nf
 .B source bash-selector.sh --hist --cd
 
 .B source bash-selector.sh --hist --cd
 
+.fi
 in your \fB~/.bashrc\fR, it will remap M-r to the smart history search,
 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.
+and redefine \fBcd\fR so that M-c provides a smart cd history.
+
+This script relies on readline being configured with the default
+emacs-style key bindings. You may have to hack a bit if you want to
+use it with the vi-style mode.
 
 .SH "KEY BINDINGS"
 
 
 .SH "KEY BINDINGS"
 
@@ -94,10 +99,10 @@ start in regexp mode
 start in case-sensitive mode
 .TP
 \fB-j\fR, \fB--show-long-lines\fR
 start in case-sensitive mode
 .TP
 \fB-j\fR, \fB--show-long-lines\fR
-print three dots at the end of truncated lines
+print a long-line indicator at the end of truncated lines
 .TP
 \fB-y\fR, \fB--show-hits\fR
 .TP
 \fB-y\fR, \fB--show-hits\fR
-highlight the part(s) of each line which match the substrings or regexp
+highlight the part(s) of each line which match(es) 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
 .TP
 \fB-u\fR, \fB--upper-case-makes-case-sensitive\fR
 using an upper case in the matching string makes the matching
@@ -117,6 +122,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-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
 \fB-c \fI<colors>\fR, \fB--colors \fI<colors>\fR
 select the modeline and highlight color numbers with a color list of
 the form
@@ -137,7 +145,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
 .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
 .TP
 \fB-l \fI<number>\fR, \fB--number-of-lines \fI<number>\fR
 specify the maximum number of lines to take into account
@@ -146,18 +155,24 @@ specify the maximum number of lines to take into account
 
 To use selector to search into your bash history
 
 
 To use selector to search into your bash history
 
+.P
+.nf
 .B selector -q --bash <(history)
 
 .B selector -q --bash <(history)
 
+.fi
 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)
+one
 
 
-.B selector -v -x @ <(find . -type d | awk \(aq{print $0\(dq@cd \(dq$0}\(aq)
+.P
+.nf
+.B selector -v -x \(dq\\n\(dq <(find . -type d | awk \(aq{ print $0\(dq\\ncd \(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)
+.fi
+To select a line in a long text and write the line number in /tmp/nb
 
 
-.B selector -v -x ^A <(awk < something.txt \(aq{ print $0\(dq^A\(dqNR }\(aq)
+.P
+.nf
+.B selector -o /tmp/nb -x \(dq\\n\(dq <(awk < something.txt \(aq{ print $0\(dq\\n\(dqNR }\(aq)
 
 .SH "BUGS"
 
 
 .SH "BUGS"