From 218d26e7fa71af86c66c433a75a33d096402627a Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Mon, 18 Apr 2011 15:06:04 +0100 Subject: trying out README's in pod now, to avoid the markdown pain. --- history-search/README.pod | 135 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 history-search/README.pod (limited to 'history-search/README.pod') diff --git a/history-search/README.pod b/history-search/README.pod new file mode 100644 index 0000000..ce0a42f --- /dev/null +++ b/history-search/README.pod @@ -0,0 +1,135 @@ +=pod + +=head1 NAME + +rl_history_search.pl + +=head1 DESCRIPTION + +Search within your typed history as you type (something like ctrl-R in bash or other +readline-type applications.) + +=head1 INSTALLATION + +Copy into your F<~/.irssi/scripts/> directory and load with +C>. + +This script requires that you have first installed and loaded F + +Uberprompt can be downloaded from: + +L + +and follow the instructions at the top of that file or its README for installation. + +If uberprompt.pl is available, but not loaded, this script will make one +attempt to load it before giving up. This eliminates the need to precisely +arrange the startup order of your scripts. + +=head1 SETUP + +C + +Where C<^R> is a key of your choice. + +=head1 USAGE + +Type C followed by your search string. The prompt line will show +you the most recent command to match the string you've typed. + +B You can cycle through multiple matches with C (to select older +matches), and (to select newer matches). Cycling off the end of the +history list returns you to the other end again. + +B C may not work if you have software flow control configured for +your terminal. It may appear to freeze irssi entirely. If this happens, it can +be restored with C, but you will be unable to use the C binding. +You can disable flow control by running the command C in your +terminal, or setting C in your F<~/.screenrc>if using GNU Screen. + +=head2 COMMANDS + +=over 4 + +=item C selects a match and terminates search mode. B + +=item C exits search mode without selecting. + +=item CTABE> will open a new split window, showing all matching + completions. CEscE> 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 and . + +=item Any other ctrl- or meta- key binding will terminate search mode, leaving + the selected item in the input line. + +=back + +=head1 AUTHORS + +Original script L Copyright E 2007 Wouter Coekaerts + +Copyright E 2011 Tom Feist Cshabble+irssi@metavore.orgE> + +=head1 LICENCE + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +=head1 BUGS + +faff + + +=head1 TODO + +=over 1 + +=item * 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 * INPROG allow a mechanism to select by number from list + +=item * steal more of the code from ido_switcher to hilight match positions. + +=item * make flex matching optional (key or setting) + +=item * add some online help (? or C-h triggered, maybe?) + +=item * make temp_split stuff more generic (to be used by help, etc) + +=item * figure out why sometimes the split list doesn't update correctly (eg: no matches) + +=item * consider tracking history manually (via send command/send text) + +=item + +=over 4 + +=item * Pro: we could timestamp it. + +=item * Con: Would involve catching up/down and all the other history selection mechanisms. + +=item * Compromise - tag history as it comes it (match it with data via sig handlers?) + +=back + +=item * Possibility of saving/restoring history over sessions? + +=back + -- cgit v1.2.3 From 51da87b86969341bc46e3a801c8514839ec8b147 Mon Sep 17 00:00:00 2001 From: Tom Feist 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 ++++++++++++++++++++++++++++----------------- 1 file changed, 28 insertions(+), 17 deletions(-) (limited to 'history-search/README.pod') 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 in your F<~/.screenrc>if using GNU Screen. =over 4 -=item C selects a match and terminates search mode. B +=item * C -=item C exits search mode without selecting. +Selects a match and terminates search mode. +B -=item CTABE> will open a new split window, showing all matching - completions. CEscE> 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 and . +=item * C -=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 * CTABE> + +Opens a new split window, showing all matching completions. CEscE> +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 and +. + +=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 and C, which are +functionally equivalent to C). =back @@ -70,7 +79,8 @@ the selected command.> Original script L Copyright E 2007 Wouter Coekaerts -Copyright E 2011 Tom Feist Cshabble+irssi@metavore.orgE> +Most of the other fancy stuff Copyright E 2011 Tom Feist +Cshabble+irssi@metavore.orgE> =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 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 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 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 + -- cgit v1.2.3 From 757e4a6c62d16a18835bbdd90eb2e1e0ff75267c Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 22 Apr 2011 03:54:50 +0100 Subject: history-search/README: see if we can fix the link to coekies original history_search --- history-search/README.pod | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'history-search/README.pod') diff --git a/history-search/README.pod b/history-search/README.pod index 2ce1866..090ed66 100644 --- a/history-search/README.pod +++ b/history-search/README.pod @@ -77,7 +77,9 @@ functionally equivalent to C). =head1 AUTHORS -Original script L Copyright E 2007 Wouter Coekaerts +Original script +L Copyright E 2007 Wouter Coekaerts Ccoekie@irssi.orgE> + Most of the other fancy stuff Copyright E 2011 Tom Feist Cshabble+irssi@metavore.orgE> -- cgit v1.2.3 From 17b66df8f10d453668c58a94f430acc6620fa3b0 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 22 Apr 2011 03:55:53 +0100 Subject: history-search/README: linkifying failed, fallin back to GH style linkage. --- history-search/README.pod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'history-search/README.pod') diff --git a/history-search/README.pod b/history-search/README.pod index 090ed66..f33474d 100644 --- a/history-search/README.pod +++ b/history-search/README.pod @@ -78,7 +78,7 @@ functionally equivalent to C). =head1 AUTHORS Original script -L Copyright E 2007 Wouter Coekaerts Ccoekie@irssi.orgE> +[[history_search.pl|http://github.com/coekie/irssi-scripts/blob/master/history_search.pl]] Copyright E 2007 Wouter Coekaerts Ccoekie@irssi.orgE> Most of the other fancy stuff Copyright E 2011 Tom Feist -- cgit v1.2.3 From 9e7dcb44adfaaf675da62d8b9116ebd9ae96cf4f Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 22 Apr 2011 10:12:57 +0100 Subject: finally fixed link to point at coekies repo. --- history-search/README.pod | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'history-search/README.pod') diff --git a/history-search/README.pod b/history-search/README.pod index f33474d..830eb5f 100644 --- a/history-search/README.pod +++ b/history-search/README.pod @@ -65,7 +65,7 @@ Exits search mode without selecting. Opens a new split window, showing all matching completions. CEscE> 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 and -. +C<. =item * Any other ctrl- or meta- key @@ -78,7 +78,8 @@ functionally equivalent to C). =head1 AUTHORS Original script -[[history_search.pl|http://github.com/coekie/irssi-scripts/blob/master/history_search.pl]] Copyright E 2007 Wouter Coekaerts Ccoekie@irssi.orgE> +L + Copyright E 2007 Wouter Coekaerts Ccoekie@irssi.orgE> Most of the other fancy stuff Copyright E 2011 Tom Feist -- cgit v1.2.3