NAME
POE::Component::IRC::Plugin::RTorrentStatus - A PoCo-IRC plugin which
prints RTorrent status messages to IRC
SYNOPSIS
To quickly get an IRC bot with this plugin up and running, you can use
App::Pocoirc:
$ pocoirc -s irc.perl.org -j '#bots' -a 'RTorrentStatus{ "Channels": ["#bots"], "Torrent_log": "/tmp/torrentlog" }'
Or use it in your code:
use POE::Component::IRC::Plugin::RTorrentStatus;
# post status updates to #foobar
$irc->plugin_add(Torrent => POE::Component::IRC::Plugin::RTorrentStatus->new(
Torrent_log => '/tmp/torrentlog',
Channels => ['#foobar'],
));
DESCRIPTION
POE::Component::IRC::Plugin::RTorrentStatus is a POE::Component::IRC
plugin. It reads a log file generated by the included irctor-queue
program and posts messages to IRC describing the events. See the
documentation for irctor-queue on how to set it up with RTorrent.
-MyBot:#channel- Enqueued: ubuntu-9.10-desktop-i386.iso (700MB, by hinrik)
-MyBot:#channel- Aborted: ubuntu-9.10-desktop-i386.iso (10% done, ratio: 0.05, up: 35MB)
-MyBot:#channel- Enqueued: ubuntu-9.10-desktop-amd64.iso (700MB, by hinrik)
-MyBot:#channel- Finished: ubuntu-9.10-desktop-amd64.iso in 20 minutes (597kB/s); Checking hash...
-MyBot:#channel- Hashed: ubuntu-9.10-desktop-amd64.iso in 10 seconds
-MyBot:#channel- Removed: ubuntu-9.10-desktop-amd64.iso (ratio: 2.00, up: 1400MB)
And if you've got unraring enabled:
-MyBot:#channel- Enqueued: foobar (100MB, by hinrik)
-MyBot:#channel- Finished: foobar in 10 minutes (171kB/s); Checking hash...
-MyBot:#channel- Hashed: foobar in 5 seconds; 1 archive to unrar
-MyBot:#channel- Unrared: foobar in 5 seconds (1 archive)
-MyBot:#channel- Removed: foobar (ratio: 2.00, uploaded: 200MB)
METHODS
"new"
Takes the following arguments:
'Torrent_log', the path to the torrent log file generated by the
irctor-queue program. This argument is required.
'Channels', an array reference of channels to post messages to. You must
specify at least one channel.
'Color', whether to print colorful status messages. True by default.
'Method', how you want messages to be delivered. Valid options are
'notice' (the default) and 'privmsg'.
Returns a plugin object suitable for feeding to POE::Component::IRC's
"plugin_add" method.
AUTHOR
Hinrik Örn Sigurðsson, hinrik.sig@gmail.com
LICENSE AND COPYRIGHT
Copyright 2010 Hinrik Örn Sigurðsson
This program is free software, you can redistribute it and/or modify it
under the same terms as Perl itself.