From 41faea8a07e5b921711c6eabc28b5bb19b6d19e5 Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Thu, 21 Apr 2011 23:12:49 +0100 Subject: * quit-notify/README.pod: added documentation for notifyquit, and generated readme file. --- quit-notify/README.pod | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 quit-notify/README.pod (limited to 'quit-notify/README.pod') diff --git a/quit-notify/README.pod b/quit-notify/README.pod new file mode 100644 index 0000000..d2c0978 --- /dev/null +++ b/quit-notify/README.pod @@ -0,0 +1,92 @@ +=pod + +=head1 NAME + +notifyquit.pl + +=head1 DESCRIPTION + +A script intended to alert people to the fact that their conversation partners +have quit or left the channel, especially useful in high-traffic channels, or +where you have C ignored. + +=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. + +Copy into your F<~/.irssi/scripts/> directory and load with +C>. + +=head1 SETUP + +This script provides a single setting: + +C, which defaults to "C" + +The setting is a space-separated list of regular expressions in the format +C. If the extracted nickname matches any of these patterns, it isa +assumed to be a false-positive match, and is sent to the channel with no +further confirmation. + +=head1 USAGE + +When responding to users in a channel in the format C<$theirnick: some message> +(where the C<:> is not necessarily a colon, but the value of your +C setting), this script will check that the nickname still +exists in the channel, and will prompt you for confirmation if they have +since left. + +It is intended for use for people who ignore C, etc, and +try to respond to impatient people, or those with a bad connection. + +To send the message once prompted, either hit C, or C. Pressing C +will abort sending, but leave the message in your input buffer just in case +you want to keep it. + +=head1 AUTHORS + +Original Copyright E 2011 Jari Matilainen Cvague!#irssi@freenodeE> + +Some extra bits +Copyright E 2011 Tom Feist Cshabble+irssi@metavore.orgE> + +=head1 LICENCE + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +=head1 BUGS + +I + +Please report any problems to L +or moan about it in C<#irssi@Freenode>. + +=head1 TODO + +=over 4 + +=item * Keep a watchlist of nicks in the channel, and only act to confirm if +they quit shortly before/during you typing a response. + +=back + + + +=cut + -- cgit v1.2.3