Changeset b10f340

Timestamp:

Jan 10, 2008, 1:01:32 AM (17 years ago)

Author:

Nelson Elhage <nelhage@mit.edu>

Branches:

master, barnowl_perlaim, debian, release-1.10, release-1.4, release-1.5, release-1.6, release-1.7, release-1.8, release-1.9

Children:

d536e72

Parents:

bc0d7bc

Message:

Document the IRC variables

File:

• perl/modules/IRC/lib/BarnOwl/Module/IRC.pm (modified) (2 diffs)

perl/modules/IRC/lib/BarnOwl/Module/IRC.pm

@@ -30 +30 @@
 
 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();
@@ -97 +120 @@
             "password=s" => \$password,
             "port=i"     => \$port,
+            "nick=s"     => \$nick,
         );
         $host = shift @ARGV or die("Usage: $cmd HOST\n");