mirror of
https://github.com/Limnoria/Limnoria-doc.git
synced 2025-04-07 07:49:52 +00:00
Generate all plugin docs.
This commit is contained in:
77
use/plugins/note.rst
Normal file
77
use/plugins/note.rst
Normal file
@ -0,0 +1,77 @@
|
||||
|
||||
.. _plugin-note:
|
||||
|
||||
The Note plugin
|
||||
===============
|
||||
|
||||
.. command-unsend:
|
||||
|
||||
unsend <id>
|
||||
^^^^^^^^^^^
|
||||
|
||||
Unsends the note with the id given. You must be the
|
||||
author of the note, and it must be unread.
|
||||
|
||||
|
||||
.. command-search:
|
||||
|
||||
search [--{regexp} <value>] [--sent] [<glob>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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.
|
||||
|
||||
|
||||
.. command-reply:
|
||||
|
||||
reply <id> <text>
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
Sends a note in reply to *<id>*.
|
||||
|
||||
|
||||
.. command-die:
|
||||
|
||||
die
|
||||
^^^^
|
||||
|
||||
|
||||
|
||||
.. command-list:
|
||||
|
||||
list [--{old,sent}] [--{from,to} <user>]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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>*.
|
||||
|
||||
|
||||
.. command-send:
|
||||
|
||||
send <recipient>,[<recipient>,[...]] <text>
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Sends a new note to the user specified. Multiple recipients may be
|
||||
specified by separating their names by commas.
|
||||
|
||||
|
||||
.. command-next:
|
||||
|
||||
next
|
||||
^^^^
|
||||
|
||||
Retrieves your next unread note, if any.
|
||||
|
||||
|
||||
.. command-note:
|
||||
|
||||
note <id>
|
||||
^^^^^^^^^
|
||||
|
||||
Retrieves a single note by its unique note id. Use the 'note list'
|
||||
command to see what unread notes you have.
|
||||
|
||||
|
Reference in New Issue
Block a user