[ovs-dev] [PATCH] doc: Change "-" to "\-" in appropriate places.
Ben Pfaff
blp at nicira.com
Tue Jun 29 21:29:47 UTC 2010
The newer manpages tend to get this right more often than the old ones,
but there were lots of places that needed to be corrected.
---
debian/ovs-switch-setup.8 | 16 ++++----
lib/common-syn.man | 4 +-
lib/daemon-syn.man | 8 ++--
lib/daemon.man | 24 ++++++------
lib/ssl-bootstrap.man | 2 +-
lib/ssl-peer-ca-cert.man | 6 ++--
lib/vlog-syn.man | 6 ++--
lib/vlog-unixctl.man | 6 ++--
lib/vlog.man | 14 ++++----
ovsdb/ovsdb-client.1.in | 34 +++++++++---------
ovsdb/ovsdb-idlc.1 | 4 +-
ovsdb/ovsdb-server.1.in | 18 +++++-----
ovsdb/ovsdb-tool.1.in | 16 ++++----
utilities/ovs-appctl.8.in | 22 ++++++------
utilities/ovs-controller.8.in | 20 +++++-----
utilities/ovs-discover.8.in | 34 +++++++++---------
utilities/ovs-dpctl.8.in | 12 +++---
utilities/ovs-kill.8.in | 8 ++--
utilities/ovs-ofctl.8.in | 54 ++++++++++++++--------------
utilities/ovs-openflowd.8.in | 76 ++++++++++++++++++++--------------------
utilities/ovs-pki.8.in | 6 ++--
utilities/ovs-vsctl.8.in | 26 +++++++-------
vswitchd/ovs-brcompatd.8.in | 6 ++--
vswitchd/ovs-vswitchd.8.in | 16 ++++----
24 files changed, 219 insertions(+), 219 deletions(-)
diff --git a/debian/ovs-switch-setup.8 b/debian/ovs-switch-setup.8
index 18dc329..f833773 100644
--- a/debian/ovs-switch-setup.8
+++ b/debian/ovs-switch-setup.8
@@ -1,4 +1,4 @@
-.TH ovs-switch-setup 8 "June 2008" "Open vSwitch" "Open vSwitch Manual"
+.TH ovs\-switch\-setup 8 "June 2008" "Open vSwitch" "Open vSwitch Manual"
.SH NAME
ovs\-switch\-setup \- interactive setup for Open vSwitch switch
@@ -15,27 +15,27 @@ including the underlying public key infrastructure (PKI).
ovs\-switch\-setup does not accept any command-line options.
.SH FILES
-.IP /etc/default/openvswitch-switch
+.IP /etc/default/openvswitch\-switch
Main configuration file for Open vSwitch switch.
.IP /etc/openvswitch/cacert.pem
Default location of CA certificate for OpenFlow controllers.
-.IP /etc/openvswitch/of0-cert.pem
+.IP /etc/openvswitch/of0\-cert.pem
Default location of certificate for the Open vSwitch switch's private key.
-.IP /etc/openvswitch/of0-privkey.pem
+.IP /etc/openvswitch/of0\-privkey.pem
Default location of the Open vSwitch switch's private key. This file
should be readable only by \fBroot\fR.
-.IP /etc/openvswitch/of0-req.pem
+.IP /etc/openvswitch/of0\-req.pem
Default location of certificate request for the Open vSwitch switch's
certificate. This file is not used after the signed certificate
-(typically \fB/etc/openvswitch/of0-cert.pem\fR, above) has been
+(typically \fB/etc/openvswitch/of0\-cert.pem\fR, above) has been
obtained from the OpenFlow PKI server.
.SH "SEE ALSO"
.BR ovs\-dpctl (8),
-.BR ovs-pki (8),
-.BR ovs-openflowd (8)
+.BR ovs\-pki (8),
+.BR ovs\-openflowd (8)
diff --git a/lib/common-syn.man b/lib/common-syn.man
index ae1bed5..3b80551 100644
--- a/lib/common-syn.man
+++ b/lib/common-syn.man
@@ -1,4 +1,4 @@
.IP "Common options:"
-[\fB-h\fR | \fB--help\fR]
-[\fB-V\fR | \fB--version\fR]
+[\fB\-h\fR | \fB\-\-help\fR]
+[\fB\-V\fR | \fB\-\-version\fR]
diff --git a/lib/daemon-syn.man b/lib/daemon-syn.man
index 4970564..fcc15cc 100644
--- a/lib/daemon-syn.man
+++ b/lib/daemon-syn.man
@@ -1,5 +1,5 @@
.IP "Daemon options:"
-[\fB--pidfile\fR[\fB=\fIpidfile\fR]]
-[\fB--overwrite-pidfile\fR]
-[\fB--detach\fR]
-[\fB--no-chdir\fR]
+[\fB\-\-pidfile\fR[\fB=\fIpidfile\fR]]
+[\fB\-\-overwrite\-pidfile\fR]
+[\fB\-\-detach\fR]
+[\fB\-\-no\-chdir\fR]
diff --git a/lib/daemon.man b/lib/daemon.man
index 3dcb38d..d9f25e1 100644
--- a/lib/daemon.man
+++ b/lib/daemon.man
@@ -6,45 +6,45 @@ specified, or
if it does not begin with \fB/\fR, then it is created in
\fB at RUNDIR@\fR.
.IP
-If \fB--pidfile\fR is not specified, no pidfile is created.
+If \fB\-\-pidfile\fR is not specified, no pidfile is created.
.
.TP
-\fB--overwrite-pidfile\fR
-By default, when \fB--pidfile\fR is specified and the specified pidfile
+\fB\-\-overwrite\-pidfile\fR
+By default, when \fB\-\-pidfile\fR is specified and the specified pidfile
already exists and is locked by a running process, \fB\*(PN\fR refuses
-to start. Specify \fB--overwrite-pidfile\fR to cause it to instead
+to start. Specify \fB\-\-overwrite\-pidfile\fR to cause it to instead
overwrite the pidfile.
.IP
-When \fB--pidfile\fR is not specified, this option has no effect.
+When \fB\-\-pidfile\fR is not specified, this option has no effect.
.
.TP
-\fB--detach\fR
+\fB\-\-detach\fR
Causes \fB\*(PN\fR to detach itself from the foreground session and
run as a background process.
.
.TP
-\fB--monitor\fR
+\fB\-\-monitor\fR
Creates an additional process to monitor the \fB\*(PN\fR daemon. If
the daemon dies due to a signal that indicates a programming error
(e.g. \fBSIGSEGV\fR, \fBSIGABRT\fR), then the monitor process starts a
new copy of it. If the daemon die or exits for another reason, the
monitor process exits.
.IP
-This option is normally used with \fB--detach\fR, but it also
+This option is normally used with \fB\-\-detach\fR, but it also
functions without it.
.
.TP
-\fB--no-chdir\fR
-By default, when \fB--detach\fR is specified, \fB\*(PN\fR
+\fB\-\-no\-chdir\fR
+By default, when \fB\-\-detach\fR is specified, \fB\*(PN\fR
changes its current working directory to the root directory after it
detaches. Otherwise, invoking \fB\*(PN\fR from a carelessly chosen
directory would prevent the administrator from unmounting the file
system that holds that directory.
.IP
-Specifying \fB--no-chdir\fR suppresses this behavior, preventing
+Specifying \fB\-\-no\-chdir\fR suppresses this behavior, preventing
\fB\*(PN\fR from changing its current working directory. This may be
useful for collecting core files, since it is common behavior to write
core dumps into the current working directory and the root directory
is not a good directory to use.
.IP
-This option has no effect when \fB--detach\fR is not specified.
+This option has no effect when \fB\-\-detach\fR is not specified.
diff --git a/lib/ssl-bootstrap.man b/lib/ssl-bootstrap.man
index 68e41c0..7fe4a1f 100644
--- a/lib/ssl-bootstrap.man
+++ b/lib/ssl-bootstrap.man
@@ -18,5 +18,5 @@ the server to send the CA certificate, but
\fBovs\-controller\fR(8) can be configured to do so with the
\fB\-\-peer\-ca\-cert\fR option.
.IP
-This option is mutually exclusive with \fB-C\fR and
+This option is mutually exclusive with \fB\-C\fR and
\fB\-\-ca\-cert\fR.
diff --git a/lib/ssl-peer-ca-cert.man b/lib/ssl-peer-ca-cert.man
index 183f93e..cfdd915 100644
--- a/lib/ssl-peer-ca-cert.man
+++ b/lib/ssl-peer-ca-cert.man
@@ -1,12 +1,12 @@
-.IP "\fB--peer-ca-cert=\fIpeer-cacert.pem\fR"
+.IP "\fB\-\-peer\-ca\-cert=\fIpeer-cacert.pem\fR"
Specifies a PEM file that contains one or more additional certificates
to send to SSL peers. \fIpeer-cacert.pem\fR should be the CA
certificate used to sign the \fB\*(PN\fR own certificate (the
-certificate specified on \fB-c\fR or \fB--certificate\fR).
+certificate specified on \fB\-c\fR or \fB\-\-certificate\fR).
.IP
This option is not useful in normal operation, because the SSL peer
must already have the CA certificate for the peer to have any
confidence in \fB\*(PN\fR's identity. However, this option allows a
newly installed switch to obtain the peer CA certificate on first boot
-using, e.g., the \fB\-\-bootstrap-ca-cert\fR option to
+using, e.g., the \fB\-\-bootstrap\-ca\-cert\fR option to
\fBovs\-openflowd\fR(8).
diff --git a/lib/vlog-syn.man b/lib/vlog-syn.man
index 873b2f0..3df967a 100644
--- a/lib/vlog-syn.man
+++ b/lib/vlog-syn.man
@@ -1,6 +1,6 @@
.IP "Logging options:"
-[\fB-v\fR[\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]]\&...
+[\fB\-v\fR[\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]]\&...
.br
-[\fB--verbose[=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]]\&...
+[\fB\-\-verbose[=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]]\&...
.br
-[\fB--log-file\fR[\fB=\fIfile\fR]]
+[\fB\-\-log\-file\fR[\fB=\fIfile\fR]]
diff --git a/lib/vlog-unixctl.man b/lib/vlog-unixctl.man
index 86eece3..5c60a85 100644
--- a/lib/vlog-unixctl.man
+++ b/lib/vlog-unixctl.man
@@ -7,7 +7,7 @@ Sets the logging level for \fImodule\fR in \fIfacility\fR to
.RS
.IP \(bu
\fImodule\fR may be any valid module name (as displayed by the
-\fB--list\fR action on \fBovs\-appctl\fR(8)), or the special name
+\fB\-\-list\fR action on \fBovs\-appctl\fR(8)), or the special name
\fBANY\fR to set the logging levels for all modules.
.
.IP \(bu
@@ -17,7 +17,7 @@ respectively, or \fBANY\fR to set the logging levels for both
facilities. If it is omitted, \fIfacility\fR defaults to \fBANY\fR.
.IP
The log level for the \fBfile\fR facility has no effect unless
-\fB\*(PN\fR was invoked with the \fB--log-file\fR option.
+\fB\*(PN\fR was invoked with the \fB\-\-log\-file\fR option.
.IP \(bu
\fIlevel\fR must be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR,
\fBinfo\fR, or
@@ -36,4 +36,4 @@ Causes \fB\*(PN\fR to close and reopen its log file. (This is useful
after rotating log files, to cause a new log file to be used.)
.IP
This has no effect unless \fB\*(PN\fR was invoked with the
-\fB--log-file\fR option.
+\fB\-\-log\-file\fR option.
diff --git a/lib/vlog.man b/lib/vlog.man
index ca895b1..a645f3a 100644
--- a/lib/vlog.man
+++ b/lib/vlog.man
@@ -1,5 +1,5 @@
.TP
-\fB-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB--verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
+\fB\-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB\-\-verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
.
Sets the logging level for \fImodule\fR in \fIfacility\fR to
\fIlevel\fR:
@@ -7,7 +7,7 @@ Sets the logging level for \fImodule\fR in \fIfacility\fR to
.RS
.IP \(bu
\fImodule\fR may be any valid module name (as displayed by the
-\fB--list\fR action on \fBovs\-appctl\fR(8)), or the special name
+\fB\-\-list\fR action on \fBovs\-appctl\fR(8)), or the special name
\fBANY\fR to set the logging levels for all modules.
.
.IP \(bu
@@ -17,7 +17,7 @@ respectively, or \fBANY\fR to set the logging levels for both
facilities. If it is omitted, \fIfacility\fR defaults to \fBANY\fR.
.IP
Regardless of the log levels set for \fBfile\fR, logging to a file
-will not take place unless \fB--log-file\fR is also specified (see
+will not take place unless \fB\-\-log\-file\fR is also specified (see
below).
.
.IP \(bu
@@ -28,17 +28,17 @@ logged. If it is omitted, \fIlevel\fR defaults to \fBdbg\fR.
.RE
.
.TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-v\fR, \fB\-\-verbose\fR
Sets the maximum logging verbosity level, equivalent to
-\fB--verbose=ANY:ANY:dbg\fR.
+\fB\-\-verbose=ANY:ANY:dbg\fR.
.
.TP
-\fB-vPATTERN:\fIfacility\fB:\fIpattern\fR, \fB--verbose=PATTERN:\fIfacility\fB:\fIpattern\fR
+\fB\-vPATTERN:\fIfacility\fB:\fIpattern\fR, \fB\-\-verbose=PATTERN:\fIfacility\fB:\fIpattern\fR
Sets the log pattern for \fIfacility\fR to \fIpattern\fR. Refer to
\fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
.
.TP
-\fB--log-file\fR[\fB=\fIfile\fR]
+\fB\-\-log\-file\fR[\fB=\fIfile\fR]
Enables logging to a file. If \fIfile\fR is specified, then it is
used as the exact name for the log file. The default log file name
used if \fIfile\fR is omitted is \fB at LOGDIR@/\*(PN.log\fR.
diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in
index 7607157..a74b87e 100644
--- a/ovsdb/ovsdb-client.1.in
+++ b/ovsdb/ovsdb-client.1.in
@@ -14,11 +14,11 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
.SH SYNOPSIS
\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-dbs\fI server\fR
.br
-\fBovsdb\-client \fR[\fIoptions\fR] \fBget-schema\fI server database\fR
+\fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\fI server database\fR
.br
-\fBovsdb\-client \fR[\fIoptions\fR] \fBlist-tables\fI server database\fR
+\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-tables\fI server database\fR
.br
-\fBovsdb\-client \fR[\fIoptions\fR] \fBlist-columns\fI server database \fR[\fItable\fR]
+\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-columns\fI server database \fR[\fItable\fR]
.br
\fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR
.br
@@ -30,8 +30,8 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
.br
\fBovsdb\-client help\fR
.IP "Output formatting options:"
-[\fB--format=\fIformat\fR]
-[\fB--no-heading\fR]
+[\fB\-\-format=\fIformat\fR]
+[\fB\-\-no\-heading\fR]
.so lib/daemon-syn.man
.so lib/vlog-syn.man
.so lib/ssl-syn.man
@@ -50,21 +50,21 @@ the following forms:
.
.SS "Commands"
The following commands are implemented:
-.IP "\fBlist-dbs\fI server\fR"
+.IP "\fBlist\-dbs\fI server\fR"
Connects to \fIserver\fR, retrieves the list of known databases, and
prints them one per line. These database names are the ones that may
be used for \fIdatabase\fR in the following commands.
.
-.IP "\fBget-schema\fI server database\fR"
+.IP "\fBget\-schema\fI server database\fR"
Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
prints it in JSON format.
.
-.IP "\fBlist-tables\fI server database\fR"
+.IP "\fBlist\-tables\fI server database\fR"
Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
prints a table listing the name of each table
within the database.
.
-.IP "\fBlist-columns\fI server database \fR[\fItable\fR]"
+.IP "\fBlist\-columns\fI server database \fR[\fItable\fR]"
Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
prints a table listing the name and type of each
column. If \fItable\fR is specified, only columns in that table are
@@ -96,7 +96,7 @@ Print deleted rows.
Print old and new values of modified rows.
.RE
.IP
-If \fB--detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
+If \fB\-\-detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
detaches after it has successfully received and printed the initial
contents of \fItable\fR.
.SH OPTIONS
@@ -104,8 +104,8 @@ contents of \fItable\fR.
Much of the output from \fBovsdb\-client\fR is in the form of tables.
The following options controlling output formatting:
.
-.IP "\fB-f \fIformat\fR"
-.IQ "\fB--format=\fIformat\fR"
+.IP "\fB\-f \fIformat\fR"
+.IQ "\fB\-\-format=\fIformat\fR"
Sets the type of table formatting. The following types of
\fIformat\fR are available:
.RS
@@ -117,22 +117,22 @@ HTML tables.
Comma-separated values as defined in RFC 4180.
.RE
.
-.IP "\fB-d \fIformat\fR"
-.IP "\fB--data=\fIformat\fR"
+.IP "\fB\-d \fIformat\fR"
+.IP "\fB\-\-data=\fIformat\fR"
Sets the formatting for cells within output tables. The following
types of \fIformat\fR are available:
.RS
.IP "\fBstring\fR (default)"
-The simple format described in \fBovs-vsctl\fR(8).
+The simple format described in \fBovs\-vsctl\fR(8).
.IP "\fBjson\fR"
JSON.
.RE
.
-.IP "\fB--no-heading\fR"
+.IP "\fB\-\-no\-heading\fR"
This option suppresses the heading row that otherwise appears in the
first row of table output.
.
-.IP "\fB--pretty\fR"
+.IP "\fB\-\-pretty\fR"
By default, JSON in output is printed as compactly as possible. This
option causes JSON in output to be printed in a more readable
fashion. Members of objects and elements of arrays are printed one
diff --git a/ovsdb/ovsdb-idlc.1 b/ovsdb/ovsdb-idlc.1
index a2de7ae..8d5132e 100644
--- a/ovsdb/ovsdb-idlc.1
+++ b/ovsdb/ovsdb-idlc.1
@@ -12,9 +12,9 @@ ovsdb\-idlc \- Open vSwitch IDL (Interface Definition Language) compiler
.br
\fBovsdb\-idlc \fBc\-idl\-source\fI idl\fR
.br
-\fBovsdb\-idlc --help\fR
+\fBovsdb\-idlc \-\-help\fR
.br
-\fBovsdb\-idlc --version\fR
+\fBovsdb\-idlc \-\-version\fR
.
.SH DESCRIPTION
The \fBovsdb\-idlc\fR program is a command-line tool for translating
diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in
index b36c61d..fe1deb8 100644
--- a/ovsdb/ovsdb-server.1.in
+++ b/ovsdb/ovsdb-server.1.in
@@ -8,12 +8,12 @@ ovsdb\-server \- Open vSwitch database server
.SH SYNOPSIS
\fBovsdb\-server\fR
\fIdatabase\fR
-[\fB--remote=\fIremote\fR]\&...
-[\fB--run=\fIcommand\fR]
-.so lib/daemon-syn.man
-.so lib/vlog-syn.man
-.so lib/unixctl-syn.man
-.so lib/common-syn.man
+[\f\-\-remote=\fIremote\fR]\&...
+[\f\-\-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
The \fBovsdb\-server\fR program provides RPC interfaces to an Open
@@ -54,7 +54,7 @@ otherwise, it exits with exit code 1.
.IP
This option can be useful where a database server is needed only to
run a single command, e.g.:
-.B "ovsdb-server --remote=punix:socket --run='ovsdb-client dump unix:socket Open_vSwitch'"
+.B "ovsdb\-server \-\-remote=punix:socket \-\-run='ovsdb\-client dump unix:socket Open_vSwitch'"
.SS "Daemon Options"
.so lib/daemon.man
.SS "Logging Options"
@@ -78,11 +78,11 @@ one row in \fItable\fR.)
\fBovs\-appctl\fR(8) can send commands to a running
\fBovsdb\-server\fR process. The currently supported commands are
described below.
-.SS "OVSDB-SERVER COMMANDS"
+.SS "OVSDB\-SERVER COMMANDS"
These commands are specific to \fBovsdb\-server\fR.
.IP "\fBexit\fR"
Causes \fBovsdb\-server\fR to gracefully terminate.
-.IP "\fBovsdb-server/compact\fR"
+.IP "\fBovsdb\-server/compact\fR"
Compacts the database in-place. The database is also automatically
compacted occasionally.
.
diff --git a/ovsdb/ovsdb-tool.1.in b/ovsdb/ovsdb-tool.1.in
index c2c2ce3..b073f6d 100644
--- a/ovsdb/ovsdb-tool.1.in
+++ b/ovsdb/ovsdb-tool.1.in
@@ -18,7 +18,7 @@ ovsdb\-tool \- Open vSwitch database management utility
.br
\fBovsdb\-tool \fR[\fIoptions\fR] \fBtransact\fI db transaction\fR
.br
-\fBovsdb\-tool \fR[\fIoptions\fR] [\fB-m\fR | \fB--more\fR]... \fBshow\-log\fI db\fR
+\fBovsdb\-tool \fR[\fIoptions\fR] [\fB\-m\fR | \fB\-\-more\fR]... \fBshow\-log\fI db\fR
.br
\fBovsdb\-tool help\fR
.so lib/vlog-syn.man
@@ -71,7 +71,7 @@ described in the OVSDB specification.
.IP
The \fIdb\fR is opened for read-only access, so this command may
safely run concurrently with other database activity, including
-\fBovsdb-server\fR and other database writers. The \fItransaction\fR
+\fBovsdb\-server\fR and other database writers. The \fItransaction\fR
may specify database modifications, but these will have no effect on
\fIdb\fR.
.
@@ -83,19 +83,19 @@ JSON array in the format of the \fBparams\fR array for the JSON-RPC
.IP
The \fIdb\fR is opened and locked for read/write access, so this
command will fail if the database is opened for writing by any other
-process, including \fBovsdb-server\fR(1). Use \fBovsdb\-client\fR(1),
+process, including \fBovsdb\-server\fR(1). Use \fBovsdb\-client\fR(1),
instead, to write to a database that is served by
-\fBovsdb-server\fR(1).
+\fBovsdb\-server\fR(1).
.
-.IP "\fBshow-log\fI db\fR"
+.IP "\fBshow\-log\fI db\fR"
Prints a summary of the records in \fBdb\fR's log, including the time
and date at which each database change occurred and any associated
comment. This may be useful for debugging.
.PP
-To increase the verbosity of output, add \fB-m\fR (or \fB--more\fR)
-one or more times to the command line. With one \fB-m\fR,
+To increase the verbosity of output, add \fB\-m\fR (or \fB\-\-more\fR)
+one or more times to the command line. With one \fB\-m\fR,
\fBshow\-log\fR prints a summary of the records added, deleted, or
-modified by each transaction. With two \fB-m\fRs, \fBshow\-log\fR
+modified by each transaction. With two \fB\-m\fRs, \fBshow\-log\fR
also prints the values of the columns modified by each change to a
record.
.
diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in
index 3248e2c..b1f2ab6 100644
--- a/utilities/ovs-appctl.8.in
+++ b/utilities/ovs-appctl.8.in
@@ -11,12 +11,12 @@
ovs\-appctl \- utility for configuring running Open vSwitch daemons
.
.SH SYNOPSIS
-\fBovs\-appctl\fR [\fB--target=\fItarget\fR | \fB-t\fR \fItarget\fR]
+\fBovs\-appctl\fR [\fB\-\-target=\fItarget\fR | \fB\-t\fR \fItarget\fR]
\fIcommand \fR[\fIarg\fR...]
.br
-\fBovs\-appctl\fR --help
+\fBovs\-appctl\fR \-\-help
.br
-\fBovs\-appctl\fR --version
+\fBovs\-appctl\fR \-\-version
.SH DESCRIPTION
Open vSwitch daemons accept certain commands at runtime to control
their behavior and query their settings. Every daemon accepts the
@@ -40,8 +40,8 @@ on which an Open vSwitch daemon is listening for control channel
connections. By default, each daemon listens on a Unix domain socket
named \fB at RUNDIR@/\fIprogram\fB.\fIpid\fB.ctl\fR, where \fIprogram\fR
is the program's name and \fIpid\fR is its process ID. For example,
-if \fBovs-vswitchd\fR has PID 123, it would listen on
-\fB at RUNDIR@/ovs-vswitchd.123.ctl\fR.
+if \fBovs\-vswitchd\fR has PID 123, it would listen on
+\fB at RUNDIR@/ovs\-vswitchd.123.ctl\fR.
.IP
Otherwise, \fBovs\-appctl\fR looks for a pidfile, that is, a file
whose contents are the process ID of a running process as a decimal
@@ -64,7 +64,7 @@ Lists the known logging modules and their current levels.
.IP "\fBvlog/set\fR \fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]"
Sets the logging level for \fImodule\fR in \fIfacility\fR to
\fIlevel\fR. The \fImodule\fR may be any valid module name (as
-displayed by the \fB--list\fR option) or the special name \fBANY\fR to
+displayed by the \fB\-\-list\fR option) or the special name \fBANY\fR to
set the logging levels for all modules. The \fIfacility\fR may be
\fBsyslog\fR or \fBconsole\fR to set the levels for logging to the
system log or to the console, respectively, or \fBANY\fR to set the
@@ -83,14 +83,14 @@ expanded as follows:
.
.RS
.IP \fB%A\fR
-The name of the application logging the message, e.g. \fBovs-vswitchd\fR.
+The name of the application logging the message, e.g. \fBovs\-vswitchd\fR.
.
.IP \fB%c\fR
-The name of the module (as shown by \fBovs\-appctl --list\fR) logging
+The name of the module (as shown by \fBovs\-appctl \-\-list\fR) logging
the message.
.
.IP \fB%d\fR
-The current date and time in ISO 8601 format (YYYY-MM-DD HH:MM:SS).
+The current date and time in ISO 8601 format (YYYY\-MM\-DD HH:MM:SS).
.
.IP \fB%d{\fIformat\fB}\fR
The current date and time in the specified \fIformat\fR, which takes
@@ -126,7 +126,7 @@ A few options may appear between the \fB%\fR and the format specifier
character, in this order:
.
.RS
-.IP \fB-\fR
+.IP \fB\-\fR
Left justify the escape's expansion within its field width. Right
justification is the default.
.
@@ -150,7 +150,7 @@ is useful after rotating log files, to cause a new log file to be
used.)
.IP
This has no effect if the target application was not invoked with the
-\fB--log-file\fR option.
+\fB\-\-log\-file\fR option.
.
.SH OPTIONS
.
diff --git a/utilities/ovs-controller.8.in b/utilities/ovs-controller.8.in
index 0501062..c345644 100644
--- a/utilities/ovs-controller.8.in
+++ b/utilities/ovs-controller.8.in
@@ -21,7 +21,7 @@ one or more of the following OpenFlow connection methods:
.RE
.
.SH OPTIONS
-.IP "\fB-n\fR, \fB--noflow\fR"
+.IP "\fB\-n\fR, \fB\-\-noflow\fR"
By default, \fBovs\-controller\fR sets up a flow in each OpenFlow switch
whenever it receives a packet whose destination is known due through
MAC learning. This option disables flow setup, so that every packet
@@ -31,7 +31,7 @@ This option is most useful for debugging. It reduces switching
performance, so it should not be used in production.
.
.TP
-\fB--max-idle=\fIsecs\fR|\fBpermanent\fR
+\fB\-\-max\-idle=\fIsecs\fR|\fBpermanent\fR
Sets \fIsecs\fR as the number of seconds that a flow set up by the
controller will remain in the switch's flow table without any matching
packets being seen. If \fBpermanent\fR is specified, which is not
@@ -40,33 +40,33 @@ recommended, flows will never expire. The default is 60 seconds.
This option affects only flows set up by the OpenFlow controller. In
some configurations, the switch can set up some flows
on its own. To set the idle time for those flows, pass
-\fB--max-idle\fR to \fBovs\-openflowd\fR (on the switch).
+\fB\-\-max\-idle\fR to \fBovs\-openflowd\fR (on the switch).
.IP
-This option has no effect when \fB-n\fR (or \fB--noflow\fR) is in use
+This option has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use
(because the controller does not set up flows in that case).
.
-.IP "\fB-H\fR, \fB--hub\fR"
+.IP "\fB\-H\fR, \fB\-\-hub\fR"
By default, the controller acts as an L2 MAC-learning switch. This
option changes its behavior to that of a hub that floods packets on
all but the incoming port.
.IP
-If \fB-H\fR (or \fB--hub\fR) and \fB-n\fR (or \fB--noflow\fR) are used
+If \fB\-H\fR (or \fB\-\-hub\fR) and \fB\-n\fR (or \fB\-\-noflow\fR) are used
together, then the cumulative effect is that every packet passes
through the controller and every packet is flooded.
.IP
This option is most useful for debugging. It reduces switching
performance, so it should not be used in production.
.
-.IP "\fB-w\fR, \fB--wildcard\fR"
+.IP "\fB\-w\fR, \fB\-\-wildcard\fR"
By default, \fBovs\-controller\fR sets up exact-match flows. This
option allows it to set up wildcarded flows, which may reduce
flow-setup latency by causing less traffic to be sent up to the
controller.
.IP
-This option has no effect when \fB-n\fR (or \fB--noflow\fR) is in use
+This option has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use
(because the controller does not set up flows in that case).
.
-.IP "\fB-N\fR, \fB--normal\fR"
+.IP "\fB\-N\fR, \fB\-\-normal\fR"
By default, \fBovs\-controller\fR directs packets to a particular port
or floods them. This option causes it to direct non-flooded packets
to the OpenFlow \fBOFPP_NORMAL\fR port. This allows the switch itself
@@ -74,7 +74,7 @@ to make decisions about packet destinations. Support for
\fBOFPP_NORMAL\fR is optional in OpenFlow, so this option may not well
with some non-Open vSwitch switches.
.
-.IP "\fB--mute\fR"
+.IP "\fB\-\-mute\fR"
Prevents ovs\-controller from replying to any OpenFlow messages sent
to it by switches.
.IP
diff --git a/utilities/ovs-discover.8.in b/utilities/ovs-discover.8.in
index 61e4b12..c9bbbb5 100644
--- a/utilities/ovs-discover.8.in
+++ b/utilities/ovs-discover.8.in
@@ -27,7 +27,7 @@ itself to the background.
.SH OPTIONS
.TP
-\fB--accept-vconn=\fIregex\fR
+\fB\-\-accept\-vconn=\fIregex\fR
With this option, only controllers whose names match POSIX extended
regular expression \fIregex\fR will be accepted. Specifying
\fBssl:.*\fR for \fIregex\fR, for example, would cause only SSL
@@ -39,7 +39,7 @@ controller location string, as if it begins with \fB^\fR.
When this option is not given, the default \fIregex\fR is
\fBtcp:.*\fR.
.TP
-\fB--exit-without-bind\fR
+\fB\-\-exit\-without\-bind\fR
By default, \fBovs\-discover\fR binds the network device that receives
the first acceptable response to the IP address received over DHCP.
With this option, the configuration of the network device is not
@@ -47,11 +47,11 @@ changed at all, except to bring it up if it is initially down, and
\fBovs\-discover\fR will exit immediately after it receives an
acceptable DHCP response.
-This option is mutually exclusive with \fB--exit-after-bind\fR and
-\fB--no-detach\fR.
+This option is mutually exclusive with \fB\-\-exit\-after\-bind\fR and
+\fB\-\-no\-detach\fR.
.TP
-\fB--exit-after-bind\fR
+\fB\-\-exit\-after\-bind\fR
By default, after it receives an acceptable DHCP response,
\fBovs\-discover\fR detaches itself from the foreground session and
runs in the background maintaining the DHCP lease as necessary. With
@@ -60,39 +60,39 @@ receives an acceptable DHCP response and configures the network device
with the received IP address. The address obtained via DHCP could
therefore be used past the expiration of its lease.
-This option is mutually exclusive with \fB--exit-without-bind\fR and
-\fB--no-detach\fR.
+This option is mutually exclusive with \fB\-\-exit\-without\-bind\fR and
+\fB\-\-no\-detach\fR.
.TP
-\fB--no-detach\fR
+\fB\-\-no\-detach\fR
By default, \fBovs\-discover\fR runs in the foreground until it obtains
an acceptable DHCP response, then it detaches itself from the
foreground session and run as a background process. This option
prevents \fBovs\-discover\fR from detaching, causing it to run in the
foreground even after it obtains a DHCP response.
-This option is mutually exclusive with \fB--exit-without-bind\fR and
-\fB--exit-after-bind\fR.
+This option is mutually exclusive with \fB\-\-exit\-without\-bind\fR and
+\fB\-\-exit\-after\-bind\fR.
.TP
-\fB--pidfile\fR[\fB=\fIpidfile\fR]
+\fB\-\-pidfile\fR[\fB=\fIpidfile\fR]
Causes a file (by default, \fBovs\-discover.pid\fR) to be created indicating
the PID of the running process. If \fIpidfile\fR is not specified, or
if it does not begin with \fB/\fR, then it is created in
\fB at RUNDIR@\fR.
The \fIpidfile\fR is created when \fBovs\-discover\fR detaches, so
-this this option has no effect when one of \fB--exit-without-bind\fR,
-\fB--exit-after-bind\fR, or \fB--no-detach\fR is also given.
+this this option has no effect when one of \fB\-\-exit\-without\-bind\fR,
+\fB\-\-exit\-after\-bind\fR, or \fB\-\-no\-detach\fR is also given.
.TP
-\fB--overwrite-pidfile\fR
-By default, when \fB--pidfile\fR is specified and the specified pidfile
+\fB\-\-overwrite\-pidfile\fR
+By default, when \fB\-\-pidfile\fR is specified and the specified pidfile
already exists and is locked by a running process, \fBcontroller\fR refuses
-to start. Specify \fB--overwrite-pidfile\fR to cause it to instead
+to start. Specify \fB\-\-overwrite\-pidfile\fR to cause it to instead
overwrite the pidfile.
-When \fB--pidfile\fR is not specified, this option has no effect.
+When \fB\-\-pidfile\fR is not specified, this option has no effect.
.so lib/vlog.man
.so lib/common.man
diff --git a/utilities/ovs-dpctl.8.in b/utilities/ovs-dpctl.8.in
index 752a447..b7965bc 100644
--- a/utilities/ovs-dpctl.8.in
+++ b/utilities/ovs-dpctl.8.in
@@ -77,7 +77,7 @@ Removes each \fInetdev\fR from the list of network devices datapath
\fIdp\fR monitors.
.
.TP
-\fBdump-dps\fR
+\fBdump\-dps\fR
Prints the name of each configured datapath on a separate line.
.
.TP
@@ -90,7 +90,7 @@ If one or more datapaths are specified, information on only those
datapaths are displayed. Otherwise, \fBovs\-dpctl\fR displays information
about all configured datapaths.
.
-.IP "\fBdump-flows \fIdp\fR"
+.IP "\fBdump\-flows \fIdp\fR"
Prints to the console all flow entries in datapath \fIdp\fR's
flow table.
.IP
@@ -98,15 +98,15 @@ This command is primarily useful for debugging Open vSwitch. The flow
table entries that it displays are not
OpenFlow flow entries. Instead, they are different and considerably
simpler flows maintained by the Open vSwitch kernel module.
-.IP "\fBdel-flows \fIdp\fR"
+.IP "\fBdel\-flows \fIdp\fR"
Deletes all flow entries from datapath \fIdp\fR's flow table.
.IP
This command is primarily useful for debugging Open vSwitch. As
-discussed in \fBdump-flows\fR, these entries are
+discussed in \fBdump\-flows\fR, these entries are
not OpenFlow flow entries. By deleting them, the process that set them
up may be confused about their disappearance.
.
-.IP "\fBdump-groups \fIdp\fR"
+.IP "\fBdump\-groups \fIdp\fR"
Prints to the console the sets of port groups maintained by datapath
\fIdp\fR. Ordinarily there are at least 2 port groups in a datapath
that \fBovs\-openflowd\fR or \fBovs\-vswitch\fR is controlling: group
@@ -118,7 +118,7 @@ This command is primarily useful for debugging Open vSwitch. OpenFlow
does not have a concept of port groups.
.SH OPTIONS
.TP
-\fB-t\fR, \fB--timeout=\fIsecs\fR
+\fB\-t\fR, \fB\-\-timeout=\fIsecs\fR
Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds. If
the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
signal.
diff --git a/utilities/ovs-kill.8.in b/utilities/ovs-kill.8.in
index af4ec98..e8fef36 100644
--- a/utilities/ovs-kill.8.in
+++ b/utilities/ovs-kill.8.in
@@ -25,13 +25,13 @@ interface to \fBfcntl\fR-based file locking.
.SH OPTIONS
.TP
-\fB-s \fInumber\fR|\fIname\fR, \fB\-\^\-signal=\fInumber\fR|\fIname\fR
+\fB\-s \fInumber\fR|\fIname\fR, \fB\-\^\-signal=\fInumber\fR|\fIname\fR
Sets the signal to be sent to each process. Signals may be given by
number (e.g. \fB1\fR) or by name (e.g. \fBHUP\fR or \fBSIGHUP\fR).
By default, \fBSIGTERM\fR is sent.
.TP
-\fB-f\fR, \fB\-\^\-force\fR
+\fB\-f\fR, \fB\-\^\-force\fR
Causes \fBovs\-kill\fR to ignore all errors without printing a message
to \fBstderr\fR, and to exit with return code 0.
@@ -39,12 +39,12 @@ to \fBstderr\fR, and to exit with return code 0.
.SH "EXIT CODE"
-Without \fB-f\fR or \fB\-\^\-force\fR, \fBovs\-kill\fR exits with
+Without \fB\-f\fR or \fB\-\^\-force\fR, \fBovs\-kill\fR exits with
status 0 if at least one \fIpidfile\fR was given and the process
represented by every \fIpidfile\fR was signaled successfully,
otherwise with status 1.
-With \fB-f\fR or \fB\-\^\-force\fR, \fBovs\-kill\fR always exits with
+With \fB\-f\fR or \fB\-\^\-force\fR, \fBovs\-kill\fR always exits with
status 0.
.SH BUGS
diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in
index d0a598c..54d222a 100644
--- a/utilities/ovs-ofctl.8.in
+++ b/utilities/ovs-ofctl.8.in
@@ -61,19 +61,19 @@ pairs whose key names begin with \fIkey\fR are printed. If \fIkey\fR is
omitted, all key-value pairs are printed.
.
.TP
-\fBdump-tables \fIswitch\fR
+\fBdump\-tables \fIswitch\fR
Prints to the console statistics for each of the flow tables used by
\fIswitch\fR.
.
.TP
-\fBdump-ports \fIswitch\fR [\fInetdev\fR]
+\fBdump\-ports \fIswitch\fR [\fInetdev\fR]
Prints to the console statistics for network devices associated with
\fIswitch\fR. If \fInetdev\fR is specified, only the statistics
associated with that device will be printed. \fInetdev\fR can be an
OpenFlow assigned port number or device name, e.g. \fBeth0\fR.
.
.TP
-\fBmod-port \fIswitch\fR \fInetdev\fR \fIaction\fR
+\fBmod\-port \fIswitch\fR \fInetdev\fR \fIaction\fR
Modify characteristics of an interface monitored by \fIswitch\fR.
\fInetdev\fR can be referred to by its OpenFlow assigned port number or
the device name, e.g. \fBeth0\fR. The \fIaction\fR may be any one of the
@@ -100,7 +100,7 @@ spanning tree protocol is not in use.
.RE
.
.TP
-\fBdump-flows \fIswitch \fR[\fIflows\fR]
+\fBdump\-flows \fIswitch \fR[\fIflows\fR]
Prints to the console all flow entries in \fIswitch\fR's
tables that match \fIflows\fR. If \fIflows\fR is omitted, all flows
in the switch are retrieved. See \fBFlow Syntax\fR, below, for the
@@ -108,7 +108,7 @@ syntax of \fIflows\fR. The output format is described in
\fBTable Entry Output\fR.
.
.TP
-\fBdump-aggregate \fIswitch \fR[\fIflows\fR]
+\fBdump\-aggregate \fIswitch \fR[\fIflows\fR]
Prints to the console aggregate statistics for flows in
\fIswitch\fR's tables that match \fIflows\fR. If \fIflows\fR is omitted,
the statistics are aggregated across all flows in the switch's flow
@@ -116,30 +116,30 @@ tables. See \fBFlow Syntax\fR, below, for the syntax of \fIflows\fR.
The output format is descrbed in \fBTable Entry Output\fR.
.
.TP
-\fBadd-flow \fIswitch flow\fR
+\fBadd\-flow \fIswitch flow\fR
Add the flow entry as described by \fIflow\fR to the \fIswitch\fR's
tables. The flow entry is in the format described in \fBFlow Syntax\fR,
below.
.
.TP
-\fBadd-flows \fIswitch file\fR
+\fBadd\-flows \fIswitch file\fR
Add flow entries as described in \fIfile\fR to \fIswitch\fR's
tables. Each line in \fIfile\fR is a flow entry in the format
described in \fBFlow Syntax\fR, below.
.
.TP
-\fBmod-flows \fIswitch flow\fR
+\fBmod\-flows \fIswitch flow\fR
Modify the actions in entries from the \fIswitch\fR's tables
-that match \fIflow\fR. When invoked with the \fB--strict\fR option,
+that match \fIflow\fR. When invoked with the \fB\-\-strict\fR option,
wildcards are not treated as active for matching purposes. See
\fBFlow Syntax\fR, below, for the syntax of \fIflows\fR.
.
.TP
-\fBdel-flows \fIswitch \fR[\fIflow\fR]
+\fBdel\-flows \fIswitch \fR[\fIflow\fR]
Deletes entries from the \fIswitch\fR's tables that match
-\fIflow\fR. When invoked with the \fB--strict\fR option, wildcards are
+\fIflow\fR. When invoked with the \fB\-\-strict\fR option, wildcards are
not treated as active for matching purposes. If \fIflow\fR is
-omitted and the \fB--strict\fR option is not used, all flows in the
+omitted and the \fB\-\-strict\fR option is not used, all flows in the
switch's tables are removed. See \fBFlow Syntax\fR, below, for the
syntax of \fIflows\fR.
.
@@ -171,7 +171,7 @@ monitoring will not show any traffic.
.IQ "\fBmonitor \fIswitch\fR [\fImiss-len\fR]"
Connects to \fIswitch\fR and prints to the console all OpenFlow
messages received. Usually, \fIswitch\fR should specify a connection
-named on \fBovs\-openflowd\fR(8)'s \fB-l\fR or \fB--listen\fR command line
+named on \fBovs\-openflowd\fR(8)'s \fB\-l\fR or \fB\-\-listen\fR command line
option.
.IP
If \fImiss-len\fR is provided, \fBovs\-ofctl\fR sends an OpenFlow ``set
@@ -195,7 +195,7 @@ applied to OpenFlow controllers.
.TP
\fBprobe \fItarget\fR
Sends a single OpenFlow echo-request message to \fItarget\fR and waits
-for the response. With the \fB-t\fR or \fB--timeout\fR option, this
+for the response. With the \fB\-t\fR or \fB\-\-timeout\fR option, this
command can test whether an OpenFlow switch or controller is up and
running.
.
@@ -348,7 +348,7 @@ Same as \fBdl_type=0x0800,nw_proto=17\fR.
Same as \fBdl_type=0x0806\fR.
.
.PP
-The \fBadd-flow\fR and \fBadd-flows\fR commands require an additional
+The \fBadd\-flow\fR and \fBadd\-flows\fR commands require an additional
field, which must be the final field specified:
.
.IP \fBactions=\fR[\fItarget\fR][\fB,\fItarget\fR...]\fR
@@ -463,7 +463,7 @@ A cookie is an opaque identifier that can be associated with the flow.
flows.
.
.PP
-The \fBadd-flow\fR, \fBadd-flows\fR, and \fBdel-flows\fR commands
+The \fBadd\-flow\fR, \fBadd\-flows\fR, and \fBdel\-flows\fR commands
support an additional optional field:
.
.IP \fBpriority=\fIvalue\fR
@@ -475,7 +475,7 @@ priority value of 65535. When adding a flow, if the field is not specified,
the flow's priority will default to 32768.
.
.PP
-The \fBadd-flow\fR and \fBadd-flows\fR commands support additional
+The \fBadd\-flow\fR and \fBadd\-flows\fR commands support additional
optional fields:
.
.TP
@@ -490,28 +490,28 @@ regardless of activity. A value of 0 (the default) gives the flow no
hard expiration deadline.
.
.PP
-The \fBdump-flows\fR, \fBdump-aggregate\fR, \fBdel-flow\fR
-and \fBdel-flows\fR commands support one additional optional field:
+The \fBdump\-flows\fR, \fBdump\-aggregate\fR, \fBdel\-flow\fR
+and \fBdel\-flows\fR commands support one additional optional field:
.
.TP
\fBout_port=\fIport\fR
If set, a matching flow must include an output action to \fIport\fR.
.
.PP
-The \fBdump-flows\fR and \fBdump-aggregate\fR commands support an
+The \fBdump\-flows\fR and \fBdump\-aggregate\fR commands support an
additional optional field:
.
.IP \fBtable=\fInumber\fR
If specified, limits the flows about which statistics are gathered to
those in the table with the given \fInumber\fR. Tables are numbered
-as shown by the \fBdump-tables\fR command.
+as shown by the \fBdump\-tables\fR command.
.
If this field is not specified, or if \fInumber\fR is given as
\fB255\fR, statistics are gathered about flows from all tables.
.
.SS "Table Entry Output"
.
-The \fBdump-tables\fR and \fBdump-aggregate\fR commands print information
+The \fBdump\-tables\fR and \fBdump\-aggregate\fR commands print information
about the entries in a datapath's tables. Each line of output is a
unique flow entry, which begins with some common information:
.
@@ -521,7 +521,7 @@ The number of seconds the entry has been in the table.
.IP \fBtable_id\fR
The table that contains the flow. When a packet arrives, the switch
begins searching for an entry at the lowest numbered table. Tables are
-numbered as shown by the \fBdump-tables\fR command.
+numbered as shown by the \fBdump\-tables\fR command.
.
.IP \fBpriority\fR
The priority of the entry in relation to other entries within the same
@@ -540,7 +540,7 @@ described in \fBFlow Syntax\fR, above.
.
.SH OPTIONS
.TP
-\fB--strict\fR
+\fB\-\-strict\fR
Uses strict matching when running flow modification commands.
.
.SS "Public Key Infrastructure Options"
@@ -553,16 +553,16 @@ Uses strict matching when running flow modification commands.
The following examples assume that an OpenFlow switch on the local
host has been configured to listen for management connections on a
Unix domain socket named \fB at RUNDIR@/openflow.sock\fR, e.g. by
-specifying \fB--listen=punix:@RUNDIR@/openflow.sock\fR on the
+specifying \fB\-\-listen=punix:@RUNDIR@/openflow.sock\fR on the
\fBovs\-openflowd\fR(8) command line.
.
.TP
-\fBovs\-ofctl dump-tables unix:@RUNDIR@/openflow.sock\fR
+\fBovs\-ofctl dump\-tables unix:@RUNDIR@/openflow.sock\fR
Prints out the switch's table stats. (This is more interesting after
some traffic has passed through.)
.
.TP
-\fBovs\-ofctl dump-flows unix:@RUNDIR@/openflow.sock\fR
+\fBovs\-ofctl dump\-flows unix:@RUNDIR@/openflow.sock\fR
Prints the flow entries in the switch.
.
.SH "SEE ALSO"
diff --git a/utilities/ovs-openflowd.8.in b/utilities/ovs-openflowd.8.in
index e50a4a7..47af872 100644
--- a/utilities/ovs-openflowd.8.in
+++ b/utilities/ovs-openflowd.8.in
@@ -39,7 +39,7 @@ any of the network devices added to the datapath with \fBovs\-dpctl
add\-if\fR in its communication with the controller.
.IP
To use \fBovs\-openflowd\fR in a network with out-of-band control, specify
-\fB--out-of-band\fR on the \fBovs\-openflowd\fR command line. The control
+\fB\-\-out\-of\-band\fR on the \fBovs\-openflowd\fR command line. The control
network must be configured separately, before or after \fBovs\-openflowd\fR
is started.
.
@@ -82,27 +82,27 @@ address range 192.168.0.20 through 192.168.0.30 to OpenFlow switches
that follow the switch protocol and addresses 192.168.0.1 through
192.168.0.10 to all other DHCP clients:
.IP
-default-lease-time 600;
+default\-lease\-time 600;
.br
-max-lease-time 7200;
+max\-lease\-time 7200;
.br
option space openflow;
.br
-option openflow.controller-vconn code 1 = text;
+option openflow.controller\-vconn code 1 = text;
.br
-option openflow.pki-uri code 2 = text;
+option openflow.pki\-uri code 2 = text;
.br
class "OpenFlow" {
.br
- match if option vendor-class-identifier = "OpenFlow";
+ match if option vendor\-class\-identifier = "OpenFlow";
.br
- vendor-option-space openflow;
+ vendor\-option\-space openflow;
.br
- option openflow.controller-vconn "tcp:192.168.0.10";
+ option openflow.controller\-vconn "tcp:192.168.0.10";
.br
- option openflow.pki-uri "http://192.168.0.10/openflow/pki";
+ option openflow.pki\-uri "http://192.168.0.10/openflow/pki";
.br
- option vendor-class-identifier "OpenFlow";
+ option vendor\-class\-identifier "OpenFlow";
.br
}
.br
@@ -157,7 +157,7 @@ the local port network device, and start the DHCP client afterward.
.SH OPTIONS
.SS "OpenFlow Options"
.TP
-\fB--datapath-id=\fIdpid\fR
+\fB\-\-datapath\-id=\fIdpid\fR
Sets \fIdpid\fR, which must consist of exactly 16 hexadecimal digits,
as the datapath ID that the switch will use to identify itself to
OpenFlow controllers.
@@ -167,27 +167,27 @@ Ethernet address of the datapath's local port (which is typically
randomly generated) in the lower 48 bits and zeros in the upper 16.
.
.TP
-\fB--mfr-desc=\fIdesc\fR
+\fB\-\-mfr\-desc=\fIdesc\fR
Set the description of the switch's manufacturer to \fIdesc\fR, which
may contain up to 255 ASCII characters.
.
.TP
-\fB--hw-desc=\fIdesc\fR
+\fB\-\-hw\-desc=\fIdesc\fR
Set the description of the switch's hardware revision to \fIdesc\fR, which
may contain up to 255 ASCII characters.
.
.TP
-\fB--sw-desc=\fIdesc\fR
+\fB\-\-sw\-desc=\fIdesc\fR
Set the description of the switch's software revision to \fIdesc\fR, which
may contain up to 255 ASCII characters.
.
.TP
-\fB--serial-desc=\fIdesc\fR
+\fB\-\-serial\-desc=\fIdesc\fR
Set the description of the switch's serial number to \fIdesc\fR, which
may contain up to 31 ASCII characters.
.
.TP
-\fB--dp-desc=\fIdesc\fR
+\fB\-\-dp\-desc=\fIdesc\fR
Set the description of the datapath to \fIdesc\fR, which may contain up to
255 ASCII characters. Note that this field is intended for debugging
purposes and is not guaranteed to be unique and should not be used as
@@ -195,7 +195,7 @@ the primary identifier of the datapath.
.
.SS "Controller Discovery Options"
.TP
-\fB--accept-vconn=\fIregex\fR
+\fB\-\-accept\-vconn=\fIregex\fR
When \fBovs\-openflowd\fR performs controller discovery (see \fBContacting
the Controller\fR, above, for more information about controller
discovery), it validates the controller location obtained via DHCP
@@ -204,8 +204,8 @@ names match the regular expression will be accepted.
.IP
The default regular expression is \fBssl:.*\fR (meaning that only SSL
controller connections will be accepted) when any of the SSL
-configuration options \fB--private-key\fR, \fB--certificate\fR, or
-\fB--ca-cert\fR is specified. The default is \fB^tcp:.*\fR otherwise
+configuration options \fB\-\-private\-key\fR, \fB\-\-certificate\fR, or
+\fB\-\-ca\-cert\fR is specified. The default is \fB^tcp:.*\fR otherwise
(meaning that only TCP controller connections will be accepted).
.IP
The \fIregex\fR is implicitly anchored at the beginning of the
@@ -214,7 +214,7 @@ controller location string, as if it begins with \fB^\fR.
When controller discovery is not performed, this option has no effect.
.
.TP
-\fB--no-resolv-conf\fR
+\fB\-\-no\-resolv\-conf\fR
When \fBovs\-openflowd\fR performs controller discovery (see \fBContacting
the Controller\fR, above, for more information about controller
discovery), by default it overwrites the system's
@@ -233,7 +233,7 @@ When controller discovery is not performed, this option has no effect.
.
.SS "Networking Options"
.TP
-\fB--datapath-id=\fIdpid\fR
+\fB\-\-datapath\-id=\fIdpid\fR
Sets \fIdpid\fR, which must consist of exactly 16 hexadecimal digits,
as the datapath ID that the switch will use to identify itself to the
OpenFlow controller.
@@ -243,7 +243,7 @@ Ethernet address of the datapath's local port (which is typically
randomly generated) in the lower 48 bits and zeros in the upper 16.
.
.TP
-\fB--fail=\fR[\fBstandalone\fR|\fBsecure\fR]
+\fB\-\-fail=\fR[\fBstandalone\fR|\fBsecure\fR]
The controller is, ordinarily, responsible for setting up all flows on
the OpenFlow switch. Thus, if the connection to the controller fails,
no new network connections can be set up. If the connection to the
@@ -264,7 +264,7 @@ If this option is set to \fBsecure\fR, then \fBovs\-openflowd\fR will not
set up flows on its own when the controller connection fails.
.
.TP
-\fB--inactivity-probe=\fIsecs\fR
+\fB\-\-inactivity\-probe=\fIsecs\fR
When the OpenFlow switch is connected to the controller, the
switch waits for a message to be received from the controller for
\fIsecs\fR seconds before it sends a inactivity probe to the
@@ -278,7 +278,7 @@ interval also changes the interval before entering fail-open mode (see
above).
.
.TP
-\fB--max-idle=\fIsecs\fR|\fBpermanent\fR
+\fB\-\-max\-idle=\fIsecs\fR|\fBpermanent\fR
Sets \fIsecs\fR as the number of seconds that a flow set up by the
OpenFlow switch will remain in the switch's flow table without any
matching packets being seen. If \fBpermanent\fR is specified, which
@@ -291,7 +291,7 @@ OpenFlow switch sets up itself:
.
.RS
.IP \(bu
-When \fB--fail=open\fR is specified, flows set up when the
+When \fB\-\-fail=open\fR is specified, flows set up when the
switch has not been able to contact the controller for the configured
fail-open delay.
.
@@ -302,11 +302,11 @@ more information about in-band control).
.RE
.
.IP
-As a result, when both \fB--fail=secure\fR and \fB--out-of-band\fR are
+As a result, when both \fB\-\-fail=secure\fR and \fB\-\-out\-of\-band\fR are
specified, this option has no effect.
.
.TP
-\fB--max-backoff=\fIsecs\fR
+\fB\-\-max\-backoff=\fIsecs\fR
Sets the maximum time between attempts to connect to the controller to
\fIsecs\fR, which must be at least 1. The actual interval between
connection attempts starts at 1 second and doubles on each failing
@@ -314,7 +314,7 @@ attempt until it reaches the maximum. The default maximum backoff
time is 8 seconds.
.
.TP
-\fB-l\fR, \fB--listen=\fImethod\fR
+\fB\-l\fR, \fB\-\-listen=\fImethod\fR
By default, the switch listens for OpenFlow management connections on a
Unix domain socket named \fB at RUNDIR@/\fIdatapath\fB.mgmt\fR. This socket
can be used to perform local OpenFlow monitoring and administration with
@@ -331,27 +331,27 @@ used, no listeners will be created.
.RE
.
.TP
-\fB--snoop=\fImethod\fR
+\fB\-\-snoop=\fImethod\fR
Configures the switch to additionally listen for incoming OpenFlow
connections for controller connection snooping. The \fImethod\fR must
be given as one of the passive OpenFlow connection methods listed
-under the \fB--listen\fR option above. This option may be specified
+under the \fB\-\-listen\fR option above. This option may be specified
multiple times to listen to multiple connection methods.
.IP
If \fBovs\-ofctl monitor\fR is used to connect to \fImethod\fR specified on
-\fB--snoop\fR, it will display all the OpenFlow messages traveling
+\fB\-\-snoop\fR, it will display all the OpenFlow messages traveling
between the switch and its controller on the primary OpenFlow
connection. This can be useful for debugging switch and controller
problems.
.
.TP
-\fB--in-band\fR, \fB--out-of-band\fR
+\fB\-\-in\-band\fR, \fB\-\-out\-of\-band\fR
Configures \fBovs\-openflowd\fR to operate in in-band or out-of-band control
mode (see \fBContacting the Controller\fR above). When neither option
is given, the default is in-band control.
.
.TP
-\fB--netflow=\fIip\fB:\fIport\fR
+\fB\-\-netflow=\fIip\fB:\fIport\fR
Configures the given UDP \fIport\fR on the specified IP \fIip\fR as
a recipient of NetFlow messages for expired flows. The \fIip\fR must
be specified numerically, not as a DNS name.
@@ -367,25 +367,25 @@ OpenFlow controller for flow-setup processing. This feature prevents
a single OpenFlow switch from overwhelming a controller.
.
.TP
-\fB--rate-limit\fR[\fB=\fIrate\fR]
+\fB\-\-rate\-limit\fR[\fB=\fIrate\fR]
.
Limits the maximum rate at which packets will be forwarded to the
OpenFlow controller to \fIrate\fR packets per second. If \fIrate\fR
is not specified then the default of 1,000 packets per second is used.
.IP
-If \fB--rate-limit\fR is not used, then the switch does not limit the
+If \fB\-\-rate\-limit\fR is not used, then the switch does not limit the
rate at which packets are forwarded to the controller.
.
.TP
-\fB--burst-limit=\fIburst\fR
+\fB\-\-burst\-limit=\fIburst\fR
.
Sets the maximum number of unused packet credits that the switch will
allow to accumulate during time in which no packets are being
forwarded to the OpenFlow controller to \fIburst\fR (measured in
packets). The default \fIburst\fR is one-quarter of the \fIrate\fR
-specified on \fB--rate-limit\fR.
+specified on \fB\-\-rate\-limit\fR.
.
-This option takes effect only when \fB--rate-limit\fR is also specified.
+This option takes effect only when \fB\-\-rate\-limit\fR is also specified.
.
.SS "Datapath Options"
.
diff --git a/utilities/ovs-pki.8.in b/utilities/ovs-pki.8.in
index 0f1c454..599bb08 100644
--- a/utilities/ovs-pki.8.in
+++ b/utilities/ovs-pki.8.in
@@ -20,7 +20,7 @@ Stand\-alone commands with their arguments:
.br
\fBovs\-pki\fR \fBfingerprint\fR \fIFILE\fR
.br
-\fBovs\-pki\fR \fBself-sign\fR \fINAME\fR
+\fBovs\-pki\fR \fBself\-sign\fR \fINAME\fR
.sp
The following additional commands manage an online PKI:
.br
@@ -182,9 +182,9 @@ of the certificate; otherwise, it is the SHA\-1 digest of the entire
file.
.TP
-\fBself-sign\fR \fINAME\fR
+\fBself\-sign\fR \fINAME\fR
Signs the certificate request named \fINAME\fB\-req.pem\fR using the
-private key \fINAME\fB-privkey.pem\fR, producing a self-signed
+private key \fINAME\fB\-privkey.pem\fR, producing a self-signed
certificate named \fINAME\fB\-cert.pem\fR. The input files should have
been produced with \fBovs\-pki req\fR.
diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in
index cba0e5a..50c9482 100644
--- a/utilities/ovs-vsctl.8.in
+++ b/utilities/ovs-vsctl.8.in
@@ -90,7 +90,7 @@ following forms:
Prevents \fBovs\-vsctl\fR from waiting for \fBovs\-vswitchd\fR to
reconfigure itself according to the the modified database. This
option should be used if \fBovs\-vswitchd\fR is not running;
-otherwise, \fBovs-vsctl\fR will not exit until \fBovs-vswitchd\fR
+otherwise, \fBovs\-vsctl\fR will not exit until \fBovs\-vswitchd\fR
starts.
.IP
This option has no effect if the commands specified do not change the
@@ -113,8 +113,8 @@ Prints a blank line for each command that has no output.
.IP "\fB\-\-dry\-run\fR"
Prevents \fBovs\-vsctl\fR from actually modifying the database.
.
-.IP "\fB-t \fIsecs\fR"
-.IQ "\fB--timeout=\fIsecs\fR"
+.IP "\fB\-t \fIsecs\fR"
+.IQ "\fB\-\-timeout=\fIsecs\fR"
Limits runtime to approximately \fIsecs\fR seconds. A value of
zero will cause \fBovs\-vsctl\fR to wait forever. If the timeout expires,
\fBovs\-vsctl\fR will exit with a \fBSIGALRM\fR signal. If this option is
@@ -144,7 +144,7 @@ Reset the configuration into a clean state. It deconfigures OpenFlow
controllers, OVSDB servers, and SSL, and deletes port mirroring,
NetFlow, and sFlow configuration. This command also removes all
\fBother\-config\fR keys from all database records, except that
-\fBother-config:hwaddr\fR is preserved if it is present in a Bridge
+\fBother\-config:hwaddr\fR is preserved if it is present in a Bridge
record. Other networking configuration is left as-is.
.
.SS "Bridge Commands"
@@ -365,7 +365,7 @@ Sets the configured failure mode.
When \fBovs\-vswitchd\fR is configured to connect over SSL for management or
controller connectivity, the following parameters are required:
.TP
-\fBprivate-key\fR
+\fBprivate\-key\fR
Specifies a PEM file containing the private key used as the virtual
switch's identity for SSL connections to the controller.
.TP
@@ -375,7 +375,7 @@ certificate authority (CA) used by the controller and manager, that
certifies the virtual switch's private key, identifying a trustworthy
switch.
.TP
-\fBca-cert\fR
+\fBca\-cert\fR
Specifies a PEM file containing the CA certificate used to verify that
the virtual switch is connected to a trustworthy controller.
.PP
@@ -414,7 +414,7 @@ This option is only useful if the controller sends its CA certificate
as part of the SSL certificate chain. The SSL protocol does not
require the controller to send the CA certificate, but
\fBcontroller\fR(8) can be configured to do so with the
-\fB--peer-ca-cert\fR option.
+\fB\-\-peer\-ca\-cert\fR option.
.
.SS "Database Commands"
.
@@ -465,7 +465,7 @@ An sFlow configuration attached to a bridge. Records may be
identified by bridge name.
.PP
Names of tables, records, and columns are not case-sensitive, and
-\fB--\fR and \fB_\fR are treated interchangeably. Unique
+\fB\-\-\fR and \fB_\fR are treated interchangeably. Unique
abbreviations are acceptable, e.g. \fBnet\fR or \fBn\fR is sufficient
to identify the \fBNetFlow\fR table.
.
@@ -564,7 +564,7 @@ Sets each \fIcolumn\fR in \fIrecord\fR in \fItable\fR to the empty set
or empty map, as appropriate. This command applies only to columns
that are allowed to be empty.
.
-.IP "[\fB--id=@\fIname\fR] \fBcreate\fR \fItable column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..."
+.IP "[\fB\-\-id=@\fIname\fR] \fBcreate\fR \fItable column\fR[\fB:\fIkey\fR]\fB=\fIvalue\fR..."
Creates a new record in \fItable\fR and sets the initial values of
each \fIcolumn\fR. Columns not explicitly set will receive their
default values. Outputs the UUID of the new row.
@@ -612,13 +612,13 @@ after waiting only at most 5 seconds.
.SH "EXAMPLES"
Create a new bridge named br0 and add port eth0 to it:
.IP
-.B "ovs-vsctl add\-br br0"
+.B "ovs\-vsctl add\-br br0"
.br
-.B "ovs-vsctl add\-port br0 eth0"
+.B "ovs\-vsctl add\-port br0 eth0"
.PP
Alternatively, perform both operations in a single atomic transaction:
.IP
-.B "ovs-vsctl add\-br br0 \-\- add\-port br0 eth0"
+.B "ovs\-vsctl add\-br br0 \-\- add\-port br0 eth0"
.PP
Delete bridge \fBbr0\fR, reporting an error if it does not exist:
.IP
@@ -633,7 +633,7 @@ Set the \fBqos\fR column of the \fBPort\fR record for \fBeth0\fR to
point to a new \fBQoS\fR record, which in turn points with its queue 0
to a new \fBQueue\fR record:
.IP
-.B "ovs-vsctl \-\- set port eth0 qos=@newqos \-\- \-\-id=@newqos create qos type=linux\-htb other\-config:max\-rate=1000000 queues:0=@newqueue \-\- \-\-id=@newqueue create queue other\-config:min\-rate=1000000 other\-config:max\-rate=1000000"
+.B "ovs\-vsctl \-\- set port eth0 qos=@newqos \-\- \-\-id=@newqos create qos type=linux\-htb other\-config:max\-rate=1000000 queues:0=@newqueue \-\- \-\-id=@newqueue create queue other\-config:min\-rate=1000000 other\-config:max\-rate=1000000"
.
.SH "EXIT STATUS"
.IP "0"
diff --git a/vswitchd/ovs-brcompatd.8.in b/vswitchd/ovs-brcompatd.8.in
index f5dd62a..33cee24 100644
--- a/vswitchd/ovs-brcompatd.8.in
+++ b/vswitchd/ovs-brcompatd.8.in
@@ -20,11 +20,11 @@ retrieved. It should take the form \fBunix:\fIfile\fR, to connect to
the Unix domain server socket named \fIfile\fR.
.PP
.SH OPTIONS
-.IP "\fB--appctl-command=\fIcommand\fR"
+.IP "\fB\-\-appctl\-command=\fIcommand\fR"
Sets the command that \fBovs\-brcompatd\fR runs to communicate with
\fBovs\-vswitchd\fR. The command is run in \fB/bin/sh\fR as a shell
command, so \fIcommand\fR may contain arbitrary shell metacharacters,
-etc. The \fB--help\fR option displays the default command.
+etc. The \fB\-\-help\fR option displays the default command.
.IP
\fIcommand\fR must contain exactly one instance of \fB%s\fR, which
\fBovs\-brcompatd\fR replaces by a command from the set understood by
@@ -40,7 +40,7 @@ can be listed by passing \fBhelp\fR to \fBovs\-appctl\fR with
standard error streams, because \fBovs\-brcompatd\fR expects to read
both of these streams separately.
.TP
-\fB--prune-timeout=\fIsecs\fR
+\fB\-\-prune\-timeout=\fIsecs\fR
.
Sets the maximum time between pruning port entries to \fIsecs\fR seconds.
Pruning ports is the process of removing port entries from \fIdatabase\fR
diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in
index 79f17d3..f2fc43c 100644
--- a/vswitchd/ovs-vswitchd.8.in
+++ b/vswitchd/ovs-vswitchd.8.in
@@ -20,7 +20,7 @@ on the local machine.
.PP
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
+socket on which \fBovsdb\-server\fR is listening. However, all of the
following forms are accepted:
.so ovsdb/remote-active.man
.so ovsdb/remote-passive.man
@@ -76,7 +76,7 @@ Open vSwitch distribution for instructions on how to build and load
the Open vSwitch kernel module.
.PP
.SH OPTIONS
-.IP "\fB--mlockall\fR"
+.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
@@ -87,7 +87,7 @@ 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"
+.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
@@ -125,9 +125,9 @@ their controller connections and reconnect.
.IP
This command might be useful for debugging OpenFlow controller issues.
.
-.IP "\fBbridge/dump-flows\fR \fIbridge\fR"
+.IP "\fBbridge/dump\-flows\fR \fIbridge\fR"
Lists all flows in \fIbridge\fR, including those normally hidden to
-commands such as \fBovs-ofctl dump-flows\fR. Flows set up by mechanisms
+commands such as \fBovs\-ofctl dump\-flows\fR. Flows set up by mechanisms
such as in-band control and fail-open are hidden from the controller
since it is not allowed to modify or override them.
.SS "BOND COMMANDS"
@@ -160,14 +160,14 @@ cause the MAC hash to be shifted to a new slave in the usual
manner.
.IP
A MAC hash cannot be migrated to a disabled slave.
-.IP "\fBbond/set-active-slave\fR \fIport\fR \fIslave\fR"
+.IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR"
Sets \fIslave\fR as the active slave on \fIport\fR. \fIslave\fR must
currently be enabled.
.IP
The setting is not permanent: a new active slave will be selected
if \fIslave\fR becomes disabled.
-.IP "\fBbond/enable-slave\fR \fIport\fR \fIslave\fR"
-.IQ "\fBbond/disable-slave\fR \fIport\fR \fIslave\fR"
+.IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR"
+.IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR"
Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
updelay (or downdelay).
.IP
--
1.7.1
More information about the dev
mailing list