From 51f43ff3f74dbc5896fa9ab74af109270c73faaa Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Tue, 3 May 2011 09:53:41 -0700 Subject: [PATCH] ovsdbmonitor: Add brief manpage. --- ovsdb/ovsdbmonitor/automake.mk | 4 +++- ovsdb/ovsdbmonitor/ovsdbmonitor.1 | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 ovsdb/ovsdbmonitor/ovsdbmonitor.1 diff --git a/ovsdb/ovsdbmonitor/automake.mk b/ovsdb/ovsdbmonitor/automake.mk index 11c25cb8d..49b24c1c5 100644 --- a/ovsdb/ovsdbmonitor/automake.mk +++ b/ovsdb/ovsdbmonitor/automake.mk @@ -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 index 000000000..aa2b0aac4 --- /dev/null +++ b/ovsdb/ovsdbmonitor/ovsdbmonitor.1 @@ -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. -- 2.43.0