From 780fff009a3a68de99bf5522433e61c6b941c4b4 Mon Sep 17 00:00:00 2001
From: mathieui <mathieui@mathieui.net>
Date: Mon, 8 Dec 2014 17:49:31 +0100
Subject: Document the pipe_cmd plugin

---
 doc/source/plugins/index.rst    |  6 ++++++
 doc/source/plugins/pipe_cmd.rst |  6 ++++++
 plugins/pipe_cmd.py             | 14 ++++++++++++++
 3 files changed, 26 insertions(+)
 create mode 100644 doc/source/plugins/pipe_cmd.rst

diff --git a/doc/source/plugins/index.rst b/doc/source/plugins/index.rst
index 452c2e8a..b86423c7 100644
--- a/doc/source/plugins/index.rst
+++ b/doc/source/plugins/index.rst
@@ -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
diff --git a/doc/source/plugins/pipe_cmd.rst b/doc/source/plugins/pipe_cmd.rst
new file mode 100644
index 00000000..13509f75
--- /dev/null
+++ b/doc/source/plugins/pipe_cmd.rst
@@ -0,0 +1,6 @@
+.. _pipecmd-plugin:
+
+Pipe Command
+============
+
+.. automodule:: pipe_cmd
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.
+
 """
 
 
-- 
cgit v1.2.3