From ce375dbf92cd89780138cff01deae6fbefb71cf6 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Mon, 18 Apr 2011 15:42:10 +0100 Subject: updated a whole bunch of README files. --- ido-mode/README.pod | 204 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 204 insertions(+) create mode 100644 ido-mode/README.pod (limited to 'ido-mode/README.pod') diff --git a/ido-mode/README.pod b/ido-mode/README.pod new file mode 100644 index 0000000..9c49c0f --- /dev/null +++ b/ido-mode/README.pod @@ -0,0 +1,204 @@ +=pod + +=head1 NAME + +ido_switcher.pl + +=head1 DESCRIPTION + +Search and select windows similar to ido-mode for emacs + +=head1 INSTALLATION + +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. + +=head2 SETUP + +C + +Where C<^G> is a key of your choice. + +=head2 USAGE + +C (or whatever you've set the above bind to), enters IDO window switching mode. +You can then type either a search string, or use one of the additional key-bindings +to change the behaviour of the search. C provides online help regarding +the possible interactive options. + +=head3 EXTENDED USAGE: + +It is possible to pass arguments to the /ido_switch_start command, which +correspond to some of the interactively settable parameters listed below. + +The following options are available: + +=over 4 + +=item C<-channels> -- search through only channels. + +=item C<-queries> -- search through only queries. + +=item C<-all> -- search both queries and channels (Default). + +=item C<-active> -- limit search to only window items with activity. + +=item C<-exact> -- enable exact-substring matching + +=item C<-flex> -- enable flex-string matching + +=back + +I or C<-flex> are given, the default is the value of +C> + +=head4 EXAMPLE + +=over 2 + +=item C + +=item C + +=back + +B When entering window switching mode, the contents of your input line will +be saved and cleared, to avoid visual clutter whilst using the switching +interface. It will be restored once you exit the mode using either C, C, +or C. + +=head3 INTERACTIVE COMMANDS + +The following key-bindings are available only once the mode has been +activated: + +=over 4 + +=item C - Exit the mode without changing windows. + +=item C - Exit, as above. + +=item C - Rotate the list of window candidates forward by 1 + +=item C - Rotate the list of window candidates backward by 1 + +=item C - Toggle 'Active windows only' filter + +=item C - Switch between 'Flex' and 'Exact' matching. + +=item C - Select a network or server to filter candidates by + +=item C - Clear the current search string + +=item C - Cycle between showing only queries, channels, or all. + +=item C - Filter candidates by current search string, and then reset + the search string + +=item C - Select the current head of the candidate list (the green one) + +=item C - Select the current head of the list, without exiting the + switching mode. The head is then moved one place to the right, + allowing one to cycle through channels by repeatedly pressing space. + +=item C - B<[currently in development]> displays all possible completions + at the bottom of the current window. + +=item I (C, etc) - Add that character to the current search + string. + +=back + +=head3 USAGE NOTES + +=over 4 + +=item Using C-e (show actives), followed by repeatedly pressing space will cycle + through all your currently active windows. + +=item If you enter a search string fragment, and realise that more than one candidate + is still presented, rather than delete the whole string and modify it, you can + use C-SPC to 'lock' the current matching candidates, but allow you to search + through those matches alone. + +=back + +=head1 AUTHORS + +Based originally on L script Copyright 2007 Wouter Coekaerts +Ccoekie@irssi.orgE>. + +Primary functionality Copyright 2010-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: + +=over 4 + +=item B Sometimes selecting a channel with the same name on a different + network will take you to the wrong channel. + +=back + +=head1 TODO + +=over 4 + +=item B C-g - cancel + +=item B C-spc - narrow + +=item B flex matching (on by default, but optional) + +=item TODO server/network narrowing + +=item B colourised output (via uberprompt) + +=item B C-r / C-s rotate matches + +=item B toggle queries/channels + +=item B remove inputline content, restore it afterwards. + +=item TODO tab - display all possibilities in window (clean up afterwards) +how exactly will this work? + +=item B sort by recent activity/recently used windows (separate commands?) + +=item B need to be able to switch ordering of active ones (numerical, or most +recently active, priority to PMs/hilights, etc?) + +=item B should space auto-move forward to next window for easy stepping + through sequential/active windows? + +=back + + + +=cut + -- cgit v1.2.3 From e9d28fe7464b6250132b9bbde99174f1a456d02a Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Mon, 18 Apr 2011 15:51:25 +0100 Subject: ido-mode: updated POD to try to stop the README from adding anchors everywhere. --- ido-mode/README.pod | 107 ++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 75 insertions(+), 32 deletions(-) (limited to 'ido-mode/README.pod') diff --git a/ido-mode/README.pod b/ido-mode/README.pod index 9c49c0f..62f7190 100644 --- a/ido-mode/README.pod +++ b/ido-mode/README.pod @@ -37,24 +37,36 @@ the possible interactive options. =head3 EXTENDED USAGE: -It is possible to pass arguments to the /ido_switch_start command, which +It is possible to pass arguments to the C command, which correspond to some of the interactively settable parameters listed below. The following options are available: =over 4 -=item C<-channels> -- search through only channels. +=item C<-channels> -=item C<-queries> -- search through only queries. +Search through only channels. -=item C<-all> -- search both queries and channels (Default). +=item C<-queries> -=item C<-active> -- limit search to only window items with activity. +Search through only queries. -=item C<-exact> -- enable exact-substring matching +=item C<-all> -=item C<-flex> -- enable flex-string matching +search both queries and channels (Default). + +=item C<-active> + +Lmit search to only window items with activity. + +=item C<-exact> + +Enable exact-substring matching + +=item C<-flex> + +Enable flex-string matching =back @@ -83,38 +95,65 @@ activated: =over 4 -=item C - Exit the mode without changing windows. +=item C + + Exit the mode without changing windows. + +=item C + +Exit, as above. + +=item C + +Rotate the list of window candidates forward by one item -=item C - Exit, as above. +=item C -=item C - Rotate the list of window candidates forward by 1 +Rotate the list of window candidates backward by one item -=item C - Rotate the list of window candidates backward by 1 +=item C -=item C - Toggle 'Active windows only' filter +Toggle 'Active windows only' filter -=item C - Switch between 'Flex' and 'Exact' matching. +=item C -=item C - Select a network or server to filter candidates by +Switch between 'Flex' and 'Exact' matching. -=item C - Clear the current search string +=item C -=item C - Cycle between showing only queries, channels, or all. +Select a network or server to filter candidates by -=item C - Filter candidates by current search string, and then reset - the search string +=item C -=item C - Select the current head of the candidate list (the green one) +Clear the current search string -=item C - Select the current head of the list, without exiting the - switching mode. The head is then moved one place to the right, - allowing one to cycle through channels by repeatedly pressing space. +=item C -=item C - B<[currently in development]> displays all possible completions - at the bottom of the current window. +Cycle between showing only queries, channels, or all. -=item I (C, etc) - Add that character to the current search - string. +=item C + +Filter candidates by current search string, and then reset +the search string + +=item C + +Select the current head of the candidate list (the green one) + +=item C + +Select the current head of the list, without exiting the +switching mode. The head is then moved one place to the right, +allowing one to cycle through channels by repeatedly pressing space. + +=item C + +B<[currently in development]> displays all possible completions +at the bottom of the current window. + +=item I (C, etc) + +Add that character to the current search string. =back @@ -122,13 +161,17 @@ activated: =over 4 -=item Using C-e (show actives), followed by repeatedly pressing space will cycle - through all your currently active windows. +=item * + +Using C-e (show actives), followed by repeatedly pressing space will cycle +through all your currently active windows. + +=item * -=item If you enter a search string fragment, and realise that more than one candidate - is still presented, rather than delete the whole string and modify it, you can - use C-SPC to 'lock' the current matching candidates, but allow you to search - through those matches alone. +If you enter a search string fragment, and realise that more than one candidate +is still presented, rather than delete the whole string and modify it, you +can use C-SPC to 'lock' the current matching candidates, but allow you to +search through those matches alone. =back -- cgit v1.2.3