======
 USER 
======
| 

about
-----
| 

:author:  Bart Thate <bthate@gmail.com>
:contact: IRCNET/#dunkbots
:website: http://plugins.gozerbot.org
:license: Public Domain
 
| 

description
-----------
| 

manage users

| 

  user related commands 

| 

commands
--------
| 


1) user-add

    user-add <name> <userhost> .. add <name> with <userhost> to the bot

    ::

        <user> !user-add dunker bart@localhost
        <output> dunker added to user database

3) user-addperm (setperms)

    add permission to user <name>

    ::

        <user> !user-addperm dunker rss
        <output> RSS perm added

3) user-addpermall

    user-addpermall <perm> .. add <permission> to all users

    ::

        <user> !user-addpermall USER
        <output> USER perm added

3) user-addpermit

    user-addpermit <nick> <what> .. permit nick access to <what> .. use setperms to add permissions

    ::

        <user> !user-addpermit dunker todo
        <output> dunker is already allowed to do todo

3) user-addstatus (setstatus)

    user-addstatus <name> <status>

    ::

        <user> !user-addstatus dunker #bartbot
        <output> #BARTBOT status added

3) user-adduserhost (adduserhost)

    user-adduserhost <name> <userhost> .. add <userhost> to userhosts of <name>

    ::

        <user> !user-adduserhost dunker bart?@*.a2000.nl
        <output> userhost added

3) user-allperm

    user-allperm <perm> .. get users with <perm> permission

    ::

        <user> !user-allperm rss
        <output> dunker

3) user-allstatus

    user-allstatus <status> ..get users with <status> status

    ::

        <user> !user-allstatus #dunkbots
        <output> no users with #DUNKBOTS status found

3) user-check (check)

    user-check <nick>

    ::

        <user> !user-check dunker
        <output> userrecord = name: dunker userhosts: ['bart@gozerbot.org',
        <output>  'bart?@*.a2000.nl'] perms: ['USER', 'RSS', 'USER']
        <output>  email: bart@gozerbot.org status: ['#BARTBOT'] allowed:
        <output>  [] notallowed: [] tempusershosts: [] permit: []

6) user-delemail (delemail)

    reset email

    ::

        <user> !user-delemail
        <output> email removed

3) user-delperm

    user-delperm <name> <perm> .. delete from user <name> permission <perm>

    ::

        <user> !user-delperm dunker rss
        <output> RSS perm removed

3) user-delpermall

    user-delpermall <perm> .. delete <permission> from all users

    ::

        <user> !user-delpersall BLA
        <output> none

4) user-delpermit

    user-delpermit <name> <permit>

    ::

        <user> !user-delpermit dunker todo
        <output> todo denied

3) user-delstatus (delstatus)

    user-delstatus <name> <status>

    ::

        <user> !user-delstatus dunker #dunkbots
        <output> dunker has no #DUNKBOTS status

3) user-deluserhost (deluserhosts)

    user-deluserhost <name> <userhost> .. delete from usershosts of <name> userhost <userhost>

    ::

        <user> !user-deluserhost dunker bart1@bla.a2000.nl
        <output> dunker has no bart1@bla.a2000.nl in userhost list

3) user-email (email)

    get email

    ::

        <user> !user-email
        <output> no email set

3) user-getemail (getemail)

    user-getemail <name> .. get email from user <name>

    ::

        <user> !user-getemail dunker
        <output> dunker has email bart@gozerbot.org

3) user-getname (gn)

    user-getname <nick> .. get the name of <nick>

    ::

        <user> !user-getname dunker
        <output> dunker

3) user-getperms (getperms)

    user-getperms <name> .. get permissions of <name>

    ::

        <user> !user-getperms dunker
        <output> USER .. USER

3) user-getstatus (getstatus)

    user-getstatus <name> .. get status of <name>

    ::

        <user> !user-getstatus dunker
        <output> #BARTBOT

3) user-getuserhosts (getuserhosts)

    user-getuserhosts <name> .. get userhosts of <name>

    ::

        <user> !user-getuserhosts dunker
        <output> bart@gozerbot.org .. bart?@*.a2000.nl

3) user-match (match)

    user-match <userhost>

    ::

        <user> !user-match test@test
        <output> userrecord = name: test userhosts: ['test@test', 'bla@bla']
        <output>  perms: ['OPER', 'USER', 'QUOTE', 'USER', 'USER', 'USER']
        <output>  email:  status: [] allowed: [] notallowed: [] tempusershosts:
        <output>  [] permit: []

6) user-meet (meet)

    meet <nick> .. introduce <nick> to the bot

    ::

        <user> !user-meet dunker
        <output> there is already a user with username dunker

3) user-merge (merge)

    user-merge <name> <nick> .. merge record with <name> with userhost from <nick>

    ::

        <user> !merge bart dunker
        <output> we have no user bart

3) user-name (name)

    show name of user giving the command

    ::

        <user> !user-name
        <output> your name is test

3) user-names (names)

    show names of registered users

    ::

        <user> !user-names
        <output> owner .. test .. web .. dunker

3) user-permit (permit)

    show permit of user giving the command

    ::

        <user> !user-permit
        <output> you don't have any permits set

3) user-perms (perms)

    get permissions

    ::

        <user> !user-perms
        <output> OPER .. USER .. QUOTE .. USER .. USER .. USER

3) user-scan (us)

    user-scan <txt> .. search database for matching usernames

    ::

        <user> !user-scan dunk
        <output> dunker

3) user-search

    search for matching userhosts

    ::

        <user> !user-search gozerbot
        <output> (dunker) bart@gozerbot.org

3) user-setemail (setemail)

    user-setemail <name> <email>.. set email of user <name>

    ::

        <user> !user-setemail dunker bart@gozerbot.org
        <output> email set

3) user-status (status)

    get status

    ::

        <user> !user-status
        <output> you have no status set

3) user-userhosts (userhosts)

    get userhosts

    ::

        <user> !user-userhosts
        <output> test@test .. bla@bla

3) user-whoami (whoami)

    get your username

    ::

        <user> !user-whoami
        <output> test

3) user-del (delete)

    user-del <name> .. delete user with <username>

    ::

        <user> !user-del dunker
        <output> dunker deleted
