summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChetan Risbud <crisbud@redhat.com>2013-11-15 18:48:45 +0530
committerLuis Pabon <lpabon@redhat.com>2013-11-26 05:39:45 -0800
commitae818dd45463c09ca97159bd94a67e1d474710ab (patch)
tree3f1b2c4c11d7bb8388b18b90c10a6677c68149e1 /doc
parent5bd7bfacb21d406e7bdb5febe861616cd1069c28 (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> Reviewed-on: http://review.gluster.org/6352
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gluster-swift-gen-builders.869
1 files changed, 69 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>