.. _plugin:alarm:

=====
ALARM
=====
| 

about
-----
| 

:author:  FeedBackLoop <feedbackloop@gmail.com>
:contact: FREENODE/#fbf
:distribution: core
:license:  

| 

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

 
    the alarm plugin allows for alarms that message the user giving the
    command at a certain time or number of seconds from now





| 

commands
--------
| 


    :commands in this plugin: alarm-list .. alarm .. alarm-mylist .. alarm-del

| 

1) *alarm .. [handle_alarmadd]*

    :description:  alarm <txt-with-time> | <+delta> <txt> .. add an alarm 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.alarm_alarm_command`.

    :examples:

    ::

        <user> ;alarm 12:00 lunchtime
        <output> we are already past Tue Oct 2 12:00:00 2012



    ::

        <user> ;alarm 3-11-2008 0:01 birthday !
        <output> we are already past Mon Nov 3 00:01:00 2008



    ::

        <user> ;alarm +180 egg ready
        <output> alarm 1 set at Tue Oct 2 19:41:31 2012


2) *alarm-del .. [handle_alarmdel]*

    :description:  alarm-del <nr> .. delete alarm 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.alarm_alarm-del_command`.

    :examples:

    ::

        <user> ;alarm-del 7
        <output> failed to delete alarm with id 7


3) *alarm-list .. [handle_alarmlist]*

    :description:  alarm-list .. list all alarms 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.alarm_alarm-list_command`.

    :examples:

    ::

        <user> ;alarm-list
        <output> alarmlist: 1) test: Tue Oct 2 19:38:33 2012 - egg ready , 1) test: Tue Oct 2 19:38:33 2012 - sleep , 2) test: Tue Oct 2 19:38:33 2012 - sleep


4) *alarm-mylist .. [handle_myalarmslist]*

    :description:  alarm-mylist .. show alarms of user giving the command 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.alarm_alarm-mylist_command`.

    :examples:

    ::

        <user> ;alarm-mylist
        <output> your alarms: 1) Tue Oct 2 19:38:34 2012 - sleep , 2) Tue Oct 2 19:38:34 2012 - sleep