Improve the confd man page
authorIustin Pop <iustin@google.com>
Fri, 5 Oct 2012 20:45:49 +0000 (22:45 +0200)
committerIustin Pop <iustin@google.com>
Mon, 8 Oct 2012 11:07:35 +0000 (13:07 +0200)
This was a very very thin man page; this patch expands it a bit, but
it could use more help still.

Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>

man/ganeti-confd.rst

index b937751..09b0934 100644 (file)
@@ -22,6 +22,23 @@ program won't detach from the running terminal.
 
 Debug-level message can be activated by giving the ``-d`` option.
 
+Logging to syslog, rather than its own log file, can be enabled by
+passing in the ``--syslog`` option.
+
+The **ganeti-confd** daemon listens to port 1814 UDP, on all interfaces,
+by default. The port can be overridden by an entry the services database
+(usually ``/etc/services``) or by passing the ``-p`` option.  The ``-b``
+option can be used to specify the address to bind to (defaults to
+``0.0.0.0``). The daemon also listens on a Unix socket
+(``@LOCALSTATEDIR@/run/ganeti/socket/ganeti-query``) on which it exports
+a ``Luxi`` endpoint, serving query operations only. Commands and tools
+use this socket if the build-time option for split queries has been
+enabled.
+
+The daemon will refuse to start if the user and group do not match the
+one defined at build time; this behaviour can be overridden by the
+``--no-user-checks`` option.
+
 ROLE
 ~~~~