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