From 7b38bdc8e1a960414e5b1622ca5ce4eacf663c03 Mon Sep 17 00:00:00 2001
From: Ben Pfaff <blp@nicira.com>
Date: Tue, 23 Mar 2010 11:22:42 -0700
Subject: [PATCH] ovsdb-server: Document --unixctl option.

---
 lib/automake.mk         | 2 ++
 lib/unixctl-syn.man     | 2 ++
 lib/unixctl.man         | 8 ++++++++
 ovsdb/ovsdb-server.1.in | 2 ++
 ovsdb/ovsdb-server.c    | 1 +
 5 files changed, 15 insertions(+)
 create mode 100644 lib/unixctl-syn.man
 create mode 100644 lib/unixctl.man

diff --git a/lib/automake.mk b/lib/automake.mk
index 51d3c11b..b34a12ac 100644
--- a/lib/automake.mk
+++ b/lib/automake.mk
@@ -205,6 +205,8 @@ EXTRA_DIST += \
 	lib/ssl-peer-ca-cert.man \
 	lib/ssl.man \
 	lib/ssl-syn.man \
+	lib/unixctl.man \
+	lib/unixctl-syn.man \
 	lib/vconn-active.man \
 	lib/vconn-passive.man \
 	lib/vlog-unixctl.man \
diff --git a/lib/unixctl-syn.man b/lib/unixctl-syn.man
new file mode 100644
index 00000000..5a38e984
--- /dev/null
+++ b/lib/unixctl-syn.man
@@ -0,0 +1,2 @@
+.IP "Runtime management options:"
+\fB\-\-unixctl=\fIsocket\fR
diff --git a/lib/unixctl.man b/lib/unixctl.man
new file mode 100644
index 00000000..6ea7cf24
--- /dev/null
+++ b/lib/unixctl.man
@@ -0,0 +1,8 @@
+.IP "\fB\-\-unixctl=\fIsocket\fR"
+Sets the name of the control socket on which \fB\*(PN\fR listens for
+runtime management commands (see \fBRUNTIME MANAGEMENT COMMANDS\fR,
+below).  If \fIsocket\fR does not begin with \fB/\fR, it is
+interpreted as relative to \fB@RUNDIR@\fR.  If \fB\-\-unixctl\fR is
+not used at all, the default socket is
+\fB@RUNDIR@/\*(PN.\fIpid\fB.ctl\fR, where \fIpid\fR is \fB\*(PN\fR's
+process ID.
diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in
index 14d88944..7909b9ea 100644
--- a/ovsdb/ovsdb-server.1.in
+++ b/ovsdb/ovsdb-server.1.in
@@ -12,6 +12,7 @@ ovsdb\-server \- Open vSwitch database server
 [\fB--run=\fIcommand\fR]
 .so lib/daemon-syn.man
 .so lib/vlog-syn.man
+.so lib/unixctl-syn.man
 .so lib/common-syn.man
 .
 .SH DESCRIPTION
@@ -71,6 +72,7 @@ one row in \fItable\fR.)
 .so lib/ssl.man
 .so lib/ssl-bootstrap.man
 .SS "Other Options"
+.so lib/unixctl.man
 .so lib/common.man
 .SH "RUNTIME MANAGEMENT COMMANDS"
 \fBovs\-appctl\fR(8) can send commands to a running
diff --git a/ovsdb/ovsdb-server.c b/ovsdb/ovsdb-server.c
index eae20f92..0d95cb2e 100644
--- a/ovsdb/ovsdb-server.c
+++ b/ovsdb/ovsdb-server.c
@@ -439,6 +439,7 @@ usage(void)
     vlog_usage();
     printf("\nOther options:\n"
            "  --run COMMAND           run COMMAND as subprocess then exit\n"
+           "  --unixctl=SOCKET        override default control socket name\n"
            "  -h, --help              display this help message\n"
            "  -V, --version           display version information\n");
     leak_checker_usage();
-- 
2.30.2