summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/Makefile.am4
-rw-r--r--doc/gluster.8112
-rw-r--r--doc/glusterd.819
-rw-r--r--doc/glusterfs-volgen.82
-rw-r--r--doc/glusterfs.82
-rw-r--r--doc/mount.glusterfs.82
-rw-r--r--extras/FreeBSD/Makefile2
-rw-r--r--extras/Solaris/Prototype1
8 files changed, 108 insertions, 36 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index f26fc75..0eb348c 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
+ glusterd.8 glusterfs-volgen.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
+man8_MANS = glusterfs.8 mount.glusterfs.8 gluster.8 glusterd.8 glusterfs-volgen.8
CLEANFILES =
diff --git a/doc/gluster.8 b/doc/gluster.8
index 5354dcd..c7e476e 100644
--- a/doc/gluster.8
+++ b/doc/gluster.8
@@ -1,29 +1,29 @@
-.\" Copyright (c) 2008-2010 Gluster, Inc. <http://www.gluster.com>
+.\"
+.\" Copyright (c) 2006-2009 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 General Public License as published
+.\" GlusterFS is GF_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
-.\" General Public License for more details.
+.\" Affero General Public License for more details.
.\"
-.\" You should have received a copy of the GNU General Public License
-.\" long with this program. If not, see
+.\" You should have received a copy of the GNU Affero General Public License
+.\" along with this program. If not, see
.\" <http://www.gnu.org/licenses/>.
.\"
.\"
-.\"
.TH Gluster 8 "Gluster command line tool" "9 September 2010" "Gluster Inc."
.SH NAME
Gluster \- Gluster command line tool.
-.SH SYNOPSYS
+.SH SYNOPSIS
.B gluster
.PP
-To enter gluster cli
+To enter gluster prompt
.PP
(or)
.pp
@@ -34,11 +34,7 @@ To enter gluster cli
Gluster is a command line tool for dynamic volume management for glusterfs.
.SH DESCRIPTION
Gluster command line tool is used for dynamic volume management.
-The tool must be executed on any of the export servers.
-Only one instance of tool execution is permitted at a time.
-Parallel invocations will return an error to the second and further instances,
-with a description of where the first instance is running and what operation it is performing.
-
+The tool must be executed on any of the export servers. The cli gives an easy way to perform cloud operations such as volume create, volume expand, volume shrink, volume migrate, volume rebalance without the necessity of scheduling downtimes.
.SH COMMANDS
.PP
Mandatory or optional arguments to long options are also mandatory or optional
@@ -47,17 +43,91 @@ for any corresponding short options.
.PP
.TP
-\fB\ help \fR
-Help
+\fB\ volume info [all|<VOLNAME>] \fR
+list information of all volumes
+.TP
+\fB\ volume create <NEW-VOLNAME> [stripe <COUNT>] [replica <COUNT>] [transport <tcp|rdma>] <NEW-BRICK> ... \fR
+create a new volume of specified type with mentioned bricks
+.TP
+\fB\ volume delete <VOLNAME> \fR
+delete volume specified by \fB\<VOLNAME>\fR
+.TP
+\fB\ volume start <VOLNAME> \fR
+start volume specified by \fB\<VOLNAME>\fR
+.TP
+\fB\ volume stop <VOLNAME> [force] \fR
+stop volume specified by \fB\<VOLNAME>\fR
+.TP
+\fB\ volume rename <VOLNAME> <NEW-VOLNAME> \fR
+rename volume \fB\<VOLNAME>\fR to \fB\<NEW-VOLNAME>\fR
+.TP
+\fB\ volume add-brick <VOLNAME> [(replica <COUNT>)|(stripe <COUNT>)] <NEW-BRICK> ... \fR
+add brick to volume \fB\<VOLNAME>\fR
+.TP
+\fB\ volume remove-brick <VOLNAME> [(replica <COUNT>)|(stripe <COUNT>)] <BRICK> ... \fR
+remove brick from volume \fB\<VOLNAME>\fR
+.TP
+\fB\ volume rebalance <VOLNAME> start \fR
+start rebalance of volume \fB\<VOLNAME>\fR
+.TP
+\fB\ volume rebalance <VOLNAME> stop \fR
+stop rebalance of volume \fB\<VOLNAME>\fR
+.TP
+\fB\ volume rebalance <VOLNAME> status \fR
+rebalance status of volume \fB<VOLNAME>\fR
.TP
-\fB\ peer <options> \fR
-Command for peer management
+\fB\ volume replace-brick <VOLNAME> (<BRICK> <NEW-BRICK>) start|pause|abort|status \fR
+replace-brick operations
.TP
-\fB\ volume <options> \fR
-Command for volume management
+\fB\ volume set-transport <VOLNAME> <TRANSPORT-TYPE> [<TRANSPORT-TYPE>] ... \fR
+set transport type for volume \fB\<VOLNAME>\fR
+.TP
+\fB\ volume set-transport <VOLNAME> <TRANSPORT-TYPE> [<TRANSPORT-TYPE>] ... \fR
+set transport type for volume \fB\<VOLNAME>\fR
+\fR
+.TP
+\fB\ volume help \fB
+display help for the volume command
+.TP
+\fB\ volume log filename <VOLNAME> [BRICK] <PATH> \fB
+set the log file for corresponding volume/brick
+.TP
+\fB\ volume log locate <VOLNAME> [BRICK] \fB
+locate the log file for corresponding volume/brick
+.TP
+\fB\ volume log rotate <VOLNAME> [BRICK] \fB
+rotate the log file for corresponding volume/brick
+.TP
+\fB\ peer probe <HOSTNAME> \fR
+probe peer specified by \fB\<HOSTNAME>\fR
+.TP
+\fB\ peer detach <HOSTNAME> \fR
+detach peer specified by \fB\<HOSTNAME>\fR
+.TP
+\fB\ peer status \fR
+list status of peers
+.TP
+\fB\ peer help \fR
+Help command for peer
+.TP
+\fB\ help \fR
+display command options
.TP
\fB\ quit \fR
-Exit from cli.
+quit
.TP
+.PP
+.SH FILES
+/etc/glusterd/*
+
+.SH SEE ALSO
+.nf
+\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs-volgen\fR(8)
+\fBglusterfs\fR(8), \fBglusterd\fR(8)
+\fR
+.fi
+.SH COPYRIGHT
+.nf
+Copyright(c) 2006-2010 Gluster, Inc. <http://www.gluster.com>
.fi
diff --git a/doc/glusterd.8 b/doc/glusterd.8
index 6da3317..5a78c89 100644
--- a/doc/glusterd.8
+++ b/doc/glusterd.8
@@ -1,26 +1,27 @@
-.\" Copyright (c) 2008-2010 Gluster, Inc. <http://www.gluster.com>
+.\"
+.\" Copyright (c) 2006-2009 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 General Public License as published
+.\" GlusterFS is GF_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
-.\" General Public License for more details.
+.\" Affero General Public License for more details.
.\"
-.\" You should have received a copy of the GNU General Public License
-.\" long with this program. If not, see
+.\" You should have received a copy of the GNU Affero General Public License
+.\" along with this program. If not, see
.\" <http://www.gnu.org/licenses/>.
.\"
.\"
-.\"
+
.TH Glusterd 8 "Gluster dynamic volume management Daemon" "9 September 2010" "Gluster Inc."
.SH NAME
Glusterd \- Gluster dynamic volume management Daemon.
-.SH SYNOPSYS
+.SH SYNOPSIS
.B glusterd
.PP
(or)
@@ -57,7 +58,7 @@ Run in foreground
.TP
.SS Miscellaneous Options:
-
+.TP
\fB\-?, \fB\-\-help\fR
Give this help list
.TP
diff --git a/doc/glusterfs-volgen.8 b/doc/glusterfs-volgen.8
index 18edb23..c1881a2 100644
--- a/doc/glusterfs-volgen.8
+++ b/doc/glusterfs-volgen.8
@@ -20,7 +20,7 @@
.TH GlusterFS 8 "Cluster Filesystem" "19 March 2010" "Gluster Inc."
.SH NAME
glusterfs-volgen \- Tool to generate GlusterFS volume files
-.SH SYNOPSYS
+.SH SYNOPSIS
.B glusterfs-volgen --name <volumename>
.I [options] <server1:/export/directory> <server1:/export/directory> ...
.PP
diff --git a/doc/glusterfs.8 b/doc/glusterfs.8
index ef1871a..9377754 100644
--- a/doc/glusterfs.8
+++ b/doc/glusterfs.8
@@ -20,7 +20,7 @@
.TH GlusterFS 8 "Cluster Filesystem" "19 March 2010" "Gluster Inc."
.SH NAME
GlusterFS \- Clustered Filesystem.
-.SH SYNOPSYS
+.SH SYNOPSIS
.B glusterfs
.I [options] [mountpoint]
.PP
diff --git a/doc/mount.glusterfs.8 b/doc/mount.glusterfs.8
index 20a4c60..49deda8 100644
--- a/doc/mount.glusterfs.8
+++ b/doc/mount.glusterfs.8
@@ -20,7 +20,7 @@
.TH GlusterFS 8 "Cluster Filesystem" "18 March 2010" "Gluster Inc."
.SH NAME
mount.glusterfs - script to mount native GlusterFS volume
-.SH SYNOPSYS
+.SH SYNOPSIS
.B mount -t glusterfs
.I [-o <options>] <volumeserver>:<volumeid/volumeport> <mountpoint>
.TP
diff --git a/extras/FreeBSD/Makefile b/extras/FreeBSD/Makefile
index a430948..26fe85c 100644
--- a/extras/FreeBSD/Makefile
+++ b/extras/FreeBSD/Makefile
@@ -20,7 +20,7 @@ BUILD_DEPENDS= fusefs-libs>2.6.3:${PORTSDIR}/sysutils/fusefs-libs
LIB_DEPENDS= fuse.2:${PORTSDIR}/sysutils/fusefs-libs
RUN_DEPENDS= ${LOCALBASE}/modules/fuse.ko:${PORTSDIR}/sysutils/fusefs-kmod
-MAN8= glusterfs.8 gluster.8 glusterd.8
+MAN8= glusterfs.8 gluster.8 glusterd.8 glusterfs-volgen.8
GNU_CONFIGURE= yes
USE_LDCONFIG= yes
USE_AUTOTOOLS= libtool:15
diff --git a/extras/Solaris/Prototype b/extras/Solaris/Prototype
index 1cf3c2e..cb2d99d 100644
--- a/extras/Solaris/Prototype
+++ b/extras/Solaris/Prototype
@@ -11,6 +11,7 @@ d none /usr/sfw/share/man/man8 0755 root bin
f none /usr/sfw/share/man/man8/glusterfs.8 0644 root root
f none /usr/sfw/share/man/man8/gluster.8 0644 root root
f none /usr/sfw/share/man/man8/glusterd.8 0644 root root
+f none /usr/sfw/share/man/man8/glusterfs-volgen.8 0644 root root
d none /usr/sfw/share/doc 0755 root bin
d none /usr/sfw/share/doc/glusterfs 0755 root root
d none /usr/sfw/share/doc/glusterfs/examples 0755 root root