From 4221ecd6c932617167b810c7ca0ec9655788ae2a Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 8 Jul 2011 10:29:08 +0100 Subject: update install instructions to mention IrssiX modules, and generate a readme. --- longify/README.pod | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 longify/README.pod (limited to 'longify/README.pod') diff --git a/longify/README.pod b/longify/README.pod new file mode 100644 index 0000000..25a7f8e --- /dev/null +++ b/longify/README.pod @@ -0,0 +1,77 @@ +=pod + +=head1 NAME + +longify-urls.pl + +=head1 DESCRIPTION + +Checks channel messages for 'shortened' links, and expands them to their +final target address. + +=head1 INSTALLATION + +=over + +=item Download the modules from L +and place them in a directory known to Perl (One of the default system locations +for perl modules, or somewhere that is listed in the C<$PERL5LIB> environment variable). +They should be placed in a subdirectory named C in whichever module directory +you choose. + +=item Copy this script into your F<~/.irssi/scripts/> directory and load with +C>. + +=back + +=head1 USAGE + +Load it. + +B The lookup to check if a link is shortened runs in the background, so it +won't affect the running of Irssi, but the message containing the link is queued +until either a response comes back, or the timeout (~2 seconds) is hit. + +=head1 AUTHORS + +Copyright E 2011 Tom Feist Cshabble+irssi@metavore.orgE> + +=head1 LICENCE + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +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 + + +=head1 TODO + +=over + +=item * Not tested with simultaneous lookups + +=item * User-configurable timeout + +=item * some sort of list of shorteners? (saves having to look up every single url) + +=back + + + +=cut + -- cgit v1.2.3 From 60d269f91370c60befc394a741b59aaffb7acede Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 8 Jul 2011 10:35:35 +0100 Subject: fix formatting error in POD, hopefully. --- longify/README.pod | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'longify/README.pod') diff --git a/longify/README.pod b/longify/README.pod index 25a7f8e..eb49086 100644 --- a/longify/README.pod +++ b/longify/README.pod @@ -13,13 +13,13 @@ final target address. =over -=item Download the modules from L +=item * Download the modules from L and place them in a directory known to Perl (One of the default system locations for perl modules, or somewhere that is listed in the C<$PERL5LIB> environment variable). -They should be placed in a subdirectory named C in whichever module directory +They should be placed in a subdirectory named C in whichever module directory you choose. -=item Copy this script into your F<~/.irssi/scripts/> directory and load with +=item * Copy this script into your F<~/.irssi/scripts/> directory and load with C>. =back -- cgit v1.2.3 From 6aab115aa9f9374b3ceb599de6bc34f62d9cbbab Mon Sep 17 00:00:00 2001 From: Tom Feist Date: Fri, 8 Jul 2011 11:14:28 +0100 Subject: rebuilt README --- longify/README.pod | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'longify/README.pod') diff --git a/longify/README.pod b/longify/README.pod index eb49086..e161985 100644 --- a/longify/README.pod +++ b/longify/README.pod @@ -19,6 +19,8 @@ for perl modules, or somewhere that is listed in the C<$PERL5LIB> environment va They should be placed in a subdirectory named C in whichever module directory you choose. +=item * Copy the F file into your F<~/.irssi/> directory. + =item * Copy this script into your F<~/.irssi/scripts/> directory and load with C>. @@ -67,7 +69,7 @@ THE SOFTWARE. =item * User-configurable timeout -=item * some sort of list of shorteners? (saves having to look up every single url) +=item * deal with utf-8 (that stupid arrow site). =back -- cgit v1.2.3