summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChetan Risbud <crisbud@redhat.com>2013-11-15 18:48:45 +0530
committerLuis Pabon <lpabon@redhat.com>2013-11-25 18:41:23 -0800
commitb6a6621ded41fb56c1a2797d9590a79f14d4c1f4 (patch)
tree1945d1bb55d27cac3b31abb0b2fac8f2803bea40
parent3f18f021bd83bb63639c621e0650eace062f463f (diff)
Man(8) page for gluster-swift-gen-builder
Man page provides details on gluster-swift-gen-builder script and its usage. Man page will be placed in section 8. Bug: 1001033 https://bugzilla.redhat.com/show_bug.cgi?id=1001033 Change-Id: Ie172173d3873256facb55eb3be0accebe360025e Signed-off-by: Chetan Risbud <crisbud@redhat.com> Reviewed-on: http://review.gluster.org/6294 Reviewed-by: pushpesh sharma <psharma@redhat.com> Tested-by: pushpesh sharma <psharma@redhat.com> Reviewed-by: Luis Pabon <lpabon@redhat.com> Tested-by: Luis Pabon <lpabon@redhat.com>
-rw-r--r--doc/man/gluster-swift-gen-builders.869
-rw-r--r--glusterfs-openstack-swift.spec7
2 files changed, 76 insertions, 0 deletions
diff --git a/doc/man/gluster-swift-gen-builders.8 b/doc/man/gluster-swift-gen-builders.8
new file mode 100644
index 0000000..3fb3b81
--- /dev/null
+++ b/doc/man/gluster-swift-gen-builders.8
@@ -0,0 +1,69 @@
+.TH gluster-swift-gen-builders 8 "gluster-swift helper utility" "18 November 2013" "Red Hat Inc."
+.SH NAME
+\fBgluster-swift-gen-builders \fP- Registers GlusterFS volumes to be accessed by
+\fBOpenStack Swift.
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+\fBgluster-swift-gen-builders\fP [\fB-v\fP] [\fB-h\fP] volumes\.\.\.
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+Register GlusterFS volumes to be accessed over OpenStack Swift.
+.SH OPTIONS
+\fB-v\fP or \fB--verbose\fP
+.PP
+.nf
+.fam C
+ Verbose
+
+.fam T
+.fi
+\fB-h\fP or \fB--help\fP
+.PP
+.nf
+.fam C
+ Prints help screen
+
+.fam T
+.fi
+.SH EXAMPLES
+
+\fBgluster-swift-gen-builders\fP vol1 vol2
+.PP
+.nf
+.fam C
+ Creates new ring files with vol1 and vol2
+
+.fam T
+.fi
+\fBgluster-swift-gen-builders\fP vol2
+.PP
+.nf
+.fam C
+ Creates new ring files by removing vol1
+
+.fam T
+.fi
+\fBgluster-swift-gen-builders\fP \fB-v\fP vol1
+.PP
+.nf
+.fam C
+ Create new ring files with vol1, (Verbose).
+
+.fam T
+.fi
+\fBgluster-swift-gen-builders\fP \fB-h\fP
+.PP
+.nf
+.fam C
+ Displays help screen
+
+.fam T
+.fi
+.SH COPYRIGHT
+\fBCopyright\fP(c) 2013 RedHat, Inc. <http://www.redhat.com>
diff --git a/glusterfs-openstack-swift.spec b/glusterfs-openstack-swift.spec
index 0faba2b..951c22a 100644
--- a/glusterfs-openstack-swift.spec
+++ b/glusterfs-openstack-swift.spec
@@ -58,6 +58,12 @@ rm -rf %{buildroot}
mkdir -p %{buildroot}/%{_confdir}/
cp -r etc/* %{buildroot}/%{_confdir}/
+# Man Pages
+install -d -m 755 %{buildroot}%{_mandir}/man8
+for page in doc/man/*.8; do
+ install -p -m 0644 $page %{buildroot}%{_mandir}/man8
+done
+
# Remove tests
%{__rm} -rf %{buildroot}/%{python_sitelib}/test
@@ -78,6 +84,7 @@ cp -r etc/* %{buildroot}/%{_confdir}/
%{_bindir}/swauth-list
%{_bindir}/swauth-prep
%{_bindir}/swauth-set-account-service
+%{_mandir}/man8/*
%dir %{_confdir}
%config(noreplace) %{_confdir}/account-server.conf-gluster