[Ocfs2-tools-devel] [PATCH 23/28] o2hbmonitor: Add manpage

[Sunil Mushran]

Signed-off-by: Sunil Mushran <sunil.mushran at oracle.com>
---
 configure.in                              |    1 +
 debian/ocfs2-tools.manpages               |    1 +
 o2monitor/.gitignore                      |    1 +
 o2monitor/Makefile                        |    4 ++-
 o2monitor/o2hbmonitor.8.in                |   48 +++++++++++++++++++++++++++++
 vendor/common/ocfs2-tools.spec-generic.in |    1 +
 6 files changed, 55 insertions(+), 1 deletions(-)
 create mode 100644 o2monitor/o2hbmonitor.8.in

diff --git a/configure.in b/configure.in
index 45ee98a..07a917d 100644
--- a/configure.in
+++ b/configure.in
@@ -442,6 +442,7 @@ tunefs.ocfs2/tunefs.ocfs2.8
 o2image/o2image.8
 o2info/o2info.1
 libo2cb/o2cb.7
+o2monitor/o2hbmonitor.8
 vendor/common/ocfs2-tools.spec-generic
 ])
 
diff --git a/debian/ocfs2-tools.manpages b/debian/ocfs2-tools.manpages
index 22c1560..5dbacd7 100644
--- a/debian/ocfs2-tools.manpages
+++ b/debian/ocfs2-tools.manpages
@@ -9,3 +9,4 @@ debian/tmp/usr/share/man/man8/ocfs2_hb_ctl.8
 debian/tmp/usr/share/man/man8/o2image.8
 debian/tmp/usr/share/man/man7/o2cb.7
 debian/tmp/usr/share/man/man1/o2info.1
+debian/tmp/usr/share/man/man8/o2hbmonitor.8
diff --git a/o2monitor/.gitignore b/o2monitor/.gitignore
index 66b9de5..01efe49 100644
--- a/o2monitor/.gitignore
+++ b/o2monitor/.gitignore
@@ -1,3 +1,4 @@
 *.sw?
 *.d
 o2hbmonitor
+o2hbmonitor.8
diff --git a/o2monitor/Makefile b/o2monitor/Makefile
index 8aba6e3..926c98b 100644
--- a/o2monitor/Makefile
+++ b/o2monitor/Makefile
@@ -17,7 +17,9 @@ CFILES = o2hbmonitor.c
 
 OBJS = $(subst .c,.o,$(CFILES))
 
-DIST_FILES = $(CFILES) $(HFILES)
+MANS = o2hbmonitor.8
+
+DIST_FILES = $(CFILES) $(HFILES) o2hbmonitor.8.in
 
 o2hbmonitor: $(OBJS)
 	$(LINK)
diff --git a/o2monitor/o2hbmonitor.8.in b/o2monitor/o2hbmonitor.8.in
new file mode 100644
index 0000000..cd895c1
--- /dev/null
+++ b/o2monitor/o2hbmonitor.8.in
@@ -0,0 +1,48 @@
+.TH "o2hbmonitor" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
+.SH "NAME"
+o2hbmonitor \- Monitors disk heartbeat in the O2CB cluster stack
+.SH "SYNOPSIS"
+\fBo2hbmonitor\fR [\fB\-w\fR percent] [\fB\-ivV\fR]
+.SH "DESCRIPTION"
+.PP 
+\fBo2hbmonitor\fR is a utility to monitor the disk heartbeat in the \fBo2cb\fR
+cluster stack. It tracks the time elapsed since the last heartbeat and logs messages
+once it exceeds the warn threshold.
+
+By default, it runs as a daemon and logs messages to the system logger. It can be
+started at any time and stopped using \fBkill(1)\fR. It does not affect the functioning
+of the heartbeat thread. It is typically automatically started during cluster online and
+stopped during cluster offline by the \fIo2cb\fR init script.
+
+This utility expects the \fBdebugfs\fR file system to be mounted at \fB/sys/kernel/debug\fR.
+
+.SH "OPTIONS"
+.TP
+\fB\-w\fR percent
+Warn threshold percent. It is the percentage of the idle threshold. It defaults to 50%.
+
+.TP
+\fB\-i\fR
+Interactive mode. It works as a daemon by default. This mode is typically only used
+for debugging.
+
+.TP
+\fB\-v\fR
+Verbose mode. It logs messages only to the system logger by default. In this mode it also
+logs the messages to stdout.
+
+.TP
+\fB\-V\fR
+Displays version.
+
+.SH "NOTES"
+This utility works with Linux kernel \fB2.6.37\fR and later.
+
+.SH "SEE ALSO"
+.BR o2cb(7)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2010, 2011 Oracle. All rights reserved.
diff --git a/vendor/common/ocfs2-tools.spec-generic.in b/vendor/common/ocfs2-tools.spec-generic.in
index b4ec40d..ee58e45 100644
--- a/vendor/common/ocfs2-tools.spec-generic.in
+++ b/vendor/common/ocfs2-tools.spec-generic.in
@@ -145,6 +145,7 @@ fi
 /usr/share/man/man8/o2image.8.gz
 /usr/share/man/man7/o2cb.7.gz
 /usr/share/man/man1/o2info.1.gz
+/usr/share/man/man8/o2hbmonitor.8.gz
 
 
 %if %{build_ocfs2console}
-- 
1.7.4.1