[Ocfs2-tools-devel] [PATCH 7/8] O2info: Add manpage for o2info.

[Tristan Ye]

Signed-off-by: Tristan Ye <tristan.ye at oracle.com>
---
 configure.in       |    1 +
 o2info/Makefile    |    4 ++-
 o2info/o2info.1.in |   55 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 59 insertions(+), 1 deletions(-)
 create mode 100644 o2info/o2info.1.in

diff --git a/configure.in b/configure.in
index 458b55a..30ea831 100644
--- a/configure.in
+++ b/configure.in
@@ -433,6 +433,7 @@ ocfs2_hb_ctl/ocfs2_hb_ctl.8
 ocfs2console/ocfs2console.8
 tunefs.ocfs2/tunefs.ocfs2.8
 o2image/o2image.8
+o2info/o2info.1
 libo2cb/o2cb.7
 vendor/common/ocfs2-tools.spec-generic
 ])
diff --git a/o2info/Makefile b/o2info/Makefile
index 635da15..fe53466 100644
--- a/o2info/Makefile
+++ b/o2info/Makefile
@@ -18,6 +18,8 @@ BIN_PROGRAMS = o2info
 INCLUDES = -I$(TOPDIR)/include -I.
 DEFINES = -DVERSION=\"$(VERSION)\"
 
+MANS = o2info.1
+
 HFILES = o2info.h		\
 	 utils.h
 
@@ -28,7 +30,7 @@ CFILES =			\
 
 OBJS = $(subst .c,.o,$(CFILES))
 
-DIST_FILES = $(CFILES) $(HFILES)
+DIST_FILES = $(CFILES) $(HFILES) o2info.1.in
 
 o2info: $(OBJS) $(LIBOCFS2_DEPS)
 	$(LINK) $(LIBOCFS2_LIBS) $(LIBTOOLS_INTERNAL_LIBS) $(COM_ERR_LIBS)
diff --git a/o2info/o2info.1.in b/o2info/o2info.1.in
new file mode 100644
index 0000000..f9a02a2
--- /dev/null
+++ b/o2info/o2info.1.in
@@ -0,0 +1,55 @@
+.TH "o2info" "1" "February 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.SH "NAME"
+o2info \- Dump \fIOCFS2\fR file system information on disk.
+.SH "SYNOPSIS"
+\fBo2info\fR [\fB\-F|\-\-no\-coherency\fR] [\fB\-\-fs\-features\fR] [\fB\-\-volinfo\fR] <\fBdevice or file\fR>
+
+.SH "DESCRIPTION"
+.PP
+\fBo2info\fR is designed to be an information tool, to display \fIOCFS2\fR file system information on disk. Its main goal on one hand, is to provide a tool to display fs info in a comprehensive way and providing the information which may be missing in \fBdebugfs.ocfs\fR and \fBtunefs.ocfs2\fR, on the other hand, it also aims to become a info tool(\fBnot\fR an administration one), which therefore allows all users who may have no read privilege on the underlying device to use the utility. In practice, \fB'o2info /path/to/file/on/ocfs2/vol'\fR use a new \fBOCFS2_IOC_INFO\fR ioctl to get info from fs for a mounted case. For a privileged user(e.g, root), the same info however, can also be accessed by \fB'o2info /dev/sdxN'\fR to direcly manipulate the raw device.
+
+.SH "OPTIONS"
+.TP
+\fB\-\-fs\-features\fR
+List all compat, incompat and ro-compat fs features on \fIOCFS2\fR filesystem.
+
+.TP
+\fB\-\-volinfo\fR
+Dump basic volume information, such as blocksize, clustersize, volume label and UUID etc.
+
+.TP
+\fB\-F, \-\-no\-coherency\fR
+Disable cluster (in)coherency for mounted case, default is cluster coherency, means it will attempt to acquire a cluster lock when inquirying information from a cluster filesystem, which may degrade the performance.
+
+.TP
+\fB\-V, \-\-version\fR
+Show version and exit.
+
+.TP
+\fB\-h, \-\-help\fR
+Display help and exit.
+
+.SH "EXAMPLES"
+[oracle at node1 ~]# o2info --volinfo /storage/testfile	# For none-privileged users.
+.br
+[root at node1 ~]# o2info --volinfo /dev/sda1
+.br
+  Block Size: 4096
+.br
+Cluster Size: 32768
+.br
+   Max Slots: 4
+.br
+Volume Label: o2info_test
+.br
+ Volume UUID: F7FB1B64E9A04779AE967BAC56016767
+
+.SH "SEE ALSO"
+.BR debugfs.ocfs2(8)
+.BR tunefs.ocfs2(8)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2010 Oracle. All rights reserved.
-- 
1.5.5