summaryrefslogtreecommitdiffstats
path: root/doc/glusterfs.8
diff options
context:
space:
mode:
Diffstat (limited to 'doc/glusterfs.8')
-rw-r--r--doc/glusterfs.867
1 files changed, 30 insertions, 37 deletions
diff --git a/doc/glusterfs.8 b/doc/glusterfs.8
index 278c545..cb030a9 100644
--- a/doc/glusterfs.8
+++ b/doc/glusterfs.8
@@ -17,107 +17,100 @@
.\"
.\"
.\"
-.TH GlusterFS 8 "Cluster Filesystem" "19 March 2010" "Gluster Inc."
+.TH GlusterFS 8 "Clustered File System" "07 March 2011" "Gluster Inc."
.SH NAME
-GlusterFS \- Clustered Filesystem.
+GlusterFS \- clustered file system
.SH SYNOPSIS
.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
+GlusterFS is a clustered file system, capable of scaling to several peta-bytes.
+It aggregates various storage bricks over Infiniband RDMA or TCP/IP and
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
+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).
+GlusterFS is fully POSIX compliant file system. On client side, it has dependency
+on FUSE package, on server side, it works seemlessly on different operating systems. Currently supported on GNU/Linux and 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
-
\fB\-f, \fB\-\-volfile=VOLUME-FILE\fR
-File to use as VOLUME-FILE [default:/etc/glusterfs/glusterfs.vol]
+File to use as VOLUME-FILE (the default is /etc/glusterfs/glusterfs.vol).
.TP
\fB\-l, \fB\-\-log\-file=LOGFILE\fR
-File to use for logging [default:/var/log/glusterfs/glusterfs.log]
+File to use for logging.
.TP
\fB\-L, \fB\-\-log\-level=LOGLEVEL\fR
-Logging severity. Valid options are TRACE, DEBUG, NORMAL, WARNING, ERROR and
-CRITICAL [default: WARNING]
+Logging severity. Valid options are TRACE, DEBUG, NORMAL, WARNING, ERROR and CRITICAL (the default is WARNING).
.TP
\fB\-s, \fB\-\-volfile\-server=SERVER\fR
-Server to get the volume from. This option overrides \fB\-\-volfile option
+Server to get the volume from. This option overrides \fB\-\-volfile \fR option.
.SS "Advanced options"
.PP
.TP
-
\fB\-\-debug\fR
-Run in debug mode. This option sets \fB\-\-no\-daemon\fR, \fB\-\-log\-level\fR to DEBUG
-and \fB\-\-log\-file\fR to console
+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
+Run in the foreground.
.TP
\fB\-\-read\-only\fR
-Makes the filesystem read-only
+Make the file system read-only.
.TP
\fB\-p, \fB\-\-pid\-file=PIDFILE\fR
-File to use as pid file
+File to use as PID file.
.TP
\fB\-\-volfile\-id=KEY\fR
-KEY of the volume file to be fetched from server
+Key of the volume file to be fetched from the server.
.TP
\fB\-\-volfile\-server\-port=PORT\fR
-Port number of volfile server
+Port number of volfile server.
.TP
\fB\-\-volfile\-server\-transport=TRANSPORT\fR
-Transport type to get volume file from server [default: socket]
+Transport type to get volume file from server (the deafult is socket).
.TP
\fB\-\-volume\-name=VOLUME\-NAME\fR
-Volume name to be used for MOUNT-POINT [default: top most volume in
-VOLUME-FILE]
+Volume name to be used for MOUNT-POINT (the default is top most volume in VOLUME-FILE).
.TP
\fB\-\-xlator\-option=VOLUME\-NAME.OPTION=VALUE\fR
-Add/override a translator option for a volume with the specified value
+Add/Override a translator option for a volume with the specified value.
.SS "Fuse options"
.PP
.TP
\fB\-\-attribute\-timeout=SECONDS\fR
-Set attribute timeout to SECONDS for inodes in fuse kernel module [default: 1]
+Set attribute timeout to SECONDS for inodes in fuse kernel module (the default is 1).
.TP
\fB\-\-entry\-timeout=SECONDS\fR
-Set entry timeout to SECONDS in fuse kernel module [default: 1]
+Set entry timeout to SECONDS in fuse kernel module (the default is 1).
.TP
\fB\-\-direct\-io\-mode=BOOL\fR
-Enable/Disable direct-io mode in fuse module [default: enable]
+Enable/Disable the direct-I/O mode in fuse module (the default is enable).
.SS "Miscellaneous Options"
.PP
.TP
\fB\-?, \fB\-\-help\fR
-Give this help list
+Display this help.
.TP
-\fB\-\-usage\fR
-Give a short usage message
+\fB\-\-usage\fReew
+Display a short usage message.
.TP
\fB\-V, \fB\-\-version\fR
-Print program version
+Print the program version.
.PP
.SH FILES
-/etc/glusterfs/*.vol
+/etc/glusterfs/*.vol, /etc/glusterd/vols/*/*.vol
.SH SEE ALSO
.nf