From 4a95f8f3b39f58349ef0935b1746e543408b3080 Mon Sep 17 00:00:00 2001
From: Amar Tumballi <amar@gluster.com>
Date: Fri, 18 Feb 2011 03:10:29 +0000
Subject: man pages updated

Signed-off-by: Amar Tumballi <amar@gluster.com>
Signed-off-by: Anand V. Avati <avati@dev.gluster.com>

BUG: 2444 (keep man pages upto date with new codebase.)
URL: http://bugs.gluster.com/cgi-bin/bugzilla3/show_bug.cgi?id=2444
---
 doc/Makefile.am       |   4 +-
 doc/gluster.8         |  25 ++++------
 doc/glusterd.8        |   7 ++-
 doc/glusterfs.8       |  16 ++----
 doc/glusterfsd.8      | 131 ++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/mount.glusterfs.8 |   6 +--
 6 files changed, 154 insertions(+), 35 deletions(-)
 create mode 100644 doc/glusterfsd.8

(limited to 'doc')

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f26fc750..c5fd2b81 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 glusterfsd.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 glusterfsd.8
 
 CLEANFILES = 
diff --git a/doc/gluster.8 b/doc/gluster.8
index 23910dc0..ced265fe 100644
--- a/doc/gluster.8
+++ b/doc/gluster.8
@@ -1,5 +1,5 @@
 .\"
-.\"  Copyright (c) 2006-2010 Gluster, Inc. <http://www.gluster.com>
+.\"  Copyright (c) 2006-2011 Gluster, Inc. <http://www.gluster.com>
 .\"  This file is part of GlusterFS.
 .\"
 .\"  GlusterFS is GF_FREE software; you can redistribute it and/or modify
@@ -26,7 +26,7 @@ Gluster \- Gluster command line tool.
 To enter gluster prompt 
 .PP
 (or)
-.pp
+.PP
 
 .B gluster
 .I [commands] [options]
@@ -61,11 +61,11 @@ stop volume specified by \fB\<VOLNAME>\fR
 \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
+\fB\ volume add-brick <VOLNAME> <NEW-BRICK> ... \fR
+add brick to volume. if the volume is of the type replicate or stripe, then one need to provide bricks in multiple of replica count, or stripe count.\fB\<VOLNAME>\fR
 .TP
-\fB\ volume remove-brick <VOLNAME> [(replica <COUNT>)|(stripe <COUNT>)] <BRICK> ... \fR
-remove brick from volume \fB\<VOLNAME>\fR
+\fB\ volume remove-brick <VOLNAME> <BRICK> ... \fR
+remove brick from volume. if the volume is of the type replicate or stripe, then one need to provide bricks in multiple of replica count, or stripe count. Note that with this option, your data in the bricks which are removed is not going to available. If you need to migrate data, then refer to 'replace-brick' option. \fB\<VOLNAME>\fR
 .TP
 \fB\ volume rebalance <VOLNAME> start \fR
 start rebalance of volume \fB\<VOLNAME>\fR
@@ -76,15 +76,11 @@ stop rebalance of volume \fB\<VOLNAME>\fR
 \fB\ volume rebalance <VOLNAME> status \fR
 rebalance status of volume \fB<VOLNAME>\fR
 .TP
-\fB\ volume replace-brick <VOLNAME> (<BRICK> <NEW-BRICK>) start|pause|abort|status \fR
+\fB\ volume replace-brick <VOLNAME> (<BRICK> <NEW-BRICK>) start|pause|abort|status|commit \fR
 replace-brick operations
 .TP
-\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
+\fB\ volume set <VOLNAME> <OPTION> <VALUE> [<OPTION> <VALUE>] ... \fR
 set transport type for volume \fB\<VOLNAME>\fR
-\fR
 .TP
 \fB\ volume help \fB
 display help for the volume command
@@ -122,12 +118,11 @@ quit
 
 .SH SEE ALSO
 .nf
-\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs-volgen\fR(8)
-\fBglusterfs\fR(8), \fBglusterd\fR(8)
+\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs\fR(8), \fBglusterd\fR(8)
 \fR
 .fi
 .SH COPYRIGHT
 .nf
-Copyright(c) 2006-2010  Gluster, Inc.  <http://www.gluster.com>
+Copyright(c) 2006-2011  Gluster, Inc.  <http://www.gluster.com>
 
 .fi
diff --git a/doc/glusterd.8 b/doc/glusterd.8
index ba714b2d..254542f8 100644
--- a/doc/glusterd.8
+++ b/doc/glusterd.8
@@ -1,5 +1,5 @@
 .\"
-.\"  Copyright (c) 2006-2010 Gluster, Inc. <http://www.gluster.com>
+.\"  Copyright (c) 2006-2011 Gluster, Inc. <http://www.gluster.com>
 .\"  This file is part of GlusterFS.
 .\"
 .\"  GlusterFS is GF_FREE software; you can redistribute it and/or modify
@@ -74,12 +74,11 @@ Print program version
 
 .SH SEE ALSO
 .nf
-\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs-volgen\fR(8)
-\fBglusterfs\fR(8), \fBgluster\fR(8)
+\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs\fR(8), \fBgluster\fR(8)
 \fR
 .fi
 .SH COPYRIGHT
 .nf
-Copyright(c) 2006-2010  Gluster, Inc.  <http://www.gluster.com>
+Copyright(c) 2006-2011  Gluster, Inc.  <http://www.gluster.com>
 \fR
 .fi
diff --git a/doc/glusterfs.8 b/doc/glusterfs.8
index 082b8074..278c5450 100644
--- a/doc/glusterfs.8
+++ b/doc/glusterfs.8
@@ -1,4 +1,4 @@
-.\"  Copyright (c) 2008-2010 Gluster, Inc. <http://www.gluster.com>
+.\"  Copyright (c) 2008-2011 Gluster, Inc. <http://www.gluster.com>
 .\"  This file is part of GlusterFS.
 .\"
 .\"  GlusterFS is free software; you can redistribute it and/or modify
@@ -55,9 +55,6 @@ CRITICAL [default: WARNING]
 .TP
 \fB\-s, \fB\-\-volfile\-server=SERVER\fR
 Server to get the volume from.  This option overrides \fB\-\-volfile option
-.TP
-\fB\-\-log\-server=LOG\-SERVER\fR
-Server to use as the central log server.
 
 .SS "Advanced options"
 .PP
@@ -91,9 +88,6 @@ VOLUME-FILE]
 .TP
 \fB\-\-xlator\-option=VOLUME\-NAME.OPTION=VALUE\fR
 Add/override a translator option for a volume with the specified value
-.TP
-\fB\-\-log\-server\-port=PORT\fR
-Listening port number of log server
 
 .SS "Fuse options"
 .PP
@@ -105,8 +99,8 @@ 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
-Disable direct I/O mode in fuse kernel module
+\fB\-\-direct\-io\-mode=BOOL\fR
+Enable/Disable direct-io mode in fuse module [default: enable]
 
 .SS "Miscellaneous Options"
 .PP
@@ -127,11 +121,11 @@ Print program version
 
 .SH SEE ALSO
 .nf
-\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs-volgen\fR(8)
+\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBgluster\fR(8)
 \fR
 .fi
 .SH COPYRIGHT
 .nf
-Copyright(c) 2006-2010  Gluster, Inc.  <http://www.gluster.com>
+Copyright(c) 2006-2011  Gluster, Inc.  <http://www.gluster.com>
 \fR
 .fi
diff --git a/doc/glusterfsd.8 b/doc/glusterfsd.8
new file mode 100644
index 00000000..186342d1
--- /dev/null
+++ b/doc/glusterfsd.8
@@ -0,0 +1,131 @@
+.\"  Copyright (c) 2008-2011 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 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
+.\"  Affero General Public License for more details.
+.\"
+.\"  You should have received a copy of the GNU Affero 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 \- Clustered Filesystem.
+.SH SYNOPSIS
+.B glusterfsd
+.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, 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]
+.TP
+\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 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
+
+.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
+.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
+\fB\-\-volfile\-id=KEY\fR
+KEY of the volume file to be fetched from server
+.TP
+\fB\-\-volfile\-server\-port=PORT\fR
+Port number of volfile server
+.TP
+\fB\-\-volfile\-server\-transport=TRANSPORT\fR
+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-FILE]
+.TP
+\fB\-\-xlator\-option=VOLUME\-NAME.OPTION=VALUE\fR
+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]
+.TP
+\fB\-\-entry\-timeout=SECONDS\fR
+Set entry timeout to SECONDS in fuse kernel module [default: 1]
+.TP
+\fB\-\-direct\-io\-mode=BOOL\fR
+Enable/Disable direct-io mode in fuse module [default: enable]
+
+.SS "Miscellaneous Options"
+.PP
+.TP
+
+\fB\-?, \fB\-\-help\fR
+Give this help list
+.TP
+\fB\-\-usage\fR
+Give a short usage message
+.TP
+\fB\-V, \fB\-\-version\fR
+Print program version
+
+.PP
+.SH FILES
+/etc/glusterfs/*.vol
+
+.SH SEE ALSO
+.nf
+\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBgluster\fR(8)
+\fR
+.fi
+.SH COPYRIGHT
+.nf
+Copyright(c) 2006-2011  Gluster, Inc.  <http://www.gluster.com>
+\fR
+.fi
diff --git a/doc/mount.glusterfs.8 b/doc/mount.glusterfs.8
index aced363f..d4927e0a 100644
--- a/doc/mount.glusterfs.8
+++ b/doc/mount.glusterfs.8
@@ -1,4 +1,4 @@
-.\"  Copyright (c) 2008-2010 Gluster, Inc. <http://www.gluster.com>
+.\"  Copyright (c) 2008-2011 Gluster, Inc. <http://www.gluster.com>
 .\"  This file is part of GlusterFS.
 .\"
 .\"  GlusterFS is free software; you can redistribute it and/or modify
@@ -81,7 +81,7 @@ An example entry of a GlusterFS mountpoint in /etc/mtab looks like below
 mirror.vol /mnt/glusterfs fuse.glusterfs rw,allow_other,default_permissions,max_read=131072 0 0
 
 .SH SEE ALSO
-\fBglusterfs\fR(8), \fBmount\fR(8)
+\fBglusterfs\fR(8), \fBmount\fR(8), \fBgluster\fR(8)
 
 .SH COPYRIGHT
-Copyright(c) 2006-2010   Gluster, Inc.   <http://www.gluster.com>
+Copyright(c) 2006-2011   Gluster, Inc.   <http://www.gluster.com>
-- 
cgit