From ae9a3235bfa607fdcccd5e12d2052252e67fb914 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Thu, 10 Feb 2011 09:34:42 -0800 Subject: [PATCH] ovs-vsctl: Improve documentation and --help output. --- utilities/ovs-vsctl.8.in | 8 ++++---- utilities/ovs-vsctl.c | 14 ++++++++++++-- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in index 0c6fc2f6..1702aacc 100644 --- a/utilities/ovs-vsctl.8.in +++ b/utilities/ovs-vsctl.8.in @@ -104,7 +104,7 @@ By default, \fBovs\-vsctl\fR logs its arguments and the details of any changes that it makes to the system log. This option disables this logging. .IP -This option is equivalent to \fB\-\-verbose=vvsctl:syslog:warn\fR. +This option is equivalent to \fB\-\-verbose=vsctl:syslog:warn\fR. . .IP "\fB\-\-oneline\fR" Modifies the output format so that the output for each command is printed @@ -396,17 +396,17 @@ use any of the following forms: When \fBovs\-vswitchd\fR is configured to connect over SSL for management or controller connectivity, the following parameters are required: .TP -\fBprivate\-key\fR +\fIprivate-key\fR Specifies a PEM file containing the private key used as the virtual switch's identity for SSL connections to the controller. .TP -\fBcertificate\fR +\fIcertificate\fR Specifies a PEM file containing a certificate, signed by the 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 +\fIca-cert\fR Specifies a PEM file containing the CA certificate used to verify that the virtual switch is connected to a trustworthy controller. .PP diff --git a/utilities/ovs-vsctl.c b/utilities/ovs-vsctl.c index 61ff5bbd..3a93ef38 100644 --- a/utilities/ovs-vsctl.c +++ b/utilities/ovs-vsctl.c @@ -36,6 +36,7 @@ #include "ovsdb-idl.h" #include "poll-loop.h" #include "process.h" +#include "stream.h" #include "stream-ssl.h" #include "svec.h" #include "vswitchd/vswitch-idl.h" @@ -475,6 +476,10 @@ usage(void) %s: ovs-vswitchd management utility\n\ usage: %s [OPTIONS] COMMAND [ARG...]\n\ \n\ +Open vSwitch commands:\n\ + init initialize database, if not yet initialized\n\ + emer-reset reset configuration to clean state\n\ +\n\ Bridge commands:\n\ add-br BRIDGE create a new bridge named BRIDGE\n\ add-br BRIDGE PARENT VLAN create new fake BRIDGE in PARENT on VLAN\n\ @@ -488,13 +493,12 @@ Bridge commands:\n\ br-get-external-id BRIDGE KEY print value of KEY on BRIDGE\n\ br-get-external-id BRIDGE list key-value pairs on BRIDGE\n\ \n\ -Port commands:\n\ +Port commands (a bond is considered to be a single port):\n\ list-ports BRIDGE print the names of all the ports on BRIDGE\n\ add-port BRIDGE PORT add network device PORT to BRIDGE\n\ add-bond BRIDGE PORT IFACE... add bonded port PORT in BRIDGE from IFACES\n\ del-port [BRIDGE] PORT delete PORT (which may be bonded) from BRIDGE\n\ port-to-br PORT print name of bridge that contains PORT\n\ -A bond is considered to be a single port.\n\ \n\ Interface commands (a bond consists of multiple interfaces):\n\ list-ifaces BRIDGE print the names of all interfaces on BRIDGE\n\ @@ -537,9 +541,15 @@ Potentially unsafe database commands require --force option.\n\ Options:\n\ --db=DATABASE connect to DATABASE\n\ (default: %s)\n\ + --no-wait do not wait for ovs-vswitchd to reconfigure\n\ + -t, --timeout=SECS wait at most SECS seconds for ovs-vswitchd\n\ + --dry-run do not commit changes to database\n\ --oneline print exactly one line of output per command\n", program_name, program_name, default_db()); vlog_usage(); + printf("\ + --no-syslog equivalent to --verbose=vsctl:syslog:warn\n"); + stream_usage("database", true, true, false); printf("\n\ Other options:\n\ -h, --help display this help message\n\ -- 2.30.2