[kupfer: 48/51] doc: Document kupfer --relay in the man page



commit 8aa72d53fd84d51eec4ba176734a9389dad3a676
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date:   Mon Mar 28 16:51:50 2011 +0200

    doc: Document kupfer --relay in the man page

 Documentation/Manpage.rst |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)
---
diff --git a/Documentation/Manpage.rst b/Documentation/Manpage.rst
index d825bb7..15e8885 100644
--- a/Documentation/Manpage.rst
+++ b/Documentation/Manpage.rst
@@ -57,6 +57,20 @@ OPTIONS
 --debug         Enable more verbose output that can help understanding
                 the program's operation.
 
+--relay         Run libkeybinder relay service on the current
+                ``$DISPLAY``. kupfer is supported in a multihead
+                configuration with multiple X screens, if it all exists
+                inside one single desktop (and D-Bus) session.
+
+                On the first X screen, kupfer should be started
+                normally. For each additional screen with unique
+                ``$DISPLAY`` name, the relay service must be started. It
+                will pass on the summoning and trigger global keyboard
+                shortcuts.
+
+                ``kupfer --relay`` will wait if no running kupfer can be
+                contacted. It never exits until interrupted.
+
 The following are generic options
 
 --help          Display usage information



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]