summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am4
-rw-r--r--doc/glusterfs-volgen.882
2 files changed, 2 insertions, 84 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 0eb348c..f26fc75 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,13 +1,13 @@
EXTRA_DIST = glusterfs.vol.sample glusterfsd.vol.sample glusterfs.8 mount.glusterfs.8\
porting_guide.txt authentication.txt coding-standard.pdf get_put_api_using_xattr.txt \
translator-options.txt mac-related-xattrs.txt replicate.pdf glusterd.vol gluster.8 \
- glusterd.8 glusterfs-volgen.8
+ glusterd.8
SUBDIRS = examples hacker-guide
voldir = $(sysconfdir)/glusterfs
vol_DATA = glusterfs.vol.sample glusterfsd.vol.sample glusterd.vol
-man8_MANS = glusterfs.8 mount.glusterfs.8 gluster.8 glusterd.8 glusterfs-volgen.8
+man8_MANS = glusterfs.8 mount.glusterfs.8 gluster.8 glusterd.8
CLEANFILES =
diff --git a/doc/glusterfs-volgen.8 b/doc/glusterfs-volgen.8
deleted file mode 100644
index a478737..0000000
--- a/doc/glusterfs-volgen.8
+++ /dev/null
@@ -1,82 +0,0 @@
-.\" Copyright (c) 2009-2010 Gluster, Inc. <http://www.gluster.com>
-.\" This file is part of GlusterFS.
-.\"
-.\" GlusterFS is free software; you can redistribute it and/or modify
-.\" it under the terms of the GNU Affero General Public License as published
-.\" by the Free Software Foundation; either version 3 of the License,
-.\" or (at your option) any later version.
-.\"
-.\" GlusterFS is distributed in the hope that it will be useful, but
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-.\" Affero General Public License for more details.
-.\"
-.\" You should have received a copy of the GNU Affero General Public License
-.\" long with this program. If not, see
-.\" <http://www.gnu.org/licenses/>.
-.\"
-.\"
-.\"
-.TH GlusterFS 8 "Cluster Filesystem" "19 March 2010" "Gluster Inc."
-.SH NAME
-glusterfs-volgen \- Tool to generate GlusterFS volume files
-.SH SYNOPSIS
-.B glusterfs-volgen --name <volumename>
-.I [options] <server1:/export/directory> <server1:/export/directory> ...
-.PP
-.SH DESCRIPTION
-glusterfs-volgen tool is used to generate glusterfs volume files as per the
-options given.
-
-GlusterFS volume files are very important component of gluster filesystem,
-using which \fBglusterfs\fR(8) will behave as a client component or a server
-component. Each glusterfs modules (in technical terms, a translator) is defined
-in this volume files in certain order to achieve the required behavior from
-filesystem.
-
-glusterfs-volgen tool abstracts the complexities of volumefile logic into a
-simple command line tool, which based on user's requirement (by options
-provided) generates the corresponding error-free volume file.
-
-
-.SH OPTIONS
-.PP
-
-\fB\-n \-\-name\fR=VOLUME-NAME
-This is a mandatory argument required for glusterfs-volgen.
-.TP
-\fB\-r \-\-raid\fR=[0|1]
-Supported options are 0 (stripe), 1 (mirror). If this option is not used,
-distribute is used without replicate or stripe.
-.TP
-\fB\-t \-\-transport\fR=[tcp|ib-verbs|tcp,ib-verbs]
-Supported types are 'tcp' and 'ib-verbs'. This option can take both types
-together like 'tcp,ib-verbs'. [default is 'tcp']
-.TP
-\fB\-p \-\-port\fR=PORT
-The port number to use in volume files.
-[default is 24007 for tcp, (24007 + 1) for ib-verbs]
-.TP
-\fB\-a \-\-auth\fR=AUTH_PARAMS
-Authentication parameters (comma seperated) to use in server volume.
-[default is '*', ie allow everyone]
-.TP
-\fB\-c \-\-conf-dir\fR=CONF_DIR
-Directory where the output volume files are generated. [default is
-${prefix}/etc/glusterfs]
-
-.PP
-.SH FILES
-
-${CONF_DIR}/*.vol
-
-.SH SEE ALSO
-.nf
-\fB\fBmount.glusterfs\fR(8)
-\fR
-.fi
-.SH COPYRIGHT
-.nf
-Copyright(c) 2009-2010 Gluster, Inc. <http://www.gluster.com>
-\fR
-.fi