From 6fdd2aaa2e202f9c016018a353bf2f4cfeaa4675 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Sat, 24 Jul 2010 17:31:04 +0100 Subject: more doc stuffs --- docs/Guide.pod | 13 +++++++------ docs/Irssi.pod | 8 +++++++- docs/Signals.pod | 16 ++++++++++++++++ 3 files changed, 30 insertions(+), 7 deletions(-) diff --git a/docs/Guide.pod b/docs/Guide.pod index 9d52ed1..c0787bc 100644 --- a/docs/Guide.pod +++ b/docs/Guide.pod @@ -115,15 +115,17 @@ B =head1 USEFUL THINGS - =head2 Getting the Response Value of a Remote Command -B +B =head2 Getting the Response Value of a Local Command B +There is no simple way to achieve this. The data backing most common activities +can be extracted through other API calls, but there are some exceptions. + Maybe, look up the format, intercept gui print text, try to match it against what you're expecting? @@ -204,13 +206,12 @@ of their file. Whilst better than no documentation at all, a preferable approac is to allow that help to be accessed from within Irssi itself, using the C command. - our $help = "this is help for b"; + my $help = "this is help for b"; Irssi::command_bind('help', sub { if ($_[0] eq 'test_b') { Irssi::print($help, MSGLEVEL_CLIENTCRAP); Irssi::signal_stop; - return; } } ); @@ -220,7 +221,7 @@ matches our command, print some custom help and prevent the internal Irssi help function from being called. Otherwise, it falls back to the default help. -I on Freenode/#irssi>. +I on Freenode/#irssi>. =head3 Use Tab Completion @@ -305,7 +306,7 @@ This page was written by Tom Feist C, but draws on the help of many many people. The denizens of Freenode/#irssi have been particularly helpful, especially -C and C. +C and C. To report bugs or suggestions, email me at the address before, or come talk to me in C<#irssi> on C. diff --git a/docs/Irssi.pod b/docs/Irssi.pod index 49e83fa..5fa8413 100644 --- a/docs/Irssi.pod +++ b/docs/Irssi.pod @@ -628,6 +628,12 @@ Return new level number. See also L +=head3 C + +Reloads the current theme (set with C) from file. + +=head3 Miscellaneous + You can have user configurable texts in scripts that work just like irssi's internal texts that can be changed in themes. @@ -848,7 +854,7 @@ Formatting to POD and linking by Tom Feist Irssi::strip_codes Irssi::theme_register - Irssi::themes_reload + *Irssi::themes_reload Irssi::timeout_add Irssi::timeout_add_once diff --git a/docs/Signals.pod b/docs/Signals.pod index 93c79db..f3d18b9 100644 --- a/docs/Signals.pod +++ b/docs/Signals.pod @@ -2395,6 +2395,22 @@ B =back +Notes: + +Ordinary keys C are their ordinal (ascii) equivalents. + +Ctrl-key begins at 1 (C), but skips 13?, C and C both give the same +as C (10). Tab and C are equivalent (9). C does not appear to send +an observable sequence. + +C sends 127. + +CkeyE> sends a 27 (ESC) followed by the original key value. + +Arrow keys send usual meta-stuff (C<\e[I>). + +B + =back =head3 F: -- cgit v1.2.3