[824] in BarnOwl Developers
[D-O-H] r818 - trunk/owl/perl/modules/IRC/lib/BarnOwl/Module
daemon@ATHENA.MIT.EDU (nelhage@MIT.EDU)
Thu Oct 29 18:10:06 2009
Resent-From: nelhage@mit.edu
Resent-To: barnowl-dev-mtg@charon.mit.edu
To: dirty-owl-hackers@mit.edu
From: nelhage@MIT.EDU
Reply-to: dirty-owl-hackers@MIT.EDU
Date: Thu, 10 Jan 2008 01:01:33 -0500 (EST)
Author: nelhage
Date: 2008-01-10 01:01:32 -0500 (Thu, 10 Jan 2008)
New Revision: 818
Modified:
trunk/owl/perl/modules/IRC/lib/BarnOwl/Module/IRC.pm
Log:
Document the IRC variables
Modified: trunk/owl/perl/modules/IRC/lib/BarnOwl/Module/IRC.pm
===================================================================
--- trunk/owl/perl/modules/IRC/lib/BarnOwl/Module/IRC.pm 2008-01-10 05:32:44 UTC (rev 817)
+++ trunk/owl/perl/modules/IRC/lib/BarnOwl/Module/IRC.pm 2008-01-10 06:01:32 UTC (rev 818)
@@ -29,10 +29,33 @@
our %ircnets;
sub startup {
- BarnOwl::new_variable_string('irc:nick', {default => $ENV{USER}});
- BarnOwl::new_variable_string('irc:user', {default => $ENV{USER}});
- BarnOwl::new_variable_string('irc:name', {default => ""});
- BarnOwl::new_variable_bool('irc:spew', {default => 0});
+ BarnOwl::new_variable_string('irc:nick', {
+ default => $ENV{USER},
+ summary => 'The default IRC nickname',
+ description => 'By default, irc-connect will use this nick ' .
+ 'when connecting to a new server. See :help irc-connect for ' .
+ 'more information.'
+ });
+
+ BarnOwl::new_variable_string('irc:user', {
+ default => $ENV{USER},
+ summary => 'The IRC "username" field'
+ });
+ BarnOwl::new_variable_string('irc:name', {
+ default => "",
+ summary => 'A short name field for IRC',
+ description => 'A short (maybe 60 or so chars) piece of text, ' .
+ 'originally intended to display your real name, which people ' .
+ 'often use for pithy quotes and URLs.'
+ });
+
+ BarnOwl::new_variable_bool('irc:spew', {
+ default => 0,
+ summary => 'Show unhandled IRC events',
+ description => 'If set, display all unrecognized IRC events as ' .
+ 'admin messages. Intended for debugging and development use only '
+ });
+
register_commands();
register_handlers();
BarnOwl::filter('irc type ^IRC$');
@@ -96,6 +119,7 @@
"ssl" => \$ssl,
"password=s" => \$password,
"port=i" => \$port,
+ "nick=s" => \$nick,
);
$host = shift @ARGV or die("Usage: $cmd HOST\n");
if(!$alias) {
