ovsdbmonitor: Add brief manpage.
authorBen Pfaff <blp@nicira.com>
Tue, 3 May 2011 16:53:41 +0000 (09:53 -0700)
committerBen Pfaff <blp@nicira.com>
Mon, 23 May 2011 20:41:19 +0000 (13:41 -0700)
ovsdb/ovsdbmonitor/automake.mk
ovsdb/ovsdbmonitor/ovsdbmonitor.1 [new file with mode: 0644]

index 11c25cb8dfb953dcbcc4da4573b8f8367df98a2d..49b24c1c5900b49d1a51f2ec4fe9efbee9c9137a 100644 (file)
@@ -25,7 +25,8 @@ EXTRA_DIST += \
        ovsdb/ovsdbmonitor/HostWindow.ui \
        ovsdb/ovsdbmonitor/LogWindow.ui \
        ovsdb/ovsdbmonitor/MainWindow.ui \
-       ovsdb/ovsdbmonitor/ovsdbmonitor.in
+       ovsdb/ovsdbmonitor/ovsdbmonitor.in \
+       ovsdb/ovsdbmonitor/ovsdbmonitor.1
 
 ovsdbmonitordir = ${pkgdatadir}/ovsdbmonitor
 if BUILD_OVSDBMONITOR
@@ -39,6 +40,7 @@ install-exec-hook:
 DISTCLEANFILES += \
        ovsdb/ovsdbmonitor/ovsdbmonitor \
        ovsdb/ovsdbmonitor/ovsdbmonitor.tmp
+man_MANS += ovsdb/ovsdbmonitor/ovsdbmonitor.1
 endif
 
 uninstall-local: ovsdbmonitor-uninstall-local
diff --git a/ovsdb/ovsdbmonitor/ovsdbmonitor.1 b/ovsdb/ovsdbmonitor/ovsdbmonitor.1
new file mode 100644 (file)
index 0000000..aa2b0aa
--- /dev/null
@@ -0,0 +1,20 @@
+.\" -*- nroff -*-
+.TH ovsdbmonitor 1 "May 2011" "Open vSwitch" "Open vSwitch Manual"
+.
+.SH NAME
+ovsdbmonitor \- GUI tool for monitoring Open vSwitch installations
+.
+.SH SYNOPSIS
+\fBovsdbmonitor\fR
+.
+.SH DESCRIPTION
+The \fBovsdbmonitor\fR program is a Qt-based GUI tool for monitoring
+and troubleshooting Open vSwitch.  It presents GUI tables that
+graphically represent an Open vSwitch kernel flow table (similar to
+\fBovs\-dpctl dump\-flows\fR) and Open vSwitch database contents
+(similar to \fBovs\-vsctl list \fItable\fR).
+.SH "SEE ALSO"
+.
+\fBovsdb\-server\fR(1),
+\fBovsdb\-client\fR(1),
+and the OVSDB specification.