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

1 files changed, 40 insertions, 36 deletions

diff --git a/doc/mount.glusterfs.8 b/doc/mount.glusterfs.8
index fbc8c0206fd..20a4c60540a 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>