summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAmar Tumballi <amar@gluster.com>2010-03-23 08:25:57 +0000
committerAnand V. Avati <avati@dev.gluster.com>2010-03-24 00:22:38 -0700
commitfaad9087d032044765636e1cb55a6fb3659e374f (patch)
tree8c57ce2165fce11d30d79040dbb17fc4c9685877 /doc
parent456701edd15dc2a953cbfc15f0dd657b876844c3 (diff)
man pages updated
man 8 glusterfs man 8 mount.glusterfs man 8 glusterfs-volgen Signed-off-by: Amar Tumballi <amar@gluster.com> Signed-off-by: Anand V. Avati <avati@dev.gluster.com> BUG: 734 (keep only the working/usable code in build tree to focus more on development) URL: http://bugs.gluster.com/cgi-bin/bugzilla3/show_bug.cgi?id=734
Diffstat (limited to 'doc')
-rw-r--r--doc/glusterfs-volgen.882
-rw-r--r--doc/glusterfs.855
-rw-r--r--doc/mount.glusterfs.876
3 files changed, 149 insertions, 64 deletions
diff --git a/doc/glusterfs-volgen.8 b/doc/glusterfs-volgen.8
new file mode 100644
index 0000000..18edb23
--- /dev/null
+++ b/doc/glusterfs-volgen.8
@@ -0,0 +1,82 @@
+.\" 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 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.
+.\"
+.\" You should have received a copy of the GNU 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 SYNOPSYS
+.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 6996 for tcp, 6997 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
diff --git a/doc/glusterfs.8 b/doc/glusterfs.8
index ef8fce9..ef1871a 100644
--- a/doc/glusterfs.8
+++ b/doc/glusterfs.8
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2008-2009 Gluster, Inc. <http://www.gluster.com>
+.\" Copyright (c) 2008-2010 Gluster, Inc. <http://www.gluster.com>
.\" This file is part of GlusterFS.
.\"
.\" GlusterFS is free software; you can redistribute it and/or modify
@@ -15,25 +15,33 @@
.\" long with this program. If not, see
.\" <http://www.gnu.org/licenses/>.
.\"
-.\"
-.\"
-.TH GlusterFS 8 "Cluster Filesystem" "07 December 2008" "Gluster Inc."
+.\"
+.\"
+.TH GlusterFS 8 "Cluster Filesystem" "19 March 2010" "Gluster Inc."
.SH NAME
GlusterFS \- Clustered Filesystem.
.SH SYNOPSYS
-.B glusterfs
+.B glusterfs
.I [options] [mountpoint]
.PP
.SH DESCRIPTION
-GlusterFS is a clustered file-system capable of scaling to several peta-bytes. It aggregates various storage bricks over Infiniband RDMA or TCP/IP interconnect into one large parallel network file system. Storage bricks can be made of any commodity hardware such as x86-64 server with SATA-II RAID and Infiniband HBA.
-GlusterFS is fully POSIX compliant FileSystem. On client side, it has dependency on FUSE package, on server side, it works seemlessly on different OSes. (Currently supported on GNU/Linux, Mac OSX, FreeBSD, OpenSolaris).
+GlusterFS is a clustered file-system capable of scaling to several peta-bytes.
+It aggregates various storage bricks over Infiniband RDMA or TCP/IP
+interconnect into one large parallel network file system. Storage bricks can
+be made of any commodity hardware such as x86-64 server with SATA-II RAID and
+Infiniband HBA.
+
+GlusterFS is fully POSIX compliant FileSystem. On client side, it has dependency
+on FUSE package, on server side, it works seemlessly on different OSes.
+(Currently supported on GNU/Linux, Solaris).
+
.SH OPTIONS
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.
.SS "Basic options"
.PP
-.TP
+.TP
\fB\-f, \fB\-\-volfile=VOLUME-FILE\fR
File to use as VOLUME-FILE [default:/etc/glusterfs/glusterfs.vol]
@@ -41,9 +49,9 @@ File to use as VOLUME-FILE [default:/etc/glusterfs/glusterfs.vol]
\fB\-l, \fB\-\-log\-file=LOGFILE\fR
File to use for logging [default:/var/log/glusterfs/glusterfs.log]
.TP
-\fB\-L, \fB\-\-log\-level=LOGLEVEL\fR
-Logging severity. Valid options are DEBUG, WARNING, ERROR, CRITICAL
-and NONE [default: WARNING]
+\fB\-L, \fB\-\-log\-level=LOGLEVEL\fR
+Logging severity. Valid options are TRACE, DEBUG, NORMAL, WARNING, ERROR and
+CRITICAL [default: WARNING]
.TP
\fB\-s, \fB\-\-volfile\-server=SERVER\fR
Server to get the volume from. This option overrides \fB\-\-volfile option
@@ -56,12 +64,15 @@ Server to use as the central log server.
.TP
\fB\-\-debug\fR
-Run in debug mode. This option sets \fB\-\-no\-daemon\fR, \fB\-\-log\-level\fR to DEBUG
+Run in debug mode. This option sets \fB\-\-no\-daemon\fR, \fB\-\-log\-level\fR to DEBUG
and \fB\-\-log\-file\fR to console
.TP
\fB\-N, \fB\-\-no\-daemon\fR
Run in foreground
.TP
+\fB\-\-read\-only\fR
+Makes the filesystem read-only
+.TP
\fB\-p, \fB\-\-pid\-file=PIDFILE\fR
File to use as pid file
.TP
@@ -75,7 +86,7 @@ Port number of volfile server
Transport type to get volume file from server [default: socket]
.TP
\fB\-\-volume\-name=VOLUME\-NAME\fR
-Volume name to be used for MOUNT-POINT [default: top most volume in
+Volume name to be used for MOUNT-POINT [default: top most volume in
VOLUME-FILE]
.TP
\fB\-\-xlator\-option=VOLUME\-NAME.OPTION=VALUE\fR
@@ -94,7 +105,7 @@ Set attribute timeout to SECONDS for inodes in fuse kernel module [default: 1]
\fB\-\-entry\-timeout=SECONDS\fR
Set entry timeout to SECONDS in fuse kernel module [default: 1]
.TP
-\fB\-\-disable\-direct\-io\-mode\fR
+\fB\-\-disable\-direct\-io\-mode\fR
Disable direct I/O mode in fuse kernel module
.SS "Miscellaneous Options"
@@ -116,23 +127,11 @@ Print program version
.SH SEE ALSO
.nf
-The full documentation for \fBGlusterFS\fR is maintained as a Texinfo manual.
-If the \fBinfo\fR and \fBglusterfs\fR are properly installed on your site, the command
- \fBinfo glusterfs\fR
-should give you access to complete documentation.
-
-.nf
-\fBbison\fR(1) \fBflex\fR(1) \fBfusermount\fR(1)
-\fBhttp://www.glusterfs.org/ <URL:http://www.glusterfs.org/>
-\fR
-.fi
-.SH AUTHORS
-.nf
-\fBhttp://www.gluster.org/core-team.php <URL:http://www.gluster.org/core-team.php>
+\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs-volgen\fR(8)
\fR
.fi
.SH COPYRIGHT
.nf
-\fBCopyright(c)2006-2009 Gluster, Inc. <http://www.gluster.com>
+Copyright(c) 2006-2010 Gluster, Inc. <http://www.gluster.com>
\fR
.fi
diff --git a/doc/mount.glusterfs.8 b/doc/mount.glusterfs.8
index fbc8c02..20a4c60 100644
--- a/doc/mount.glusterfs.8
+++ b/doc/mount.glusterfs.8
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2008-2009 Gluster, Inc. <http://www.gluster.com>
+.\" Copyright (c) 2008-2010 Gluster, Inc. <http://www.gluster.com>
.\" This file is part of GlusterFS.
.\"
.\" GlusterFS is free software; you can redistribute it and/or modify
@@ -15,72 +15,76 @@
.\" long with this program. If not, see
.\" <http://www.gnu.org/licenses/>.
.\"
-.\"
-.\"
-.TH GlusterFS 8 "Cluster Filesystem" "07 December 2008" "Gluster Inc."
+.\"
+.\"
+.TH GlusterFS 8 "Cluster Filesystem" "18 March 2010" "Gluster Inc."
.SH NAME
-GlusterFS \- Clustered Filesystem.
+mount.glusterfs - script to mount native GlusterFS volume
.SH SYNOPSYS
-.B mount.glusterfs
-.I <volumeserver>:<volumeid/volumeport> -o <options> <mountpoint>
+.B mount -t glusterfs
+.I [-o <options>] <volumeserver>:<volumeid/volumeport> <mountpoint>
+.TP
+.B mount -t glusterfs
+.I [-o <options>] <path/to/volumefile> <mountpoint>
.PP
.SH DESCRIPTION
-This tool is part of \fBglusterfs\fR(8)
+This tool is part of \fBglusterfs\fR(8) package, which is used to mount using
+GlusterFS native binary.
+
+\fBmount.glusterfs\fR is meant to be used by the mount(8) command for mounting
+native GlusterFS client. This subcommand, however, can also be used as a
+standalone command with limited functionality.
+
.SH OPTIONS
.PP
.SS "Basic options"
.PP
-.TP
-
-\fBlog\-file=\fRvalue
+.TP
+\fBlog\-file=\fRLOG-FILE
File to use for logging [default:/var/log/glusterfs/glusterfs.log]
.TP
-\fBlog\-level=\fRvalue
-Logging severity. Valid options are TRACE, DEBUG, WARNING, ERROR, CRITICAL
+\fBlog\-level=\fRLOG-LEVEL
+Logging severity. Valid options are TRACE, DEBUG, WARNING, ERROR, CRITICAL
NORMAL and NONE [default: NORMAL]
.TP
-\fBlog\-server=\fRvalue
-Server to use as the central log server.
-
+\fBro\fR
+Mount the filesystem read-only
+.PP
.SS "Advanced options"
.PP
.TP
-
-\fBvolfile\-id=\fRvalue
+\fBvolfile\-id=\fRKEY
Volume key or name of the volume file to be fetched from server
.TP
-\fBserver\-port=\fRvalue
+\fBserver\-port=\fRPORT
Port number of volfile server [default: 6996]
.TP
-\fBtransport=\fRvalue
+\fBtransport=\fRTRANSPORT-TYPE
Transport type to get volume file from server [default: socket]
.TP
-\fBvolume\-name=\fRvalue
-Volume name to be used for MOUNT-POINT [default: top most volume in
+\fBvolume\-name=\fRVOLUME-NAME
+Volume name to be used for MOUNT-POINT [default: top most volume in
VOLUME-FILE]
.TP
-\fBlog\-server\-port=\fRvalue
-Listening port number of log server
-.TP
-\fBdirect\-io\-mode=\fRvalue
+\fBdirect\-io\-mode=\fRdisable
Disable direct I/O mode in fuse kernel module
.TP
-
.PP
.SH FILES
-.TP
+.TP
.I /etc/fstab
-file system table
+A typical GlusterFS entry in /etc/fstab looks like below
+
+server1.gluster.com:mirror /mnt/mirror glusterfs log-file=/var/log/mirror.vol,ro,defaults 0 0
+
.TP
.I /etc/mtab
-table of mounted file systems
+An example entry of a GlusterFS mountpoint in /etc/mtab looks like below
-.SH SEE ALSO
-.BR glusterfs(8),
-.BR mount(8)
+mirror.vol /mnt/glusterfs fuse.glusterfs rw,allow_other,default_permissions,max_read=131072 0 0
-.SH AUTHORS
-.BR http://www.gluster.org/core-team.php <URL:http://www.gluster.org/core-team.php>
+.SH SEE ALSO
+\fBglusterfs\fR(8), \fBmount\fR(8)
.SH COPYRIGHT
-.BR Copyright(c)2006-2009 Gluster, Inc. <http://www.gluster.com>
+Copyright(c) 2006-2010 Gluster, Inc. <http://www.gluster.com>