Cosmectics.
authorFrancois Fleuret <francois@fleuret.org>
Sat, 9 May 2009 08:45:57 +0000 (10:45 +0200)
committerFrancois Fleuret <francois@fleuret.org>
Sat, 9 May 2009 08:45:57 +0000 (10:45 +0200)
selector.1

index 5cae06f..7e0835d 100644 (file)
@@ -7,7 +7,7 @@ selector - A simple command line utility for dynamic pattern selection
 .SH "DESCRIPTION"
 .PP
 \fBselector\fP is a command line utility for dynamic string
-selection. As you type a list of strings separated by ';' or a regexp,
+selection. As you type 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.
 
@@ -21,23 +21,23 @@ Selector is also a good tool to test regexps.
 .SH "KEYS"
 .PP
 
-Keys corresponding to ASCII codes between ' ' and '~' add a character
-to the pattern string. The Backspace key, ^H and ^? delete the
+Keys corresponding to ASCII codes between " " and "~" add a character
+to the pattern string. The Backspace key, "^H" and "^?" delete the
 character immediately on the left of the cursor, while the Delete key
-and ^D delete the character at cursor location.
+and "^D" delete the character at cursor location.
 
 The Up and Down cursor keys move the selected line accordingly, and
 PageUp and PageDown move by ten lines. The Home and End key move to
 the top and the bottom of the list respectively. The return key
 selects the current line and exits.
 
-The shortcuts ^A, ^E, ^U, and ^K do somehow what they do in readline,
-and you can exit selector without doing anything by either
-interrupting the command with ^C or by typing ^G.
+The shortcuts "^A", "^E", "^U", and "^K" do somehow what they do in
+readline, and you can exit selector without doing anything by either
+interrupting the command with "^C" or by typing "^G".
 
-The ^R key switches between the standard multi-substring mode and the
-regexp mode, and ^I between the case-sensitive and case-insensitive
-modes.
+The "^R" key switches between the standard multi-substring mode and
+the regexp mode, and "^I" between the case-sensitive and
+case-insensitive modes.
 
 .SH "OPTIONS"
 .IP "\fB-h\fP" 10
@@ -83,25 +83,26 @@ To use selector to search into your bash history, you can use
 
 .SH "INTERACTION WITH READLINE"
 
-For better efficiency, you can associate selector to a key in the
-shell through the use of the readline configuration file. To do so,
-you have first to pick a key and check the character sequence
-associated to it.
+For better efficiency, you can associate selector to a single key in
+in the console through the use of the readline configuration file
+~/.inputrc.
 
-You can do that by typing at the console prompt Control-q followed by
-the key you want to use. For instance, if you want to use Alt-r, you
-may get ^[r. Then, you have to add in the readline configuration file
-~/.inputrc the following:
+To do so, you have first to pick a key and know the character sequence
+associated to it. You can figure that out by typing at the console
+prompt Ctrl-q followed by the key you want to use. For instance, if
+you want to use Alt-r, you may get "^[r". Then, you have to add in
+~/.inputrc the following line:
 
 "^[r": "^A^K selector -d -i -b -v <(history)^M"
 
 Note that you have to put the actual control characters in the
-configuration file, not a '^' followed by a character. To do so with
-Emacs for instance, you have to use the C-q key followed by another
-key: C-q C-a inserts "^A", C-q C-[ inserts "^[", etc.
+configuration file, not a "^" followed by a character. To do so with
+Emacs for instance, you have to use the Ctrl-q key followed by another
+key: Ctrl-q Ctrl-a inserts "^A", Ctrl-q Ctrl-[ inserts "^[", etc.
 
-The control characters in this line are here to first erase the
-current line content and to simulate the enter key.
+These control characters have the following roles: "^A" puts the
+cursor to the mostleft location, "^K" erases the current content of
+the readline buffer, and "^M" simulates the enter key.
 
 .SH "BUGS"