doc/infobot.users.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 infobot.users - User accounts database for infobot
   6
   7 =head1 SYNOPSIS
   8
   9   # Please edit to your needs.
  10   # "local" is used for CLI mode
  11   # Passwords can be generated with mkpasswd in linux
  12
  13   _default
  14   --FLAGS               amrt
  15   --HOSTS               *!*@*
  16
  17   local
  18   --FLAGS               Aemnorst
  19   --HOSTS               local!local@local
  20   --PASS                xxfxfIfoJHdYg
  21
  22   timriker
  23   --FLAGS               Aemnorst
  24   --HOSTS               *!~timr@TimRiker.active.supporter.pdpc
  25   --PASS                xxfxfIfoJHdYg
  26
  27   xk
  28   --FLAGS               emnorst
  29   --HOSTS               *!xk@example.com
  30   --HOSTS               *!xk@superbox.home.org
  31   --PASS                5K/rmJPzwxJhU
  32
  33 =head1 DESCRIPTION
  34
  35 This file controls who has access to use your infobot.
  36
  37 =head1 FIELDS
  38
  39 There are various fields allowed in your file. Whitespace is ignored, and as
  40 usual, any line starting with a C<#> is treated as a comment.
  41
  42 The first non whitespace/comment line in your file, is the user name for the
  43 account you are about to define. Take note that a special username called
  44 C<_default>, is meant to define what everyone who doesnt have an account in this
  45 file should use for permissions.
  46
  47 Also, the special user name C<local>, is used when you run the bot in B<CLI>
  48 mode (console only, no B<IRC> connection). As well, the C<local> user requires a
  49 special hostmask of S<I<local!local@local>>.
  50
  51 Below is a list of the valid options available for each user account.
  52
  53 =over
  54
  55 =item B<--FLAGS>
  56
  57 This field is a list of possible flags that this account has. Think of them as
  58 similar to irc user modes (although, with different meanings).
  59
  60 Here is a list of the current flags available, and their meanings:
  61
  62 I<Note: Modes flags are case sensitive>
  63
  64 =over
  65
  66 =item *
  67
  68 B<A> - bot administration over /msg (default is only via DCC CHAT)
  69
  70 =item *
  71
  72 B<O> - dynamic ops (as on channel). (automatic +o)
  73
  74 =item *
  75
  76 B<T> - add topics.
  77
  78 =item *
  79
  80 B<a> - ask/request factoid.
  81
  82 =item *
  83
  84 B<m> - modify factoid. (includes renaming)
  85
  86 =item *
  87
  88 B<n> - bot owner, can "reload"
  89
  90 =item *
  91
  92 B<o> - master of bot (automatic +amrt).
  93
  94 =over
  95
  96 =item *
  97
  98 Can search on factoid strings shorter than 2 chars
  99
 100 =item *
 101
 102 Can tell bot to join new channels
 103
 104 =item *
 105
 106 Can [un]lock factoids
 107
 108 =back
 109
 110 =item *
 111
 112 B<r> - remove factoid.
 113
 114 =item *
 115
 116 B<t> - teach/add factoid.
 117
 118 =item *
 119
 120 B<s> - Bypass +silent on channels
 121
 122 =back
 123
 124 =item B<--HOSTS>
 125
 126 This field is used to specify a hostmask that a user must appear from for the
 127 bot to consider them to be this specific account definition.
 128
 129 This hostmask takes the form of: I<nick!user@hostname>
 130
 131 I<Note: You can have this field multiple times>
 132
 133 =item B<--PASS>
 134
 135 This field used a C<crypt> formated password, that is used for B<DCC> chats to
 136 the bot, or if you need to identify yourself to the bot in the event that you
 137 come from a different host.
 138
 139 You can generate one using the C<mkpasswd> command, available on most systems.
 140
 141 For example:
 142
 143  infobot@myhost:~$ mkpasswd
 144  Password: test
 145  GVrl9PMBB0gpw
 146
 147 You can also change your password at anytime by sending the bot a C<chpass>
 148 command on B<IRC>.
 149
 150 =back
 151
 152 =head1 BUGS
 153
 154 At some point, it is likely that the C<local> account will be removed and
 155 implied to have full access.
 156
 157 =cut
 158