Limnoria-doc/use/plugins/scheduler.rst

53 lines
989 B
ReStructuredText
Raw Normal View History

2011-06-28 08:11:32 +02:00
.. _plugin-scheduler:
The Scheduler plugin
====================
2011-06-28 08:13:53 +02:00
.. _command-repeat:
2011-06-28 08:11:32 +02:00
repeat <name> <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Schedules the command *<command>* to run every *<seconds>* seconds,
starting now (i.e., the command runs now, and every *<seconds>* seconds
thereafter). *<name>* is a name by which the command can be
unscheduled.
2011-06-28 08:13:53 +02:00
.. _command-die:
2011-06-28 08:11:32 +02:00
die
^^^^
2011-06-28 08:13:53 +02:00
.. _command-list:
2011-06-28 08:11:32 +02:00
list
^^^^
Lists the currently scheduled events.
2011-06-28 08:13:53 +02:00
.. _command-add:
2011-06-28 08:11:32 +02:00
add <seconds> <command>
^^^^^^^^^^^^^^^^^^^^^^^
Schedules the command string *<command>* to run *<seconds>* seconds in the
future. For example, 'scheduler add [seconds 30m] "echo [cpu]"' will
schedule the command "cpu" to be sent to the channel the schedule add
command was given in (with no prefixed nick, a consequence of using
echo). Do pay attention to the quotes in that example.
2011-06-28 08:13:53 +02:00
.. _command-remove:
2011-06-28 08:11:32 +02:00
remove <id>
^^^^^^^^^^^
Removes the event scheduled with id *<id>* from the schedule.