Document the pipe_cmd plugin

This commit is contained in:
mathieui 2014-12-08 17:49:31 +01:00
parent 82a5a69f6f
commit 780fff009a
No known key found for this signature in database
GPG key ID: C59F84CEEFD616E3
3 changed files with 26 additions and 0 deletions

View file

@ -210,6 +210,11 @@ Plugin index
Reverse everything you say.
Pipe Command
:ref:`Documentation <pipecmd-plugin>`
Send commands to poezio through a named pipe.
Shuffle
:ref:`Documentation <shuffle-plugin>`
@ -279,3 +284,4 @@ Plugin index
autocorrect
irc
change_title
pipe_cmd

View file

@ -0,0 +1,6 @@
.. _pipecmd-plugin:
Pipe Command
============
.. automodule:: pipe_cmd

View file

@ -2,6 +2,20 @@
This plugins allows commands to be sent to poezio via a named pipe.
You can run the same commands that you would in the poezio input
(e.g. ``echo '/message toto@example.tld Hi' >> /tmp/poezio.fifo``).
Configuration
-------------
.. glossary::
:sorted:
pipename
**Default:** :file:`/tmp/poezio.fifo`
The path to the fifo which will receive commands.
"""