[Sheepdog] [PATCH] Add sheep.8 man page and man page infrastructure to build system/rpm gen

Steven Dake sdake at redhat.com
Wed Aug 25 09:17:16 CEST 2010

This patch adds a sheep.8 man page based upon the README instructions and
reading of the sheep source code for command line options.  While this man
page isn't perfect, certainly a good start and better then nothing.

Signed-off-by: Steven Dake <sdake at redhat.com>
 Makefile.am      |    2 +-
 configure.ac     |    3 ++-
 man/Makefile.am  |    3 +++
 man/sheep.8      |   54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 sheepdog.spec.in |    1 +
 5 files changed, 61 insertions(+), 2 deletions(-)
 create mode 100644 man/Makefile.am
 create mode 100644 man/sheep.8

diff --git a/Makefile.am b/Makefile.am
index 7bff145..ddfbfe0 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,7 +17,7 @@ sheepdogsysconfdir	= ${SHEEPDOGCONFDIR}
 sheepdogsysconf_DATA	= 
-SUBDIRS			= lib collie sheep include script
+SUBDIRS			= lib collie sheep include script man
 	$(INSTALL) -d $(DESTDIR)/${localstatedir}/lib/sheepdog
diff --git a/configure.ac b/configure.ac
index b09b9e3..7348507 100644
--- a/configure.ac
+++ b/configure.ac
@@ -114,7 +114,8 @@ AC_CONFIG_FILES([Makefile
-		lib/Makefile])
+		lib/Makefile
+		man/Makefile])
 ### Local business
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..6d43b79
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,3 @@
+dist_man_MANS = sheep.8
diff --git a/man/sheep.8 b/man/sheep.8
new file mode 100644
index 0000000..016f00a
--- /dev/null
+++ b/man/sheep.8
@@ -0,0 +1,54 @@
+.TH SHEEPDOG 2010-08-24
+sheep \- Distributed Block Storage System for KVM
+.B "sheep [options] [PATH]"
+.B sheep
+Sheepdog is a distributed storage system for KVM/QEMU. It provides
+highly available block level storage volumes to virtual machines.
+Sheepdog supports advanced volume management features such as snapshot,
+cloning, and thin provisioning. The architecture of Sheepdog is fully
+symmetric; there is no central node such as a meta-data server.
+The server daemon is called sheep(8).  A command line utility is available
+via collie(8).  KVM/QEMU virtual machines use the sheep daemon via a block
+driver available in qemu(1).
+.BI \-p "\fR, \fP" \--port " port"
+This option specifies the IP port over which \fBsheep\fP looks for other
+sheepdog cluster nodes.
+.BI \-f "\fR, \fP" \--foreground
+This option forces the sheepdog daemon to run in the foreground.
+.BI \-l "\fR, \fP" \--loglevel " loglevel"
+This option specifies the message level printed.
+.BI \-d "\fR, \fP" \--debug
+This option displays debug messages.
+.BI \-h "\fR, \fP" \--help
+Display help and exit.
+Proper LSB systems will store sheepdog files in /var/lib/sheepdog.  The init
+script uses this directory by default.  The directory must be on a filesystem
+with xattr support.  In the case of ext3, user_xattr should be added to the
+mount options.
+mount \-o remount,user_xattr /var/lib/shepdog
+\fBsheepdog\fP requires QEMU 0.13.z or later and Corosync 1.y.z.
+.B /var/lib/sheepdog - Directory containing block storage information
+.BR collie(8),qemu(1),corosync_overview(8)
+This software is developed by the sheepdog community which may be reached
+via mailing list at <sheepdog at lists.wpkg.org>.
diff --git a/sheepdog.spec.in b/sheepdog.spec.in
index ea9eb5e..937ea04 100644
--- a/sheepdog.spec.in
+++ b/sheepdog.spec.in
@@ -47,6 +47,7 @@ This package contains the Sheepdog server, and command line tool.
 %dir %{_localstatedir}/lib/sheepdog
 * @date@ Autotools generated version <nobody at nowhere.org> - @version at -1.@alphatag@

More information about the sheepdog mailing list