Document the pipe_cmd plugin
This commit is contained in:
parent
82a5a69f6f
commit
780fff009a
3 changed files with 26 additions and 0 deletions
|
@ -210,6 +210,11 @@ Plugin index
|
||||||
|
|
||||||
Reverse everything you say.
|
Reverse everything you say.
|
||||||
|
|
||||||
|
Pipe Command
|
||||||
|
:ref:`Documentation <pipecmd-plugin>`
|
||||||
|
|
||||||
|
Send commands to poezio through a named pipe.
|
||||||
|
|
||||||
Shuffle
|
Shuffle
|
||||||
:ref:`Documentation <shuffle-plugin>`
|
:ref:`Documentation <shuffle-plugin>`
|
||||||
|
|
||||||
|
@ -279,3 +284,4 @@ Plugin index
|
||||||
autocorrect
|
autocorrect
|
||||||
irc
|
irc
|
||||||
change_title
|
change_title
|
||||||
|
pipe_cmd
|
||||||
|
|
6
doc/source/plugins/pipe_cmd.rst
Normal file
6
doc/source/plugins/pipe_cmd.rst
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
.. _pipecmd-plugin:
|
||||||
|
|
||||||
|
Pipe Command
|
||||||
|
============
|
||||||
|
|
||||||
|
.. automodule:: pipe_cmd
|
|
@ -2,6 +2,20 @@
|
||||||
|
|
||||||
This plugins allows commands to be sent to poezio via a named pipe.
|
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.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue