ovsdb-client: Fix bugs in man page
[openvswitch] / ovsdb / ovsdb-client.1.in
1 .\" -*- nroff -*-
2 .de IQ
3 .  br
4 .  ns
5 .  IP "\\$1"
6 ..
7 .\" -*- nroff -*-
8 .TH ovsdb\-client 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
9 .\" This program's name:
10 .ds PN ovsdb\-client
11 .\" SSL peer program's name:
12 .ds SN ovsdb\-server
13 .
14 .SH NAME
15 ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
16 .
17 .SH SYNOPSIS
18 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-dbs \fR[\fIserver\fR]
19 .br
20 \fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema \fR[\fIserver\fR] \fR[\fIdatabase\fR]
21 .br
22 \fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\-version\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]
23 .br
24 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-tables\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]
25 .br
26 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-columns\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] [\fItable\fR]
27 .br
28 \fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI \fR[\fIserver\fR] \fItransaction\fR
29 .br
30 \fBovsdb\-client \fR[\fIoptions\fR] \fBdump\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]\fR
31 .br
32 \fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR
33 [\fIcolumn\fR[\fB,\fIcolumn\fR]...]...
34 .br
35 \fBovsdb\-client help\fR
36 .IP "Output formatting options:"
37 [\fB\-\-format=\fIformat\fR]
38 [\fB\-\-data=\fIformat\fR]
39 [\fB\-\-no-heading\fR]
40 [\fB\-\-pretty\fR]
41 [\fB\-\-bare\fR]
42 [\fB\-\-no\-heading\fR]
43 [\fB\-\-timestamp\fR]
44 .so lib/daemon-syn.man
45 .so lib/vlog-syn.man
46 .so lib/ssl-syn.man
47 .so lib/ssl-bootstrap-syn.man
48 .so lib/common-syn.man
49 .
50 .SH DESCRIPTION
51 The \fBovsdb\-client\fR program is a command-line client for
52 interacting with a running \fBovsdb\-server\fR process.
53 Each command connects to an OVSDB server, which is
54 \fBunix:@RUNDIR@/db.sock\fR by default, or may be specified as
55 \fIserver\fR in one of the following forms:
56 .RS
57 .so ovsdb/remote-active.man
58 .so ovsdb/remote-passive.man
59 .RE
60 .PP
61 The default \fIdatabase\fR is \fBOpen_vSwitch\fR.
62 .
63 .SS "Commands"
64 The following commands are implemented:
65 .IP "\fBlist\-dbs \fR[\fIserver\fR]"
66 Connects to \fIserver\fR, retrieves the list of known databases, and
67 prints them one per line.  These database names are the ones that may
68 be used for \fIdatabase\fR in the following commands.
69 .
70 .IP "\fBget\-schema \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
71 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
72 prints it in JSON format.
73 .
74 .IP "\fBget\-schema\-version\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
75 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
76 prints its version number on stdout.  A schema version number has the form
77 \fIx\fB.\fIy\fB.\fIz\fR.  See \fBovs\-vswitchd.conf.db\fR(5) for
78 details.
79 .IP
80 Schema version numbers and Open vSwitch version numbers are
81 independent.
82 .IP
83 If \fIdatabase\fR was created before schema versioning was introduced,
84 then it will not have a version number and this command will print a
85 blank line.
86 .
87 .IP "\fBlist\-tables\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
88 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
89 prints a table listing the name of each table
90 within the database.
91 .
92 .IP "\fBlist\-columns\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR"
93 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
94 prints a table listing the name and type of each
95 column.  If \fItable\fR is specified, only columns in that table are
96 listed; otherwise, the tables include columns in all tables.
97 .
98 .IP "\fBtransact\fI \fR[\fIserver\fR] \fItransaction\fR"
99 Connects to \fIserver\fR, sends it the specified \fItransaction\fR,
100 which must be a JSON array containing one or more valid OVSDB
101 operations, and prints the received reply on stdout.
102 .
103 .IP "\fBdump\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]\fR"
104 Connects to \fIserver\fR, retrieves all of the data in \fIdatabase\fR,
105 and prints it on stdout as a series of tables.
106 .
107 .IP "\fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..."
108 Connects to \fIserver\fR and monitors the contents of \fItable\fR in
109 \fIdatabase\fR.  By default, the initial contents of \fItable\fR are
110 printed, followed by each change as it occurs.  If at least one
111 \fIcolumn\fR is specified, only those columns are monitored.  The
112 following \fIcolumn\fR names have special meanings:
113 .RS
114 .IP "\fB!initial\fR"
115 Do not print the initial contents of the specified columns.
116 .IP "\fB!insert\fR"
117 Do not print newly inserted rows.
118 .IP "\fB!delete\fR"
119 Do not print deleted rows.
120 .IP "\fB!modify\fR"
121 Do not print modifications to existing rows.
122 .RE
123 .IP
124 Multiple [\fIcolumn\fR[\fB,\fIcolumn\fR]...] groups may be specified
125 as separate arguments, e.g. to apply different reporting parameters to
126 each group.  Whether multiple groups or only a single group is
127 specified, any given column may only be mentioned once on the command
128 line.
129 .IP
130 If \fB\-\-detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
131 detaches after it has successfully received and printed the initial
132 contents of \fItable\fR.
133 .SH OPTIONS
134 .SS "Output Formatting Options"
135 Much of the output from \fBovsdb\-client\fR is in the form of tables.
136 The following options controlling output formatting:
137 .
138 .ds TD (default)
139 .so lib/table.man
140 .
141 .IP "\fB\-\-timestamp\fR"
142 For the \fBmonitor\fR command, adds a timestamp to each table
143 update.  Most output formats add the timestamp on a line of its own
144 just above the table.  The JSON output format puts the timestamp in a
145 member of the top-level JSON object named \fBtime\fR.
146 .
147 .SS "Daemon Options"
148 The daemon options apply only to the \fBmonitor\fR command.  With any
149 other command, they have no effect.
150 .ds DD
151 .so lib/daemon.man
152 .SS "Logging Options"
153 .so lib/vlog.man
154 .SS "Public Key Infrastructure Options"
155 .so lib/ssl.man
156 .so lib/ssl-bootstrap.man
157 .SS "Other Options"
158 .so lib/common.man
159 .SH "SEE ALSO"
160 .
161 \fBovsdb\-server\fR(1),
162 \fBovsdb\-client\fR(1),
163 and the OVSDB specification.