diff options
| -rw-r--r-- | doc/gluster.8 | 103 | ||||
| -rw-r--r-- | doc/glusterd.8 | 41 | ||||
| -rw-r--r-- | doc/glusterfs.8 | 67 |
3 files changed, 98 insertions, 113 deletions
diff --git a/doc/gluster.8 b/doc/gluster.8 index ced265fe1..3886d29a0 100644 --- a/doc/gluster.8 +++ b/doc/gluster.8 @@ -1,4 +1,3 @@ -.\" .\" Copyright (c) 2006-2011 Gluster, Inc. <http://www.gluster.com> .\" This file is part of GlusterFS. .\" @@ -13,109 +12,115 @@ .\" Affero General Public License for more details. .\" .\" You should have received a copy of the GNU Affero General Public License -.\" along with this program. If not, see -.\" <http://www.gnu.org/licenses/>. +.\" along with this program. If not, see " <http://www.gnu.org/licenses/>. .\" .\" -.TH Gluster 8 "Gluster command line tool" "9 September 2010" "Gluster Inc." +.TH Gluster 8 "Gluster command line utility" "07 March 2011" "Gluster Inc." .SH NAME -Gluster \- Gluster command line tool. +gluster - Gluster Console Manager (command line utility) .SH SYNOPSIS .B gluster .PP -To enter gluster prompt +To run the program and display gluster prompt: +.PP +.B gluster .PP (or) .PP - +To specify a command directly: +.PP .B gluster .I [commands] [options] -.PP -Gluster is a command line tool for dynamic volume management for glusterfs. + .SH DESCRIPTION -Gluster command line tool is used for dynamic volume management. -The tool must be executed on any of the export servers. The cli gives an easy way to perform cloud operations such as volume create, volume expand, volume shrink, volume migrate, volume rebalance without the necessity of scheduling downtimes. +The Gluster Console Manager is a command line utility for elastic volume management. You can run the gluster command on any export server. The command enables administrators to perform cloud operations, such as creating, expanding, shrinking, rebalancing, and migrating volumes without needing to schedule server downtime. .SH COMMANDS -.PP -Mandatory or optional arguments to long options are also mandatory or optional -for any corresponding short options. -.SS "Basic commands" + +.SS "Volume Commands" .PP .TP \fB\ volume info [all|<VOLNAME>] \fR -list information of all volumes +Display information about all volumes, or the specified volume. .TP \fB\ volume create <NEW-VOLNAME> [stripe <COUNT>] [replica <COUNT>] [transport <tcp|rdma>] <NEW-BRICK> ... \fR -create a new volume of specified type with mentioned bricks, with specified transport-type [default:tcp] +Create a new volume of the specified type using the specified bricks and transport type (the default transport type is tcp). .TP \fB\ volume delete <VOLNAME> \fR -delete volume specified by \fB\<VOLNAME>\fR +Delete the specified volume. .TP \fB\ volume start <VOLNAME> \fR -start volume specified by \fB\<VOLNAME>\fR +Start the specified volume. .TP \fB\ volume stop <VOLNAME> [force] \fR -stop volume specified by \fB\<VOLNAME>\fR +Stop the specified volume. .TP \fB\ volume rename <VOLNAME> <NEW-VOLNAME> \fR -rename volume \fB\<VOLNAME>\fR to \fB\<NEW-VOLNAME>\fR +Rename the specified volume. +.TP +\fB\ volume set <VOLNAME> <OPTION> <PARAMETER> [<OPTION> <PARAMETER>] ... \fR +Set the volume options. +.TP +\fB\ volume help \fR +Display help for the volume command. +.SS "Brick Commands" +.PP .TP \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 +Add the specified brick to the specified volume. .TP \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 +Remove the specified brick from the specified volume. +.IP +.B Note: +If you remove the brick, the data stored in that brick will not be available. You can migrate data from one brick to another using +.B replace-brick +option. .TP -\fB\ volume rebalance <VOLNAME> start \fR -start rebalance of volume \fB\<VOLNAME>\fR +\fB\ volume rebalance-brick <VOLNAME>(<BRICK> <NEW-BRICK>) start \fR +Start rebalancing the specified volume. .TP \fB\ volume rebalance <VOLNAME> stop \fR -stop rebalance of volume \fB\<VOLNAME>\fR +Stop rebalancing the specified volume. .TP \fB\ volume rebalance <VOLNAME> status \fR -rebalance status of volume \fB<VOLNAME>\fR +Display the rebalance status of the specified volume. .TP \fB\ volume replace-brick <VOLNAME> (<BRICK> <NEW-BRICK>) start|pause|abort|status|commit \fR -replace-brick operations -.TP -\fB\ volume set <VOLNAME> <OPTION> <VALUE> [<OPTION> <VALUE>] ... \fR -set transport type for volume \fB\<VOLNAME>\fR +Replace the specified brick. +.SS "Log Commands" .TP -\fB\ volume help \fB -display help for the volume command +\fB\ volume log filename <VOLNAME> [BRICK] <DIRECTORY> \fB +Set the log directory for the corresponding volume/brick. .TP -\fB\ volume log filename <VOLNAME> [BRICK] <PATH> \fB -set the log file for corresponding volume/brick -.TP -\fB\ volume log locate <VOLNAME> [BRICK] \fB -locate the log file for corresponding volume/brick +\fB\volume log locate <VOLNAME> [BRICK] \fB +Locate the log file for corresponding volume/brick. .TP \fB\ volume log rotate <VOLNAME> [BRICK] \fB -rotate the log file for corresponding volume/brick +Rotate the log file for corresponding volume/brick. +.SS "Peer Commands" .TP \fB\ peer probe <HOSTNAME> \fR -probe peer specified by \fB\<HOSTNAME>\fR +Probe the specified peer. .TP \fB\ peer detach <HOSTNAME> \fR -detach peer specified by \fB\<HOSTNAME>\fR +Detach the specified peer. .TP \fB\ peer status \fR -list status of peers +Display the status of peers. .TP \fB\ peer help \fR -Help command for peer +Display help for the peer command. +.SS "Other Commands" .TP \fB\ help \fR -display command options +Display the command options. .TP \fB\ quit \fR -quit -.TP -.PP +Exit the gluster command line interface. + .SH FILES /etc/glusterd/* - .SH SEE ALSO .nf \fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBglusterfs\fR(8), \fBglusterd\fR(8) @@ -124,5 +129,3 @@ quit .SH COPYRIGHT .nf Copyright(c) 2006-2011 Gluster, Inc. <http://www.gluster.com> - -.fi diff --git a/doc/glusterd.8 b/doc/glusterd.8 index 254542f81..1bc08dc79 100644 --- a/doc/glusterd.8 +++ b/doc/glusterd.8 @@ -18,55 +18,44 @@ .\" .\" -.TH Glusterd 8 "Gluster dynamic volume management Daemon" "9 September 2010" "Gluster Inc." +.TH Glusterd 8 "Gluster elastic volume management daemon" "07 March 2011" "Gluster Inc." .SH NAME -Glusterd \- Gluster dynamic volume management Daemon. +Glusterd \- Gluster elastic volume management daemon .SH SYNOPSIS .B glusterd -.PP -(or) -.B glusterd .I [OPTION...] -.PP -Glusterd is a daemon for dynamic volume management for glusterfs. .SH DESCRIPTION -Gluster daemon is used for dynamic volume management. -The daemon must be executed on all of the export servers. +The glusterd daemon is used for elastic volume management. The daemon must be run on all export servers. .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\-l, \fB\-\-log\-file=LOGFILE\fR -File to use for logging [default:/usr/local/var/log/glusterfs/glusterfs.log] +\fB\-l=<LOGFILE>, \fB\-\-log\-file=<LOGFILE>\fR +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: NORMAL] +\fB\-L=<LOGLEVEL>, \fB\-\-log\-level=<LOGLEVEL>\fR +Logging severity. Valid options are TRACE, DEBUG, NORMAL, WARNING, ERROR and CRITICAL (the default is NORMAL). .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 the program 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 +Run the program in the foreground. -.TP -.SS Miscellaneous Options: +.SS "Miscellaneous Options:" .TP \fB\-?, \fB\-\-help\fR -Give this help list +Display this help. .TP \fB\-\-usage\fR -Give a short usage message +Display a short usage message. .TP \fB\-V, \fB\-\-version\fR -Print program version +Print the program version. .PP .SH FILES diff --git a/doc/glusterfs.8 b/doc/glusterfs.8 index 278c54504..cb030a9e2 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 |