]> git.donarmstrong.com Git - infobot.git/commitdiff
* New doc/ directory
authordjmcgrath <djmcgrath@c11ca15a-4712-0410-83d8-924469b57eb5>
Mon, 22 Oct 2007 15:02:44 +0000 (15:02 +0000)
committerdjmcgrath <djmcgrath@c11ca15a-4712-0410-83d8-924469b57eb5>
Mon, 22 Oct 2007 15:02:44 +0000 (15:02 +0000)
* Moved USAGE to doc/
* New pod formatted manual for infobot.users

git-svn-id: https://svn.code.sf.net/p/infobot/code/trunk@1592 c11ca15a-4712-0410-83d8-924469b57eb5

USAGE [deleted file]
doc/USAGE [new file with mode: 0644]
doc/infobot.users.pod [new file with mode: 0644]

diff --git a/USAGE b/USAGE
deleted file mode 100644 (file)
index 02b60ef..0000000
--- a/USAGE
+++ /dev/null
@@ -1,779 +0,0 @@
-# $Id$
-
-############
-# EXAMPLES #
-############
-
-DCC CHAT:
-.+chan #chan
-.chanset #chan +autojoin
-.chanset +autojoin
-.chanunset -autojoin
-.chanset -autojoin
-
-for list of configuration options, run:
-        ./scripts/findparam.pl
-
-
-=====
-<me> blootbot: test is testing
-<blootbot> me: okay
-<me> blootbot: testing?
-<blootbot> testing is testing
-
-<me> blootbot: tests is <REPLY> testing
-<blootbot> me: okay
-<me> blootbot: tests?
-<blootbot> testing
-
-<me> blootbot: cough is <ACTION> coughs
-<blootbot> me: okay
-<me> blootbot: cough
-* blootbot/#blootbot coughs
-
-<me> blootbot: test is <REPLY> What's (one|two|three|four|five|six)
-       times (seven|eight|nine|ten|eleven|twelve)?
-<blootbot> okay, me
-<me> blootbot: test
-<blootbot> What's four times nine?
-<me> blootbot: test?
-<blootbot> What's six times ten?
-
-<me> blootbot: op me is <ACTION> Mode change "+o $nick" on channel
-       $channel by $ident
-<blootbot> me: okay
-<me> blootbot: op me
-* blootbot/#debian-bots Mode change "+o me" on channel #blootbot by
-       blootbot
-
-<me> blootbot: no who am i is <REPLY> You are $nick!$user@$host on
-       $channel.
-<blootbot> okay, me
-<me> blootbot: who am i
-<blootbot> You are me!me@home.org on #blootbot.
-
-<me> blootbot: who last spoke is <REPLY> To my knowledge, $lastspeaker
-       was the last to say something worthwhile.
-<blootbot> me: okay
-<me> blootbot: who last spoke
-<blootbot> To my knowledge, me was the last to say something worthwhile.
-
-<me> blootbot: percentage is <REPLY> you are $randpercentage% lame
-<blootbot> me: okay
-<me> blootbot: percentage
-<blootbot> you are 79% lame
-
-<me> blootbot: slap $1 is <action> slaps $1
-<blootbot> me: okay, me
-<me> blootbot: slap Bob
- * blootbot slaps Bob
-<me> blootbot: forget cmd: slap (.*?)
-<blootbot> me: i forgot cmd: slap (.*?)
-
-
-#################
-# USER COMMANDS #
-#################
-
-Command: 4op
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       4op ...
-
-Example:
-       ...
-
-
-Command: dumpvars
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       dumpvars ...
-
-Example:
-       ...
-
-
-Command: kick
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       kick ...
-
-Example:
-       ...
-
-
-Command: ignore
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       ignore ...
-
-Example:
-       ...
-
-
-Command: ignorelist
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       ignorelist ...
-
-Example:
-       ...
-
-
-Command: unignore
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       unignore ...
-
-Example:
-       ...
-
-
-Command: clear ignorelist
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       clear ignorelist ...
-
-Example:
-       ...
-
-
-Command: lobotomy
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       lobotomy ...
-
-Example:
-       ...
-
-
-Command: unlobotomy
-=============
-Description:
-       ...
-
-Usage:
-       unlobotomy ...
-
-Example:
-       ...
-
-
-Command: op
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       op ...
-
-Example:
-       ...
-
-
-Command: say
-=============
-Description:
-       ...
-
-Usage: REQUIRES +o flag.
-       say ...
-
-Example:
-       ...
-
-
-Command: die
-=============
-Description:
-       ...
-
-Usage: REQUIRES +n flag.
-       die ...
-
-Example:
-       ...
-
-
-Command: jump
-=============
-Description:
-       ...
-
-Usage: REQUIRES +n flag.
-       jump ...
-
-Example:
-       ...
-
-
-Command: rehash
-=============
-Description:
-       ...
-
-Usage: REQUIRES +n flag.
-       rehash ...
-
-Example:
-       ...
-
-
-Command: set
-=============
-Description:
-       ...
-
-Usage: REQUIRES +n flag.
-       set ...
-
-Example:
-       ...
-
-
-Command: unset
-=============
-Description:
-       ...
-
-Usage: REQUIRES +n flag.
-       unset ...
-
-Example:
-       ...
-
-
-Command: chanstats
-=============
-Description:
-       Channel statistics is gathered while the bot is operation in those
-       channels it is located. They include: join, part, kick, ban, and
-       countless others.
-
-Usage:
-       chanstats [#channel]
-
-Example:
-       > blootbot: chanstats
-       <blootbot> i am on 2 channels: #blootbot #debian
-       <blootbot> i've cached 5 users distributed over 2 channels.     
-
-       > blootbot: chanstats #blootbot
-       <blootbot> On #blootbot, there have been 1 Join, 1 Op and 20
-               PublicMsgs.
-       <blootbot> At the moment, 3 Opped and 3 Total.
-
-
-Command: cmdstats
-=============
-Description:
-       ...
-
-Usage:
-       cmdstats ...
-
-Example:
-       ...
-
-
-Command: crypt
-=============
-Description:
-       ...
-
-Usage:
-       crypt ...
-
-Example:
-       ...
-
-
-Command: factinfo
-=============
-Description:
-       ...
-
-Usage:
-       factinfo ...
-
-Example:
-       ...
-
-
-Command: factstats
-=============
-Description:
-       ...
-
-Usage:
-       factstats ...
-
-Example:
-       ...
-
-
-Command: karma
-=============
-Description:
-       ...
-
-Usage:
-       karma ...
-
-Example:
-       ...
-
-
-Command: spell
-=============
-Description:
-       ...
-
-Usage:
-       spell ...
-
-Example:
-       ...
-
-
-Command: nslookup
-=============
-Description:
-       ...
-
-Usage:
-       nslookup ...
-
-Example:
-       ...
-
-
-Command: part
-=============
-Description:
-       ...
-
-Usage:
-       part ...
-
-Example:
-       ...
-
-
-Command: rot13
-=============
-Description:
-       ...
-
-Usage:
-       rot13 ...
-
-Example:
-       ...
-
-
-Command: wantNick
-=============
-Description:
-       ...
-
-Usage:
-       wantNick ...
-
-Example:
-       ...
-
-
-Command: join
-=============
-Description:
-       The bot can be commanded to join a channel if it is not already on
-       there in the case of a kick/ban, invite only or invalid key to
-       name a few typical case scenarios.
-
-       The channels which the bot can join is governed by the
-       configuration parameter labelled 'join_channels'. However, this
-       is ignored for those users with the +o flag in the user table.
-
-Usage:
-       join <#channel>[,key]
-
-Example:
-       > blootbot: join #blootbot
-       [blootbot] joining #blootbot
-       *** join/#debian blootbot (xk@router.home.org)
-       > blootbot: join #blootbot
-       [blootbot] I'm already on #blootbot...
-
-
-
-                    ======================================
-                               MODULE COMMANDS
-                    ======================================
-
-Command: babelfish
-=============
-Description:
-       ...
-
-Usage:
-       x from [language]: phrase
-
-Example:
-       ...
-
-
-Command: debian package
-=============
-Description:
-       ...
-
-Usage:
-       [] ...
-
-Example:
-       ...
-
-
-Command: dict
-=============
-Description:
-       ...
-
-Usage:
-       dict ...
-
-Example:
-       ...
-
-
-Command: freshmeat
-=============
-Description:
-       ...
-
-Usage:
-       freshmeat ...
-
-Example:
-       ...
-
-
-Command: google
-=============
-Description:
-       ...
-
-Usage:
-       google ...
-
-Example: DOES NOT WORK YET(??)
-       ...
-
-
-Command: insult
-=============
-Description:
-       ...
-
-Usage:
-       insult ...
-
-Example:
-       ...
-
-
-Command: kernel
-=============
-Description:
-       ...
-
-Usage:
-       kernel ...
-
-Example:
-       ...
-
-
-Command: lart
-=============
-Description:
-       ...
-
-Usage:
-       lart ...
-
-Example:
-       ...
-
-
-Command: list{keys|vals}
-=============
-Description:
-       ...
-
-Usage:
-       list{keys|vals} ...
-
-Example:
-       ...
-
-
-Command: nickometer
-=============
-Description:
-       ...
-
-Usage:
-       nickometer ...
-
-Example:
-       ...
-
-
-Command: quotes
-=============
-Description:
-       ...
-
-Usage:
-       quotes ...
-
-Example:
-       ...
-
-
-Command: rootwarn
-=============
-Description:
-       ...
-
-Usage:
-       rootwarn ...
-
-Example:
-       ...
-
-
-Command: seen
-=============
-Description:
-       ...
-
-Usage:
-       seen ...
-
-Example:
-       ...
-
-
-Command: listauth
-=============
-Description:
-       ...
-
-Usage:
-       listauth ...
-
-Example:
-       ...
-
-
-Command: slashdot
-=============
-Description:
-       ...
-
-Usage:
-       slashdot ...
-
-Example:
-       ...
-
-
-Command: debian contents
-=============
-Description:
-       ...
-
-Usage:
-       debian ...
-
-Example:
-       ...
-
-
-Command: topic
-=============
-Description:
-       ...
-
-Usage:
-       topic ...
-
-Example:
-       ...
-
-
-Command: countdown
-=============
-Description:
-       ...
-
-Usage:
-       countdown ...
-
-Example:
-       ...
-
-
-Command: uptime
-=============
-Description:
-       ...
-
-Usage:
-       uptime ...
-
-Example:
-       ...
-
-
-Command: weather
-=============
-Description:
-       ...
-
-Usage:
-       weather ...
-
-Example: DOES NOT WORK
-       ...
-
-
-Command: whatis
-=============
-Description:
-       ...
-
-Usage:
-       whatis ...
-
-Example: DOES NOT WORK
-       ...
-
-
-
-##################################
-# MISCELLANEOUS/FACTOID COMMANDS #
-##################################
-
-Command: forget
-=============
-Description:
-       ...
-
-Usage:
-       forget ...
-
-Example:
-       ...
-
-
-Command: {un|}lock
-=============
-Description:
-       ...
-
-Usage:
-       {un|}lock ...
-
-Example:
-       ...
-
-
-Command: rename
-=============
-Description:
-       ...
-
-Usage:
-       rename ...
-
-Example:
-       ...
-
-
-Command: substitution
-=============
-Description:
-       ...
-
-Usage:
-       $factoid =~ s/from/to/
-       $factoid =~ s#te/st/#test#g
-
-Example:
-       ...
-
-
-Command: karma set
-=============
-Description:
-       ...
-
-Usage:
-       $nick++
-       $nick--
-
-Example:
-       blootbot++
-       infobot--
-
-
-Command: maths
-=============
-Description:
-       ...
-
-Usage:
-       2 + 2
-
-Example:
-       ...
-
-
-Command: tell
-=============
-Description:
-       ...
-
-Usage:
-       tell <nick> about <factoid>
-
-Example:
-       ...
diff --git a/doc/USAGE b/doc/USAGE
new file mode 100644 (file)
index 0000000..02b60ef
--- /dev/null
+++ b/doc/USAGE
@@ -0,0 +1,779 @@
+# $Id$
+
+############
+# EXAMPLES #
+############
+
+DCC CHAT:
+.+chan #chan
+.chanset #chan +autojoin
+.chanset +autojoin
+.chanunset -autojoin
+.chanset -autojoin
+
+for list of configuration options, run:
+        ./scripts/findparam.pl
+
+
+=====
+<me> blootbot: test is testing
+<blootbot> me: okay
+<me> blootbot: testing?
+<blootbot> testing is testing
+
+<me> blootbot: tests is <REPLY> testing
+<blootbot> me: okay
+<me> blootbot: tests?
+<blootbot> testing
+
+<me> blootbot: cough is <ACTION> coughs
+<blootbot> me: okay
+<me> blootbot: cough
+* blootbot/#blootbot coughs
+
+<me> blootbot: test is <REPLY> What's (one|two|three|four|five|six)
+       times (seven|eight|nine|ten|eleven|twelve)?
+<blootbot> okay, me
+<me> blootbot: test
+<blootbot> What's four times nine?
+<me> blootbot: test?
+<blootbot> What's six times ten?
+
+<me> blootbot: op me is <ACTION> Mode change "+o $nick" on channel
+       $channel by $ident
+<blootbot> me: okay
+<me> blootbot: op me
+* blootbot/#debian-bots Mode change "+o me" on channel #blootbot by
+       blootbot
+
+<me> blootbot: no who am i is <REPLY> You are $nick!$user@$host on
+       $channel.
+<blootbot> okay, me
+<me> blootbot: who am i
+<blootbot> You are me!me@home.org on #blootbot.
+
+<me> blootbot: who last spoke is <REPLY> To my knowledge, $lastspeaker
+       was the last to say something worthwhile.
+<blootbot> me: okay
+<me> blootbot: who last spoke
+<blootbot> To my knowledge, me was the last to say something worthwhile.
+
+<me> blootbot: percentage is <REPLY> you are $randpercentage% lame
+<blootbot> me: okay
+<me> blootbot: percentage
+<blootbot> you are 79% lame
+
+<me> blootbot: slap $1 is <action> slaps $1
+<blootbot> me: okay, me
+<me> blootbot: slap Bob
+ * blootbot slaps Bob
+<me> blootbot: forget cmd: slap (.*?)
+<blootbot> me: i forgot cmd: slap (.*?)
+
+
+#################
+# USER COMMANDS #
+#################
+
+Command: 4op
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       4op ...
+
+Example:
+       ...
+
+
+Command: dumpvars
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       dumpvars ...
+
+Example:
+       ...
+
+
+Command: kick
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       kick ...
+
+Example:
+       ...
+
+
+Command: ignore
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       ignore ...
+
+Example:
+       ...
+
+
+Command: ignorelist
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       ignorelist ...
+
+Example:
+       ...
+
+
+Command: unignore
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       unignore ...
+
+Example:
+       ...
+
+
+Command: clear ignorelist
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       clear ignorelist ...
+
+Example:
+       ...
+
+
+Command: lobotomy
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       lobotomy ...
+
+Example:
+       ...
+
+
+Command: unlobotomy
+=============
+Description:
+       ...
+
+Usage:
+       unlobotomy ...
+
+Example:
+       ...
+
+
+Command: op
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       op ...
+
+Example:
+       ...
+
+
+Command: say
+=============
+Description:
+       ...
+
+Usage: REQUIRES +o flag.
+       say ...
+
+Example:
+       ...
+
+
+Command: die
+=============
+Description:
+       ...
+
+Usage: REQUIRES +n flag.
+       die ...
+
+Example:
+       ...
+
+
+Command: jump
+=============
+Description:
+       ...
+
+Usage: REQUIRES +n flag.
+       jump ...
+
+Example:
+       ...
+
+
+Command: rehash
+=============
+Description:
+       ...
+
+Usage: REQUIRES +n flag.
+       rehash ...
+
+Example:
+       ...
+
+
+Command: set
+=============
+Description:
+       ...
+
+Usage: REQUIRES +n flag.
+       set ...
+
+Example:
+       ...
+
+
+Command: unset
+=============
+Description:
+       ...
+
+Usage: REQUIRES +n flag.
+       unset ...
+
+Example:
+       ...
+
+
+Command: chanstats
+=============
+Description:
+       Channel statistics is gathered while the bot is operation in those
+       channels it is located. They include: join, part, kick, ban, and
+       countless others.
+
+Usage:
+       chanstats [#channel]
+
+Example:
+       > blootbot: chanstats
+       <blootbot> i am on 2 channels: #blootbot #debian
+       <blootbot> i've cached 5 users distributed over 2 channels.     
+
+       > blootbot: chanstats #blootbot
+       <blootbot> On #blootbot, there have been 1 Join, 1 Op and 20
+               PublicMsgs.
+       <blootbot> At the moment, 3 Opped and 3 Total.
+
+
+Command: cmdstats
+=============
+Description:
+       ...
+
+Usage:
+       cmdstats ...
+
+Example:
+       ...
+
+
+Command: crypt
+=============
+Description:
+       ...
+
+Usage:
+       crypt ...
+
+Example:
+       ...
+
+
+Command: factinfo
+=============
+Description:
+       ...
+
+Usage:
+       factinfo ...
+
+Example:
+       ...
+
+
+Command: factstats
+=============
+Description:
+       ...
+
+Usage:
+       factstats ...
+
+Example:
+       ...
+
+
+Command: karma
+=============
+Description:
+       ...
+
+Usage:
+       karma ...
+
+Example:
+       ...
+
+
+Command: spell
+=============
+Description:
+       ...
+
+Usage:
+       spell ...
+
+Example:
+       ...
+
+
+Command: nslookup
+=============
+Description:
+       ...
+
+Usage:
+       nslookup ...
+
+Example:
+       ...
+
+
+Command: part
+=============
+Description:
+       ...
+
+Usage:
+       part ...
+
+Example:
+       ...
+
+
+Command: rot13
+=============
+Description:
+       ...
+
+Usage:
+       rot13 ...
+
+Example:
+       ...
+
+
+Command: wantNick
+=============
+Description:
+       ...
+
+Usage:
+       wantNick ...
+
+Example:
+       ...
+
+
+Command: join
+=============
+Description:
+       The bot can be commanded to join a channel if it is not already on
+       there in the case of a kick/ban, invite only or invalid key to
+       name a few typical case scenarios.
+
+       The channels which the bot can join is governed by the
+       configuration parameter labelled 'join_channels'. However, this
+       is ignored for those users with the +o flag in the user table.
+
+Usage:
+       join <#channel>[,key]
+
+Example:
+       > blootbot: join #blootbot
+       [blootbot] joining #blootbot
+       *** join/#debian blootbot (xk@router.home.org)
+       > blootbot: join #blootbot
+       [blootbot] I'm already on #blootbot...
+
+
+
+                    ======================================
+                               MODULE COMMANDS
+                    ======================================
+
+Command: babelfish
+=============
+Description:
+       ...
+
+Usage:
+       x from [language]: phrase
+
+Example:
+       ...
+
+
+Command: debian package
+=============
+Description:
+       ...
+
+Usage:
+       [] ...
+
+Example:
+       ...
+
+
+Command: dict
+=============
+Description:
+       ...
+
+Usage:
+       dict ...
+
+Example:
+       ...
+
+
+Command: freshmeat
+=============
+Description:
+       ...
+
+Usage:
+       freshmeat ...
+
+Example:
+       ...
+
+
+Command: google
+=============
+Description:
+       ...
+
+Usage:
+       google ...
+
+Example: DOES NOT WORK YET(??)
+       ...
+
+
+Command: insult
+=============
+Description:
+       ...
+
+Usage:
+       insult ...
+
+Example:
+       ...
+
+
+Command: kernel
+=============
+Description:
+       ...
+
+Usage:
+       kernel ...
+
+Example:
+       ...
+
+
+Command: lart
+=============
+Description:
+       ...
+
+Usage:
+       lart ...
+
+Example:
+       ...
+
+
+Command: list{keys|vals}
+=============
+Description:
+       ...
+
+Usage:
+       list{keys|vals} ...
+
+Example:
+       ...
+
+
+Command: nickometer
+=============
+Description:
+       ...
+
+Usage:
+       nickometer ...
+
+Example:
+       ...
+
+
+Command: quotes
+=============
+Description:
+       ...
+
+Usage:
+       quotes ...
+
+Example:
+       ...
+
+
+Command: rootwarn
+=============
+Description:
+       ...
+
+Usage:
+       rootwarn ...
+
+Example:
+       ...
+
+
+Command: seen
+=============
+Description:
+       ...
+
+Usage:
+       seen ...
+
+Example:
+       ...
+
+
+Command: listauth
+=============
+Description:
+       ...
+
+Usage:
+       listauth ...
+
+Example:
+       ...
+
+
+Command: slashdot
+=============
+Description:
+       ...
+
+Usage:
+       slashdot ...
+
+Example:
+       ...
+
+
+Command: debian contents
+=============
+Description:
+       ...
+
+Usage:
+       debian ...
+
+Example:
+       ...
+
+
+Command: topic
+=============
+Description:
+       ...
+
+Usage:
+       topic ...
+
+Example:
+       ...
+
+
+Command: countdown
+=============
+Description:
+       ...
+
+Usage:
+       countdown ...
+
+Example:
+       ...
+
+
+Command: uptime
+=============
+Description:
+       ...
+
+Usage:
+       uptime ...
+
+Example:
+       ...
+
+
+Command: weather
+=============
+Description:
+       ...
+
+Usage:
+       weather ...
+
+Example: DOES NOT WORK
+       ...
+
+
+Command: whatis
+=============
+Description:
+       ...
+
+Usage:
+       whatis ...
+
+Example: DOES NOT WORK
+       ...
+
+
+
+##################################
+# MISCELLANEOUS/FACTOID COMMANDS #
+##################################
+
+Command: forget
+=============
+Description:
+       ...
+
+Usage:
+       forget ...
+
+Example:
+       ...
+
+
+Command: {un|}lock
+=============
+Description:
+       ...
+
+Usage:
+       {un|}lock ...
+
+Example:
+       ...
+
+
+Command: rename
+=============
+Description:
+       ...
+
+Usage:
+       rename ...
+
+Example:
+       ...
+
+
+Command: substitution
+=============
+Description:
+       ...
+
+Usage:
+       $factoid =~ s/from/to/
+       $factoid =~ s#te/st/#test#g
+
+Example:
+       ...
+
+
+Command: karma set
+=============
+Description:
+       ...
+
+Usage:
+       $nick++
+       $nick--
+
+Example:
+       blootbot++
+       infobot--
+
+
+Command: maths
+=============
+Description:
+       ...
+
+Usage:
+       2 + 2
+
+Example:
+       ...
+
+
+Command: tell
+=============
+Description:
+       ...
+
+Usage:
+       tell <nick> about <factoid>
+
+Example:
+       ...
diff --git a/doc/infobot.users.pod b/doc/infobot.users.pod
new file mode 100644 (file)
index 0000000..264196a
--- /dev/null
@@ -0,0 +1,158 @@
+=pod
+
+=head1 NAME
+
+infobot.users - User accounts database for infobot
+
+=head1 SYNOPSIS
+
+  # Please edit to your needs.
+  # "local" is used for CLI mode
+  # Passwords can be generated with mkpasswd in linux
+
+  _default
+  --FLAGS              amrt
+  --HOSTS              *!*@*
+
+  local
+  --FLAGS              Aemnorst
+  --HOSTS              local!local@local
+  --PASS               xxfxfIfoJHdYg
+
+  timriker
+  --FLAGS              Aemnorst
+  --HOSTS              *!~timr@TimRiker.active.supporter.pdpc
+  --PASS               xxfxfIfoJHdYg
+
+  xk
+  --FLAGS              emnorst
+  --HOSTS              *!xk@example.com
+  --HOSTS              *!xk@superbox.home.org
+  --PASS               5K/rmJPzwxJhU
+
+=head1 DESCRIPTION
+
+This file controls who has access to use your infobot.
+
+=head1 FIELDS
+
+There are various fields allowed in your file. Whitespace is ignored, and as
+usual, any line starting with a C<#> is treated as a comment.
+
+The first non whitespace/comment line in your file, is the user name for the
+account you are about to define. Take note that a special username called
+C<_default>, is meant to define what everyone who doesnt have an account in this
+file should use for permissions.
+
+Also, the special user name C<local>, is used when you run the bot in B<CLI>
+mode (console only, no B<IRC> connection). As well, the C<local> user requires a
+special hostmask of S<I<local!local@local>>.
+
+Below is a list of the valid options available for each user account.
+
+=over
+
+=item B<--FLAGS>
+
+This field is a list of possible flags that this account has. Think of them as
+similar to irc user modes (although, with different meanings).
+
+Here is a list of the current flags available, and their meanings:
+
+I<Note: Modes flags are case sensitive>
+
+=over
+
+=item *
+
+B<A> - bot administration over /msg (default is only via DCC CHAT)
+
+=item *
+
+B<O> - dynamic ops (as on channel). (automatic +o)
+
+=item *
+
+B<T> - add topics.
+
+=item *
+
+B<a> - ask/request factoid.
+
+=item *
+
+B<m> - modify factoid. (includes renaming)
+
+=item *
+
+B<n> - bot owner, can "reload"
+
+=item *
+
+B<o> - master of bot (automatic +amrt). 
+
+=over
+
+=item *
+
+Can search on factoid strings shorter than 2 chars
+
+=item *
+
+Can tell bot to join new channels
+
+=item *
+
+Can [un]lock factoids
+
+=back
+
+=item *
+
+B<r> - remove factoid.
+
+=item *
+
+B<t> - teach/add factoid.
+
+=item *
+
+B<s> - Bypass +silent on channels
+
+=back
+
+=item B<--HOSTS>
+
+This field is used to specify a hostmask that a user must appear from for the
+bot to consider them to be this specific account definition.
+
+This hostmask takes the form of: I<nick!user@hostname>
+
+I<Note: You can have this field multiple times>
+
+=item B<--PASS>
+
+This field used a C<crypt> formated password, that is used for B<DCC> chats to
+the bot, or if you need to identify yourself to the bot in the event that you
+come from a different host.
+
+You can generate one using the C<mkpasswd> command, available on most systems.
+
+For example:
+
+ infobot@myhost:~$ mkpasswd
+ Password: test
+ GVrl9PMBB0gpw
+
+You can also change your password at anytime by sending the bot a C<chpass>
+command on B<IRC>. 
+
+=back
+
+=head1 BUGS
+
+At some point, it is likely that the C<local> account will be removed and
+implied to have full access.
+
+=cut
+