Skip to content

Commit

Permalink
ovsdb-server: Document --unixctl option.
Browse files Browse the repository at this point in the history
  • Loading branch information
blp committed Apr 12, 2010
1 parent ea205ad commit 7b38bdc
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 0 deletions.
2 changes: 2 additions & 0 deletions lib/automake.mk
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
2 changes: 2 additions & 0 deletions lib/unixctl-syn.man
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.IP "Runtime management options:"
\fB\-\-unixctl=\fIsocket\fR
8 changes: 8 additions & 0 deletions lib/unixctl.man
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions ovsdb/ovsdb-server.1.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions ovsdb/ovsdb-server.c
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down

0 comments on commit 7b38bdc

Please sign in to comment.