X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-client.1.in;h=5ec42a964aa6428b727546f751dc5d440d07596e;hb=5aa006354872e40c227b601f0e0deb4fd72eb9f6;hp=0337c3dc27f5ca9b015dc191c937453a3573ff70;hpb=6d65eee8b1f4d96b9c925d3b31758268345a4636;p=openvswitch diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in index 0337c3dc..5ec42a96 100644 --- a/ovsdb/ovsdb-client.1.in +++ b/ovsdb/ovsdb-client.1.in @@ -20,11 +20,16 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1) .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]...] +.br \fBovsdb\-client help\fR .IP "Output formatting options:" [\fB--format=\fIformat\fR] [\fB--wide\fR] [\fB--no-heading\fR] +.so lib/daemon-syn.man .so lib/vlog-syn.man .so lib/common-syn.man . @@ -62,10 +67,32 @@ 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 "\fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR" +. +.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: +.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. +.RE +.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. @@ -93,6 +120,21 @@ characters. Specifying this option prevents line truncation. 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 "Logging Options" .so lib/vlog.man .SS "Other Options"