Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-07 15:59:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Review and update the layout.

Browse Source
This commit is contained in:
Valentin Lorentz
2011-06-28 17:29:38 +02:00
parent 2ce465adcd
commit b17bd0fac6
63 changed files with 2384 additions and 2323 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
use/plugins/todo.rst
View File

@ -4,64 +4,57 @@
The Todo plugin
===============
.. _command-die:
Reading
-------
die
^^^^
.. _command-todo-todo:
.. _command-search:
search [--{regexp} <value>] [<glob> <glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Searches your todos for tasks matching *<glob>*. If *--regexp* is given,
its associated value is taken as a regexp and matched against the
tasks.
.. _command-remove:
remove <task id> [<task id> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes *<task id>* from your personal todo list.
.. _command-add:
add [--priority=<num>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<text>* as a task in your own personal todo list. The optional
priority argument allows you to set a task as a high or low priority.
Any integer is valid.
.. _command-setpriority:
setpriority <id> <priority>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the priority of the todo with the given id to the specified value.
.. _command-todo:
todo [<username>] [<task id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
todo todo [<username>] [<task id>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Retrieves a task for the given task id. If no task id is given, it
will return a list of task ids that that user has added to their todo
list.
.. _command-todo-search:
.. _command-change:
todo search [--{regexp} <value>] [<glob> <glob> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
change <task id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^
Searches your todos for tasks matching *<glob>*. If *--regexp* is given,
its associated value is taken as a regexp and matched against the
tasks.
Editing
-------
.. _command-todo-add:
todo add [--priority=<num>] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adds *<text>* as a task in your own personal todo list. The optional
priority argument allows you to set a task as a high or low priority.
Any integer is valid.
.. _command-todo-remove:
todo remove <task id> [<task id> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Removes *<task id>* from your personal todo list.
.. _command-todo-setpriority:
todo setpriority <id> <priority>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sets the priority of the todo with the given id to the specified value.
.. _command-todo-change:
todo change <task id> <regexp>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Modify the task with the given id using the supplied regexp.