datapath: Remove netdev_alloc_skb_ip_align() compat code.

[sliver-openvswitch.git] / ovsdb / ovsdb-client.1.in

diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in
index 716fcc2..c7a1fea 100644 (file)
--- a/ovsdb/ovsdb-client.1.in
+++ b/ovsdb/ovsdb-client.1.in
@@ -12,23 +12,25 @@
 ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
 .
 .SH SYNOPSIS
 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
 .br

-\fBovsdb\-client \fR[\fIoptions\fR] \fBlist-tables\fI server\fR
+\fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\fI server database\fR

 .br
 .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
 .br
 \fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR
 .br

-\fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI server table\fR
-[\fIcolumn\fR[\fB,\fIcolumn\fR]...]
-[\fIselect\fR[\fB,\fIselect\fR]...]
+\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:"
 .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/daemon-syn.man
 .so lib/vlog-syn.man
 .so lib/ssl-syn.man


@@ -47,44 +49,59 @@ the following forms:
 .
 .SS "Commands"
 The following commands are implemented:
 .
 .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\-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 "\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 "\fBget\-schema\fI server database\fR"
+Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
+prints it in JSON format.

 .
 .

-.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\-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 "\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 "\fBmonitor\fI server table\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...] [\fIselect\fR[\fB,\fIselect\fR]...]"
-Connects to \fIserver\fR and monitors the contents of \fItable\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.  If at least one \fIselect\fR is
-specified, they are interpreted as follows:
+.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
 .RS

-.IP "\fBinitial\fR"
-Print the initial contents of the specified columns.
-.IP "\fBinsert\fR"
-Print newly inserted rows.
-.IP "\fBdelete\fR"
-Print deleted rows.
-.IP "\fBmodify\fR"
-Print old and new values of modified rows.
+.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
 .RE
 .IP

-If \fB--detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
+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
 detaches after it has successfully received and printed the initial
 contents of \fItable\fR.
 .SH OPTIONS


@@ -92,9 +109,9 @@ contents of \fItable\fR.
 Much of the output from \fBovsdb\-client\fR is in the form of tables.
 The following options controlling output formatting:
 .
 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)"
 \fIformat\fR are available:
 .RS
 .IP "\fBtable\fR (default)"


@@ -105,16 +122,22 @@ HTML tables.
 Comma-separated values as defined in RFC 4180.
 .RE
 .
 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.
 .
 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
 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


@@ -129,6 +152,7 @@ other command, they have no effect.
 .so lib/daemon.man
 .SS "Logging Options"
 .so lib/vlog.man
 .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/ssl.man
 .so lib/ssl-bootstrap.man
 .SS "Other Options"