From 23b75ab5c2aba863531eb9df34452ee979653180 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Mon, 18 Apr 2011 15:59:43 +0100 Subject: vim-mode/vim_mode: updated docs (only partially, to see how it looks) --- vim-mode/README.pod | 106 +++++++++++++++++++++++++++++++++----------------- vim-mode/vim_mode.pl | 108 ++++++++++++++++++++++++++++++++------------------- 2 files changed, 139 insertions(+), 75 deletions(-) (limited to 'vim-mode') diff --git a/vim-mode/README.pod b/vim-mode/README.pod index fc52701..4783c23 100644 --- a/vim-mode/README.pod +++ b/vim-mode/README.pod @@ -239,11 +239,11 @@ C<:se[t] {option} {value}> - change option to value =over 4 -=item C<:map {lhs}> - display mappings starting with {lhs} +=item * C<:map {lhs}> - display mappings starting with {lhs} -=item C<:map {lhs} {rhs}> - add mapping +=item * C<:map {lhs} {rhs}> - add mapping -=item C<:unm[ap] {lhs}> - remove custom mapping +=item * C<:unm[ap] {lhs}> - remove custom mapping =back @@ -257,17 +257,17 @@ CE> notation is used =over 4 -=item CC-AE> - CC-ZE>, +=item * CC-AE> - CC-ZE>, -=item CC-^E>, CC-6E> +=item * CC-^E>, CC-6E> -=item CSpaceE> +=item * CSpaceE> -=item CCRE> - Enter +=item * CCRE> - Enter -=item CBSE> - Backspace +=item * CBSE> - Backspace -=item CNopE> - No-op (Do Nothing). +=item * CNopE> - No-op (Do Nothing). =back @@ -279,23 +279,23 @@ Examples: =over 4 -=item C<:map w W> - to remap w to work like W +=item * C<:map w W> - to remap w to work like W -=item C<:map gb :bnext> - to map gb to call :bnext +=item * C<:map gb :bnext> - to map gb to call :bnext -=item C<:map gB :bprev> +=item * C<:map gB :bprev> -=item C<:map g1 :b 1> - to map g1 to switch to buffer 1 +=item * C<:map g1 :b 1> - to map g1 to switch to buffer 1 -=item C<:map gb :b> - to map gb to :b, 1gb switches to buffer 1, 5gb to 5 +=item * C<:map gb :b> - to map gb to :b, 1gb switches to buffer 1, 5gb to 5 -=item C<:map EC-LE /clear> - map Ctrl-L to irssi command /clear +=item * C<:map EC-LE /clear> - map Ctrl-L to irssi command /clear -=item C<:map EC-GE /window goto 1> +=item * C<:map EC-GE /window goto 1> -=item C<:map EC-EE > - disable , it does nothing now +=item * C<:map EC-EE > - disable , it does nothing now -=item C<:unmap EC-EE> - restore default behavior of CC-EE> +=item * C<:unmap EC-EE> - restore default behavior of CC-EE> after disabling it =back @@ -312,19 +312,33 @@ following settings are available: =over 4 -=item utf8: support UTF-8 characters, boolean, default on +=item * utf8 -=item debug: enable debug output, boolean, default off +Support UTF-8 characters, boolean, default on -=item cmd_seq: char that when double-pressed simulates CEscE>, string, default '' (disabled) +=item debug -=item start_cmd: start every line in command mode, boolean, default off +Enable debug output, boolean, default off -=item max_undo_lines: size of the undo buffer. Integer, default 50 items. +=item cmd_seq -=item ex_history_size: number of items stored in the ex-mode history. Integer, default 100. +Char that when double-pressed simulates CEscE>, string, default '' (disabled) -=item prompt_leading_space: determines whether ex mode prepends a space to the displayed input. Boolean, default on +=item start_cmd + +Start every line in command mode, boolean, default off + +=item max_undo_lines + +Sze of the undo buffer. Integer, default 50 items. + +=item ex_history_size + +Number of items stored in the ex-mode history. Integer, default 100. + +=item prompt_leading_space + +Ddetermines whether ex mode prepends a space to the displayed input. Boolean, default on =back @@ -394,13 +408,19 @@ THE SOFTWARE. =over 4 -=item count before register doesn't work: e.g. 3"ap doesn't work, but "a3p does +=item * + +count before register doesn't work: e.g. 3"ap doesn't work, but "a3p does + +=item * -=item mapping an incomplete ex-command doesn't open the ex-mode with the partial - command (e.g. C<:map gb :b> causes an error instead of opening the ex-mode and - displaying C<:bEcursorE>) +mapping an incomplete ex-command doesn't open the ex-mode with the partial +command (e.g. C<:map gb :b> causes an error instead of opening the ex-mode and +displaying C<:bEcursorE>) -=item undo/redo cursor positions are mostly wrong +=item * + + undo/redo cursor positions are mostly wrong =back @@ -408,21 +428,31 @@ THE SOFTWARE. =over 4 -=item History: +=item * + +History: =over 4 -=item C< * /,?,n,N> to search through history (like rl_history_search.pl) +=item * + + C< * /,?,n,N> to search through history (like rl_history_search.pl) =back -=item Window switching (C<:b>) +=item * + +Window switching (C<:b>) =over 4 -=item Tab completion of window(-item) names +=item * + +Tab completion of window(-item) names -=item non-sequential matches(?) +=item * + +non-sequential matches(?) =back @@ -438,7 +468,11 @@ Things we're not ever likely to do: =over 4 -=item Macros +=item * Macros =back + + +=cut + diff --git a/vim-mode/vim_mode.pl b/vim-mode/vim_mode.pl index 4c63bf1..ae43d6b 100644 --- a/vim-mode/vim_mode.pl +++ b/vim-mode/vim_mode.pl @@ -239,11 +239,11 @@ C<:se[t] {option} {value}> - change option to value =over 4 -=item C<:map {lhs}> - display mappings starting with {lhs} +=item * C<:map {lhs}> - display mappings starting with {lhs} -=item C<:map {lhs} {rhs}> - add mapping +=item * C<:map {lhs} {rhs}> - add mapping -=item C<:unm[ap] {lhs}> - remove custom mapping +=item * C<:unm[ap] {lhs}> - remove custom mapping =back @@ -257,17 +257,17 @@ CE> notation is used =over 4 -=item CC-AE> - CC-ZE>, +=item * CC-AE> - CC-ZE>, -=item CC-^E>, CC-6E> +=item * CC-^E>, CC-6E> -=item CSpaceE> +=item * CSpaceE> -=item CCRE> - Enter +=item * CCRE> - Enter -=item CBSE> - Backspace +=item * CBSE> - Backspace -=item CNopE> - No-op (Do Nothing). +=item * CNopE> - No-op (Do Nothing). =back @@ -279,23 +279,23 @@ Examples: =over 4 -=item C<:map w W> - to remap w to work like W +=item * C<:map w W> - to remap w to work like W -=item C<:map gb :bnext> - to map gb to call :bnext +=item * C<:map gb :bnext> - to map gb to call :bnext -=item C<:map gB :bprev> +=item * C<:map gB :bprev> -=item C<:map g1 :b 1> - to map g1 to switch to buffer 1 +=item * C<:map g1 :b 1> - to map g1 to switch to buffer 1 -=item C<:map gb :b> - to map gb to :b, 1gb switches to buffer 1, 5gb to 5 +=item * C<:map gb :b> - to map gb to :b, 1gb switches to buffer 1, 5gb to 5 -=item C<:map EC-LE /clear> - map Ctrl-L to irssi command /clear +=item * C<:map EC-LE /clear> - map Ctrl-L to irssi command /clear -=item C<:map EC-GE /window goto 1> +=item * C<:map EC-GE /window goto 1> -=item C<:map EC-EE > - disable , it does nothing now +=item * C<:map EC-EE > - disable , it does nothing now -=item C<:unmap EC-EE> - restore default behavior of CC-EE> +=item * C<:unmap EC-EE> - restore default behavior of CC-EE> after disabling it =back @@ -312,19 +312,33 @@ following settings are available: =over 4 -=item utf8: support UTF-8 characters, boolean, default on +=item * utf8 -=item debug: enable debug output, boolean, default off +Support UTF-8 characters, boolean, default on -=item cmd_seq: char that when double-pressed simulates CEscE>, string, default '' (disabled) +=item debug -=item start_cmd: start every line in command mode, boolean, default off +Enable debug output, boolean, default off -=item max_undo_lines: size of the undo buffer. Integer, default 50 items. +=item cmd_seq -=item ex_history_size: number of items stored in the ex-mode history. Integer, default 100. +Char that when double-pressed simulates CEscE>, string, default '' (disabled) -=item prompt_leading_space: determines whether ex mode prepends a space to the displayed input. Boolean, default on +=item start_cmd + +Start every line in command mode, boolean, default off + +=item max_undo_lines + +Sze of the undo buffer. Integer, default 50 items. + +=item ex_history_size + +Number of items stored in the ex-mode history. Integer, default 100. + +=item prompt_leading_space + +Ddetermines whether ex mode prepends a space to the displayed input. Boolean, default on =back @@ -394,13 +408,19 @@ THE SOFTWARE. =over 4 -=item count before register doesn't work: e.g. 3"ap doesn't work, but "a3p does +=item * + +count before register doesn't work: e.g. 3"ap doesn't work, but "a3p does -=item mapping an incomplete ex-command doesn't open the ex-mode with the partial - command (e.g. C<:map gb :b> causes an error instead of opening the ex-mode and - displaying C<:bEcursorE>) +=item * -=item undo/redo cursor positions are mostly wrong +mapping an incomplete ex-command doesn't open the ex-mode with the partial +command (e.g. C<:map gb :b> causes an error instead of opening the ex-mode and +displaying C<:bEcursorE>) + +=item * + + undo/redo cursor positions are mostly wrong =back @@ -408,21 +428,31 @@ THE SOFTWARE. =over 4 -=item History: +=item * + +History: =over 4 -=item C< * /,?,n,N> to search through history (like rl_history_search.pl) +=item * + + C< * /,?,n,N> to search through history (like rl_history_search.pl) =back -=item Window switching (C<:b>) +=item * + +Window switching (C<:b>) =over 4 -=item Tab completion of window(-item) names +=item * + +Tab completion of window(-item) names -=item non-sequential matches(?) +=item * + +non-sequential matches(?) =back @@ -438,7 +468,7 @@ Things we're not ever likely to do: =over 4 -=item Macros +=item * Macros =back @@ -455,9 +485,9 @@ use Irssi::TextUI; # for sbar_items_redraw use Irssi::Irc; # necessary for 0.8.14 -use vars qw($VERSION %IRSSI); -$VERSION = "1.0.1"; -%IRSSI = + +our $VERSION = "1.0.2"; +our %IRSSI = ( authors => "Tom Feist (shabble), Simon Ruderich (rudi_s)", contact => 'shabble+irssi@metavore.org, ' -- cgit v1.2.3