summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2014-12-08 17:49:31 +0100
committermathieui <mathieui@mathieui.net>2014-12-08 17:49:54 +0100
commit780fff009a3a68de99bf5522433e61c6b941c4b4 (patch)
tree0d978a509fc5f4e7f60884e435c7b06a499a22d6 /plugins
parent82a5a69f6f86aa8b7ebf8313f77338bc9f927027 (diff)
downloadpoezio-780fff009a3a68de99bf5522433e61c6b941c4b4.tar.gz
poezio-780fff009a3a68de99bf5522433e61c6b941c4b4.tar.bz2
poezio-780fff009a3a68de99bf5522433e61c6b941c4b4.tar.xz
poezio-780fff009a3a68de99bf5522433e61c6b941c4b4.zip
Document the pipe_cmd plugin
Diffstat (limited to 'plugins')
-rw-r--r--plugins/pipe_cmd.py14
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/pipe_cmd.py b/plugins/pipe_cmd.py
index 762501ae..29404e0f 100644
--- a/plugins/pipe_cmd.py
+++ b/plugins/pipe_cmd.py
@@ -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.
+
"""