summaryrefslogtreecommitdiff
path: root/doc/en/plugins/reminder.txt
blob: 5fec9bd0f9d71d222af6ea2fdd6b197c0cce500a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
Reminder
========

Installation
------------
You only have to load the plugin:

==============

 /load reminder

==============

Usage
-----
This plugin defines three new global commands: _/remind_, _/done_, and
_/tasks_.

remind
~~~~~~
================

 /remind <time> <todo>

================

Will remind you to do _<todo>_ every _<time>_.


.Time in seconds
================

 /remind 600 Work!

Will remind you to work every 10 minutes

================

Defining the time in seconds is not really usable, so you can describe it
with days, hours, and minutes, e.g:

.Time in a string
=======================

 /remind 1h23m "Get up"

Will remind you to get up every 1 hour 23 minutes

=======================


done
~~~~

Removes a reminder.

============

 /done <id>

===========

The _id_ is found using _/tasks_.

tasks
~~~~~

===============

 /tasks

================

Will print a list of the tasks, their ids, and their frequency, into the
information buffer.