From 51da87b86969341bc46e3a801c8514839ec8b147 Mon Sep 17 00:00:00 2001
From: Tom Feist <shabble@metavore.org>
Date: Fri, 22 Apr 2011 03:51:43 +0100
Subject: history-search/README: fix list formatting and a POD formatting
 error.

---
 history-search/README.pod           | 45 +++++++++++++++++++++++--------------
 history-search/rl_history_search.pl |  8 +++----
 2 files changed, 32 insertions(+), 21 deletions(-)

(limited to 'history-search')

diff --git a/history-search/README.pod b/history-search/README.pod
index ce0a42f..2ce1866 100644
--- a/history-search/README.pod
+++ b/history-search/README.pod
@@ -51,18 +51,27 @@ terminal, or setting C<defflow off> in your F<~/.screenrc>if using GNU Screen.
 
 =over 4
 
-=item C<Enter> selects a match and terminates search mode.  B<It will also run
-the selected command.>
+=item * C<Enter>
 
-=item C<Ctrl-G> exits search mode without selecting.
+Selects a match and terminates search mode.
+B<It will also run the currently selected command.>
 
-=item C<E<lt>TABE<gt>> will open a new split window, showing all matching
-  completions.  C<E<lt>EscE<gt>> will close the window again, as will any other
-  action that exits history search mode.  Possible candidates can be cycled
-  through as normal using C<C-r> and <C-s>.
+=item * C<Ctrl-G>
 
-=item Any other ctrl- or meta- key binding will terminate search mode, leaving
-  the selected item in the input line.
+Exits search mode without selecting.
+
+=item * C<E<lt>TABE<gt>>
+
+Opens a new split window, showing all matching completions.  C<E<lt>EscE<gt>>
+will close the window again, as will any other action that exits history search
+mode.  Possible candidates can be cycled through as normal using C<C-r> and
+<C-s>.
+
+=item * Any other ctrl- or meta- key
+
+This will terminate search mode, leaving the selected item in the input line.
+It will not run the command (Except for C<Ctrl-J> and C<Ctrl-M>, which are
+functionally equivalent to C<Enter>).
 
 =back
 
@@ -70,7 +79,8 @@ the selected command.>
 
 Original script L<history_search.pl|https://github.com/coekie/irssi-scripts/blob/master/history_search.pl> Copyright E<copy> 2007 Wouter Coekaerts <coekie@irssi.org>
 
-Copyright E<copy> 2011 Tom Feist C<E<lt>shabble+irssi@metavore.orgE<gt>>
+Most of the other fancy stuff Copyright E<copy> 2011 Tom Feist
+C<E<lt>shabble+irssi@metavore.orgE<gt>>
 
 =head1 LICENCE
 
@@ -90,20 +100,19 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 =head1 BUGS
 
-faff
-
+Yeah, probably.
 
 =head1 TODO
 
 =over 1
 
-=item * DONE document tab behaviour
+=item * B<DONE> document tab behaviour
 
 =item * add keys (C-n/C-p) to scroll history list if necessary.
 
-=item * DONE if list is bigger than split size, centre it so selected item is visible
+=item * B<DONE> if list is bigger than split size, centre it so selected item is visible
 
-=item * INPROG allow a mechanism to select by number from list
+=item * I<INPROG> allow a mechanism to select by number from list
 
 =item * steal more of the code from ido_switcher to hilight match positions.
 
@@ -117,8 +126,6 @@ faff
 
 =item * consider tracking history manually (via send command/send text)
 
-=item
-
 =over 4
 
 =item * Pro: we could timestamp it.
@@ -133,3 +140,7 @@ faff
 
 =back
 
+
+
+=cut
+
diff --git a/history-search/rl_history_search.pl b/history-search/rl_history_search.pl
index 7561386..7112b51 100644
--- a/history-search/rl_history_search.pl
+++ b/history-search/rl_history_search.pl
@@ -51,23 +51,23 @@ terminal, or setting C<defflow off> in your F<~/.screenrc>if using GNU Screen.
 
 =over 4
 
-=item C<Enter>
+=item * C<Enter>
 
 Selects a match and terminates search mode.
 B<It will also run the currently selected command.>
 
-=item C<Ctrl-G>
+=item * C<Ctrl-G>
 
 Exits search mode without selecting.
 
-=item C<E<lt>TABE<gt>
+=item * C<E<lt>TABE<gt>>
 
 Opens a new split window, showing all matching completions.  C<E<lt>EscE<gt>>
 will close the window again, as will any other action that exits history search
 mode.  Possible candidates can be cycled through as normal using C<C-r> and
 <C-s>.
 
-=item Any other ctrl- or meta- key
+=item * Any other ctrl- or meta- key
 
 This will terminate search mode, leaving the selected item in the input line.
 It will not run the command (Except for C<Ctrl-J> and C<Ctrl-M>, which are
-- 
cgit v1.2.3