summaryrefslogtreecommitdiffstats
path: root/doc/glusterfs.8
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/glusterfs.8
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/glusterfs.8')
-rw-r--r--doc/glusterfs.855
1 files changed, 27 insertions, 28 deletions
diff --git a/doc/glusterfs.8 b/doc/glusterfs.8
index ef8fce9d97d..ef1871aa792 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