Limnoria-doc/use/plugins/note.rst

70 lines
1.6 KiB
ReStructuredText
Raw Normal View History

2011-06-28 08:11:32 +02:00
.. _plugin-note:
The Note plugin
===============
2011-06-28 17:29:38 +02:00
Reading notes
-------------
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-note-search:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
note search [--{regexp} <value>] [--sent] [<glob>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Searches your received notes for ones matching *<glob>*. If *--regexp* is
given, its associated value is taken as a regexp and matched against
the notes. If *--sent* is specified, only search sent notes.
2011-06-28 17:29:38 +02:00
.. _command-note-list:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
note list [--{old,sent}] [--{from,to} <user>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Retrieves the ids of all your unread notes. If *--old* is given, list
read notes. If *--sent* is given, list notes that you have sent. If
*--from* is specified, only lists notes sent to you from *<user>*. If
*--to* is specified, only lists notes sent by you to *<user>*.
2011-06-28 17:29:38 +02:00
.. _command-note-next:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
note next
^^^^^^^^^
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
Retrieves your next unread note, if any.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-note-note:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
note note <id>
^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
Retrieves a single note by its unique note id. Use the 'note list'
command to see what unread notes you have.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
Sending notes
-------------
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-note-unsend:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
note unsend <id>
^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
Unsends the note with the id given. You must be the
author of the note, and it must be unread.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-note-reply:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
note reply <id> <text>
^^^^^^^^^^^^^^^^^^^^^^
Sends a note in reply to *<id>*.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-note-send:
note send <recipient>,[<recipient>,[...]] <text>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sends a new note to the user specified. Multiple recipients may be
specified by separating their names by commas.
2011-06-28 08:11:32 +02:00