diff options
| author | shishir gowda <shishirng@gluster.com> | 2010-09-06 01:58:48 +0000 |
|---|---|---|
| committer | Vijay Bellur <vijay@dev.gluster.com> | 2010-09-06 02:21:48 -0700 |
| commit | 3cb231e7970222a7360f982934edc5c6f8475883 (patch) | |
| tree | 4e74786fbe05359e6dcc2e5dff3057be18ec9564 /doc/gluster.8 | |
| parent | 386ea89d93497f805c77773515a735a11ef67f29 (diff) | |
Man pages for gluster
Signed-off-by: shishir gowda <shishirng@gluster.com>
Signed-off-by: Vijay Bellur <vijay@dev.gluster.com>
BUG: 1529 (need man pages for 'gluster' and 'glusterd')
URL: http://bugs.gluster.com/cgi-bin/bugzilla3/show_bug.cgi?id=1529
Diffstat (limited to 'doc/gluster.8')
| -rw-r--r-- | doc/gluster.8 | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/gluster.8 b/doc/gluster.8 new file mode 100644 index 00000000000..5354dcda963 --- /dev/null +++ b/doc/gluster.8 @@ -0,0 +1,63 @@ +.\" 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 +.\" it under the terms of the GNU 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 +.\" General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" long with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.\" +.\" +.\" +.TH Gluster 8 "Gluster command line tool" "9 September 2010" "Gluster Inc." +.SH NAME +Gluster \- Gluster command line tool. +.SH SYNOPSYS +.B gluster +.PP +To enter gluster cli +.PP +(or) +.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. +Only one instance of tool execution is permitted at a time. +Parallel invocations will return an error to the second and further instances, +with a description of where the first instance is running and what operation it is performing. + +.SH COMMANDS +.PP +Mandatory or optional arguments to long options are also mandatory or optional +for any corresponding short options. +.SS "Basic commands" +.PP +.TP + +\fB\ help \fR +Help +.TP +\fB\ peer <options> \fR +Command for peer management +.TP +\fB\ volume <options> \fR +Command for volume management +.TP +\fB\ quit \fR +Exit from cli. +.TP + +.fi |