Changeset b10f340 for perl


Ignore:
Timestamp:
Jan 10, 2008, 1:01:32 AM (13 years ago)
Author:
Nelson Elhage <nelhage@mit.edu>
Branches:
master, barnowl_perlaim, debian, 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:
1 edited

Legend:

Unmodified
Added
Removed
  • perl/modules/IRC/lib/BarnOwl/Module/IRC.pm

    r6858d2d rb10f340  
    3030
    3131sub startup {
    32     BarnOwl::new_variable_string('irc:nick', {default => $ENV{USER}});
    33     BarnOwl::new_variable_string('irc:user', {default => $ENV{USER}});
    34     BarnOwl::new_variable_string('irc:name', {default => ""});
    35     BarnOwl::new_variable_bool('irc:spew', {default => 0});
     32    BarnOwl::new_variable_string('irc:nick', {
     33        default     => $ENV{USER},
     34        summary     => 'The default IRC nickname',
     35        description => 'By default, irc-connect will use this nick '  .
     36        'when connecting to a new server. See :help irc-connect for ' .
     37        'more information.'
     38       });
     39
     40    BarnOwl::new_variable_string('irc:user', {
     41        default => $ENV{USER},
     42        summary => 'The IRC "username" field'
     43       });
     44        BarnOwl::new_variable_string('irc:name', {
     45        default => "",
     46        summary     => 'A short name field for IRC',
     47        description => 'A short (maybe 60 or so chars) piece of text, ' .
     48        'originally intended to display your real name, which people '  .
     49        'often use for pithy quotes and URLs.'
     50       });
     51   
     52    BarnOwl::new_variable_bool('irc:spew', {
     53        default     => 0,
     54        summary     => 'Show unhandled IRC events',
     55        description => 'If set, display all unrecognized IRC events as ' .
     56        'admin messages. Intended for debugging and development use only '
     57       });
     58   
    3659    register_commands();
    3760    register_handlers();
     
    97120            "password=s" => \$password,
    98121            "port=i"     => \$port,
     122            "nick=s"     => \$nick,
    99123        );
    100124        $host = shift @ARGV or die("Usage: $cmd HOST\n");
Note: See TracChangeset for help on using the changeset viewer.