Now uses getopt_long to parse the arguments.

[selector.git] / selector.1

diff --git a/selector.1 b/selector.1
index b52a4b4..31f3832 100644 (file)
--- a/selector.1
+++ b/selector.1
@@ -1,9 +1,9 @@
+.TH "SELECTOR" 1 "July 2009" "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
 \" 3.0 License.
 
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike
 \" 3.0 License.
 

-.TH "SELECTOR" 1 "July 2009" "Francois Fleuret" "User Commands"
-

 .SH "NAME"
 
 selector \- A simple command line utility for dynamic pattern selection
 .SH "NAME"
 
 selector \- A simple command line utility for dynamic pattern selection


@@ -14,17 +14,17 @@ selector \- A simple command line utility for dynamic pattern selection
 
 .SH "DESCRIPTION"
 
 
 .SH "DESCRIPTION"
 

-\fBselector\fP is a command line utility for dynamic string
-selection. It reads the content of the specified files, and as the
-user types a list of strings separated by ";" (or a regexp), the
+\fBselector\fP is a command line utility for interactive real-time
+pattern matching. It reads the content of the specified files, and as
+the user types a list of strings separated by ";" (or a regexp), the

 display is updated in real time to show only the lines containing all
 the said strings (or matching the regexp).
 
 display is updated in real time to show only the lines containing all
 the said strings (or matching the regexp).
 

-This command was mainly designed as a way to search in the shell
-history, for which it is substantially more efficient than the
-standard readline ^R binding. With the -v option, it injects the
-selected line into the tty input buffer, hence allowing the user to
-edit the line and execute it as a standard command.
+This command was mainly designed as a way to search efficiently in the
+shell history, for which it is substantially better than the standard
+readline ^R binding. With the -v option, it injects the selected line
+into the tty input buffer, hence allowing the user to edit the line
+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


@@ -59,63 +59,64 @@ 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-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
+\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
 .TP
 select the modeline and highlight color numbers
 .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<output_filename>\fR, \fB--output-file \fI<output_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-s \fI<pattern_separator>\fR, \fB--pattern-separator \fI<pattern_separator>\fR

 specify the symbol to separate the substrings in the search pattern
 .TP
 specify the symbol to separate the substrings in the search pattern
 .TP

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

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

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

-\fB-f \fI<input_filename>\fR
+\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"
 specify a file to search into (option kept for compatibility reasons)
 
 .SH "EXAMPLES"