NAME

pocoirc - A command line tool for launching POE::Component::IRC clients

SYNOPSIS

pocoirc <options>

 Options:
   -c, --check                  Check if config is valid and code compiles
   -f FOO, --config FOO         Use config file FOO
   -d, --daemonize              Run in the background
   -v, --verbose                Show IRC protocol messages
   -t, --trace                  Show all IRC events
   -L, --list-plugins           List available plugins
   -b, --no-color               Don't use terminal colors
   -i, --interactive            Interactive mode (type 'help' for help)
   -V, --version                Print version
   -h, --help                   Print this usage message

 When not using a config file, you can use these:
   -s FOO, --server FOO         Connect to server FOO
   -p FOO, --port FOO           Connect to port FOO
   -P FOO, --password FOO       Use server password FOO
   -n FOO, --nickname FOO       Use nickname FOO
   -u FOO, --username FOO       Use username FOO
   -r FOO, --realname FOO       Use realname FOO
   -j FOO, --join FOO           Join channel FOO (see below)
   -N FOO, --nspassword FOO     NickServ password (see below)
   -a FOO, --plugin FOO         Add plugin FOO (see below)
   -6, --ipv6,                  Use IPv6
   -S, --ssl,                   Use SSL
   -A FOO:BAR, --arg FOO:BAR    Arbitrary argument to POE::Component::IRC
   -C FOO, --class FOO          Component class, e.g. State or Qnet::State
   -I FOO, --lib FOO            A Perl library directory to include
   -l FOO, --log-file FOO       Write status messages to this log file
   -F FOO, --pid-file FOO       Use this file as a pid file

When you specify a pid file with -F, pocoirc will refuse to run if the pid file already exists.

Arguments to the -j option can be a channel name (e.g. '#foo') or a channel name and a password separated by a comma (e.g. '#foo,bar'). If you specify any channels, an AutoJoin plugin with these parameters will be added to your IRC component.

When you use the -N option, a NickServID plugin will be added for you with the supplied password.

Arguments to the -a option should consist of the class name (the "POE::Component::IRC::Plugin::" prefix can be omitted if it applies), zero or more whitespace, and optionally a JSON hash of arguments to the plugin's constructor:

 -a AutoJoin
 -a 'AutoJoin{"ReJoinOnKick":0}'
 -a 'AutoJoin{"ReJoinOnKick":0,"Channels":["#foo","#bar"]}'
 -a 'AutoJoin {"ReJoinOnKick": 0, "Channels": ["#foo", "#bar"]}'

For documentation of the configuration file, do "perldoc App::Pocoirc".

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.