X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-client.1.in;h=82a9919c08d9b6148694b3811ae10cacea7f72a7;hb=1e68c0730d0753e9a796a0d6d4b95933f7cdfbd2;hp=8bdaae81f674532536a1cb5600146ddec888238a;hpb=d0632593feacc7942fa1650baf07e1e0b8dd1676;p=openvswitch diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in index 8bdaae81..82a9919c 100644 --- a/ovsdb/ovsdb-client.1.in +++ b/ovsdb/ovsdb-client.1.in @@ -18,11 +18,18 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1) .br \fBovsdb\-client \fR[\fIoptions\fR] \fBlist-columns\fI server \fR[\fItable\fR] .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 . @@ -35,6 +42,14 @@ the following forms: 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. . .SS "Commands" The following commands are implemented: @@ -52,6 +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 "\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. @@ -79,6 +120,12 @@ characters. Specifying this option prevents line truncation. This option suppresses the heading row that otherwise appears in the first row of table output. . +.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"