summaryrefslogtreecommitdiff
path: root/doc/en/plugins/reminder.txt
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2012-05-06 22:09:27 +0200
committermathieui <mathieui@mathieui.net>2012-05-06 22:09:27 +0200
commit0d21c1b74b7218a4f7a58cb0c42b89926c7b3583 (patch)
tree569130fb3499fd95a0661f4c63d617bda293649e /doc/en/plugins/reminder.txt
parent39a61486de399ccab77ce8da683a27ce7476f9cd (diff)
downloadpoezio-0d21c1b74b7218a4f7a58cb0c42b89926c7b3583.tar.gz
poezio-0d21c1b74b7218a4f7a58cb0c42b89926c7b3583.tar.bz2
poezio-0d21c1b74b7218a4f7a58cb0c42b89926c7b3583.tar.xz
poezio-0d21c1b74b7218a4f7a58cb0c42b89926c7b3583.zip
Add the missing plugin docs
Diffstat (limited to 'doc/en/plugins/reminder.txt')
-rw-r--r--doc/en/plugins/reminder.txt76
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/en/plugins/reminder.txt b/doc/en/plugins/reminder.txt
new file mode 100644
index 00000000..5fec9bd0
--- /dev/null
+++ b/doc/en/plugins/reminder.txt
@@ -0,0 +1,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.
+