| 1 | #!/usr/bin/perl -wT |
| 2 | use v5.14; |
| 3 | |
| 4 | use App::Devbot; |
| 5 | |
| 6 | App::Devbot->run; |
| 7 | |
| 8 | __END__ |
| 9 | |
| 10 | =head1 NAME |
| 11 | |
| 12 | devbot - IRC bot which helps development |
| 13 | |
| 14 | =head1 SYNOPSIS |
| 15 | |
| 16 | # devbot will connect to OFTC with SSL, join #mychan and log everything there. Its nickname will be 'devbot'. |
| 17 | devbot --channel "#mychan" |
| 18 | |
| 19 | # devbot will connect to Freenode without SSL, join #asd and #qwe, and log everything there. Its nickname will be 'loggerbot'. |
| 20 | devbot --nick loggerbot --server chat.freenode.net --port 6667 --no-ssl --channel "#asd" --channel "#qwe" |
| 21 | |
| 22 | # devbot will identify to NickServ with password 'passWORD123', join #bestchan on OFTC and store files sent by channel users. |
| 23 | devbot --nick mybot --password passWORD123 --channel '#bestchan' --no-log --store-files |
| 24 | |
| 25 | =head1 DESCRIPTION |
| 26 | |
| 27 | devbot is an IRC bot which helps developers collaborate. |
| 28 | |
| 29 | Right now, it only does channel logging and file storage. It might do more in the future. |
| 30 | |
| 31 | =head1 OPTIONS |
| 32 | |
| 33 | =over |
| 34 | |
| 35 | =item B<--nick> I<nickname> |
| 36 | |
| 37 | The nickname of devbot. Defaults to devbot. |
| 38 | |
| 39 | =item B<--password> I<password> |
| 40 | |
| 41 | If supplied, identify to NickServ with this password |
| 42 | |
| 43 | =item B<--server> I<hostname> |
| 44 | |
| 45 | The server to connect to. Defaults to irc.oftc.net. |
| 46 | |
| 47 | =item B<--port> I<port> |
| 48 | |
| 49 | The port to connect to. Defaults to 6697. |
| 50 | |
| 51 | =item B<--ssl>, B<--no-ssl> |
| 52 | |
| 53 | B<--ssl> enables connecting to the server with SSL, B<--no-ssl> disables this. Defaults to B<--ssl>. |
| 54 | |
| 55 | =item B<--channel> I<channel> |
| 56 | |
| 57 | Makes devbot connect to I<channel>. Can be supplied multiple times for multiple channels. Has no default value. |
| 58 | |
| 59 | =item B<--log>, B<--no-log> |
| 60 | |
| 61 | B<--log> enables logging events to 'logs/I<CHANNEL>/I<DATE>.txt'. B<--no-log> disables logging. Defaults to B<--log>. |
| 62 | |
| 63 | =item B<--store-files>, B<--no-store-files> |
| 64 | |
| 65 | B<--store-files> enables storing files received via DCC to 'files/I<FILENAME>'. Files are only accepted if the sender and devbot share a channel. B<Only use when all channel users are trusted>. B<--no-store-files> disables storing files. Defaults to <--no-store-files>. |
| 66 | |
| 67 | =item B<--trace>, B<--no-trace> |
| 68 | |
| 69 | B<--trace> enables POE::Component::IRC::State tracing. Useful for debugging. B<--no-trace> disables tracing. Defaults to B<--no-trace>. |
| 70 | |
| 71 | =back |
| 72 | |
| 73 | =head1 CAVEATS |
| 74 | |
| 75 | As stated above, the B<--store-files> option should only be used on private channels where every user is trusted. |
| 76 | |
| 77 | =head1 AUTHOR |
| 78 | |
| 79 | Marius Gavrilescu, E<lt>marius@ieval.roE<gt> |
| 80 | |
| 81 | =head1 COPYRIGHT AND LICENSE |
| 82 | |
| 83 | Copyright (C) 2013 by Marius Gavrilescu |
| 84 | |
| 85 | This library is free software; you can redistribute it and/or modify |
| 86 | it under the same terms as Perl itself, either Perl version 5.14.2 or, |
| 87 | at your option, any later version of Perl 5 you may have available. |