Add AUTHORS file.

[openvswitch] / vswitchd / ovs-vswitchd.8.in

diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in
index cbfea13a526cb67db6c6d022c62859293d2466c6..79f17d3db6f52ecd50b379737146609e36263fe9 100644 (file)
--- a/vswitchd/ovs-vswitchd.8.in
+++ b/vswitchd/ovs-vswitchd.8.in
@@ -18,10 +18,12 @@ ovs\-vswitchd \- Open vSwitch daemon
 A daemon that manages and controls any number of Open vSwitch switches 
 on the local machine.
 .PP
 A daemon that manages and controls any number of Open vSwitch switches 
 on the local machine.
 .PP

-The mandatory \fIdatabase\fR argument specifies the
-\fBovsdb\-server\fR from which \fBovs\-vswitchd\fR's configuration
-should be retrieved.  It takes one of the following forms:
+The mandatory \fIdatabase\fR argument normally takes the form
+\fBunix:\fIfile\fR, where \fIfile\fR is the name of a Unix domain
+socket on which \fBovsdb-server\fR is listening.  However, all of the
+following forms are accepted:

 .so ovsdb/remote-active.man
 .so ovsdb/remote-active.man

+.so ovsdb/remote-passive.man

 .PP
 \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at
 startup.  It sets up Open vSwitch datapaths and then operates
 .PP
 \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at
 startup.  It sets up Open vSwitch datapaths and then operates


@@ -74,12 +76,25 @@ Open vSwitch distribution for instructions on how to build and load
 the Open vSwitch kernel module.
 .PP
 .SH OPTIONS
 the Open vSwitch kernel module.
 .PP
 .SH OPTIONS

+.IP "\fB--mlockall\fR"
+Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to
+attempt to lock all of its process memory into physical RAM,
+preventing the kernel from paging any of its memory to disk.  This
+helps to avoid networking interruptions due to system memory pressure.
+.IP
+Some systems do not support \fBmlockall()\fR at all, and other systems
+only allow privileged users, such as the superuser, to use it.
+\fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
+unavailable or unsuccessful.
+.

 .IP "\fB--fake-proc-net\fR"
 Causes \fBovs\-vswitchd\fR to simulate some files in \fB/proc/net/vlan\fR
 and \fB/proc/net/bonding\fR that some legacy software expects to
 exist.  This option should only be used if such legacy software is
 actually in use.  It requires the \fBbrcompat_mod.ko\fR kernel module
 to be loaded.
 .IP "\fB--fake-proc-net\fR"
 Causes \fBovs\-vswitchd\fR to simulate some files in \fB/proc/net/vlan\fR
 and \fB/proc/net/bonding\fR that some legacy software expects to
 exist.  This option should only be used if such legacy software is
 actually in use.  It requires the \fBbrcompat_mod.ko\fR kernel module
 to be loaded.

+.IP
+On non-Linux hosts, this option is accepted but has no effect.

 .
 .so lib/daemon.man
 .SS "Public Key Infrastructure Options"
 .
 .so lib/daemon.man
 .SS "Public Key Infrastructure Options"


@@ -94,12 +109,21 @@ to be loaded.
 \fBovs\-vswitchd\fR process.  The currently supported commands are
 described below.  The command descriptions assume an understanding of
 how to configure Open vSwitch.
 \fBovs\-vswitchd\fR process.  The currently supported commands are
 described below.  The command descriptions assume an understanding of
 how to configure Open vSwitch.

+.SS "GENERAL COMMANDS"
+.IP "\fBexit\fR"
+Causes \fBovs\-vswitchd\fR to gracefully terminate.

 .SS "BRIDGE COMMANDS"
 These commands manage bridges.
 .IP "\fBfdb/show\fR \fIbridge\fR"
 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 along with the port on which it was learned and the age of the entry,
 in seconds.
 .SS "BRIDGE COMMANDS"
 These commands manage bridges.
 .IP "\fBfdb/show\fR \fIbridge\fR"
 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 along with the port on which it was learned and the age of the entry,
 in seconds.

+.IP "\fBbridge/reconnect\fR [\fIbridge\fR]"
+Makes \fIbridge\fR drop all of its OpenFlow controller connections and
+reconnect.  If \fIbridge\fR is not specified, then all bridges drop
+their controller connections and reconnect.
+.IP
+This command might be useful for debugging OpenFlow controller issues.

 .
 .IP "\fBbridge/dump-flows\fR \fIbridge\fR"
 Lists all flows in \fIbridge\fR, including those normally hidden to
 .
 .IP "\fBbridge/dump-flows\fR \fIbridge\fR"
 Lists all flows in \fIbridge\fR, including those normally hidden to