X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-client.1.in;h=8bd1c12ee8d5e1039f28c11e4ddfa83b782072e6;hb=431585099e82a88a23d5dec28138b5a3a8bb11da;hp=c07a88c13462feded6e5626a96d0369a9f80cc73;hpb=1b0f0f17b3c0c6762d6289b1bf7e0e65292f6348;p=openvswitch

diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in
index c07a88c1..8bd1c12e 100644
--- a/ovsdb/ovsdb-client.1.in
+++ b/ovsdb/ovsdb-client.1.in
@@ -6,24 +6,38 @@
 ..
 .\" -*- nroff -*-
 .TH ovsdb\-client 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
+.\" This program's name:
 .ds PN ovsdb\-client
+.\" SSL peer program's name:
+.ds SN ovsdb\-server
 .
 .SH NAME
 ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
 .
 .SH SYNOPSIS
-\fBovsdb\-client \fR[\fIoptions\fR] \fBget-schema\fI server\fR
+\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-dbs\fI server\fR
 .br
-\fBovsdb\-client \fR[\fIoptions\fR] \fBlist-tables\fI server\fR
+\fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\fI server database\fR
 .br
-\fBovsdb\-client \fR[\fIoptions\fR] \fBlist-columns\fI server \fR[\fItable\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]
+.br
+\fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR
+.br
+\fBovsdb\-client \fR[\fIoptions\fR] \fBdump\fI server database\fR
+.br
+\fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI server database table\fR
+[\fIcolumn\fR[\fB,\fIcolumn\fR]...]...
 .br
 \fBovsdb\-client help\fR
 .IP "Output formatting options:"
-[\fB--format=\fIformat\fR]
-[\fB--wide\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
+.so lib/ssl-bootstrap-syn.man
 .so lib/common-syn.man
 .
 .SH DESCRIPTION
@@ -31,43 +45,76 @@ The \fBovsdb\-client\fR program is a command-line client for
 interacting with a running \fBovsdb\-server\fR process.  For each
 command, the \fIserver\fR to connect to must be specified in one of
 the following forms:
-.IP "\fBtcp:\fIip\fB:\fIport\fR"
-Connect to the given TCP \fIport\fR on \fIip\fR.
-.IP "\fBunix:\fIfile\fR"
-Connect to the Unix domain server socket named \fIfile\fR.
-.IP "\fBptcp:\fIport\fR[\fB:\fIip\fR]"
-Listen on the given TCP \fIport\fR for a connection.  By default,
-\fB\*(PN\fR listens for connections to any local IP address, but
-\fIip\fR may be specified to listen only for connections to the given
-\fIip\fR.
-.IP "\fBpunix:\fIfile\fR"
-Listen on the Unix domain server socket named \fIfile\fR for a
-connection.
+.RS
+.so ovsdb/remote-active.man
+.so ovsdb/remote-passive.man
+.RE
 .
 .SS "Commands"
 The following commands are implemented:
-.IP "\fBget-schema\fI server\fR"
-Connects to \fIserver\fR, retrieves the database schema, and prints it
-in JSON format.
-.
-.IP "\fBlist-tables\fI server\fR"
-Connects to \fIserver\fR, retrieves the database schema, and prints
-a table listing the names and comments (if any) on each table within
-the database.
-.
-.IP "\fBlist-columns\fI server \fR[\fItable\fR]"
-Connects to \fIserver\fR, retrieves the database schema, and prints
-a table listing the names, type, and comment (if any) on each column.  If
-\fItable\fR is specified, only columns in that table are listed;
-otherwise, the tables include columns in all tables.
+.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"
+Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
+prints it in JSON format.
+.
+.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]"
+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
+listed; otherwise, the tables include columns in all tables.
+.
+.IP "\fBtransact\fI server transaction\fR"
+Connects to \fIserver\fR, sends it the specified \fItransaction\fR,
+which must be a JSON array containing one or more valid OVSDB
+operations, and prints the received reply on stdout.
+.
+.IP "\fBdump\fI server database\fR"
+Connects to \fIserver\fR, retrieves all of the data in \fIdatabase\fR,
+and prints it on stdout as a series of tables.
+.
+.IP "\fBmonitor\fI server database table\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..."
+Connects to \fIserver\fR and monitors the contents of \fItable\fR in
+\fIdatabase\fR.  By default, the initial contents of \fItable\fR are
+printed, followed by each change as it occurs.  If at least one
+\fIcolumn\fR is specified, only those columns are monitored.  The
+following \fIcolumn\fR names have special meanings:
+.RS
+.IP "\fB!initial\fR"
+Do not print the initial contents of the specified columns.
+.IP "\fB!insert\fR"
+Do not print newly inserted rows.
+.IP "\fB!delete\fR"
+Do not print deleted rows.
+.IP "\fB!modify\fR"
+Do not print modifications to existing rows.
+.RE
+.IP
+Multiple [\fIcolumn\fR[\fB,\fIcolumn\fR]...] groups may be specified
+as separate arguments, e.g. to apply different reporting parameters to
+each group.  Whether multiple groups or only a single group is
+specified, any given column may only be mentioned once on the command
+line.
+.IP
+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
 .SS "Output Formatting Options"
 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"
-Sets the basic type of output formatting.  The following types of
+.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
 .IP "\fBtable\fR (default)"
@@ -78,17 +125,39 @@ HTML tables.
 Comma-separated values as defined in RFC 4180.
 .RE
 .
-.IP "\fB--wide\fR"
-In \fBtable\fR output (the default), when standard output is a
-terminal device, by default lines are truncated at a width of 79
-characters.  Specifying this option prevents line truncation.
+.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).
+.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"
+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
+per line, with indentation.
+.IP
+This option does not affect JSON in tables, which is always printed
+compactly.
+.
+.SS "Daemon Options"
+The daemon options apply only to the \fBmonitor\fR command.  With any
+other command, they have no effect.
+.so lib/daemon.man
 .SS "Logging Options"
 .so lib/vlog.man
+.SS "Public Key Infrastructure Options"
+.so lib/ssl.man
+.so lib/ssl-bootstrap.man
 .SS "Other Options"
 .so lib/common.man
 .SH "SEE ALSO"