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 | |
| 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
| -rw-r--r-- | doc/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/gluster.8 | 63 | ||||
| -rw-r--r-- | extras/FreeBSD/Makefile | 2 | ||||
| -rw-r--r-- | extras/Solaris/Prototype | 1 | ||||
| -rw-r--r-- | glusterfs.spec.in | 1 | 
5 files changed, 68 insertions, 3 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index a29335817b0..371d1c49c90 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,12 +1,12 @@  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 +	translator-options.txt mac-related-xattrs.txt replicate.pdf glusterd.vol glusterfs.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 +man8_MANS = glusterfs.8 mount.glusterfs.8 gluster.8  CLEANFILES =  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 diff --git a/extras/FreeBSD/Makefile b/extras/FreeBSD/Makefile index e366d6f16a8..ec4b2c6f214 100644 --- a/extras/FreeBSD/Makefile +++ b/extras/FreeBSD/Makefile @@ -20,7 +20,7 @@ BUILD_DEPENDS= fusefs-libs>2.6.3:${PORTSDIR}/sysutils/fusefs-libs  LIB_DEPENDS=   fuse.2:${PORTSDIR}/sysutils/fusefs-libs  RUN_DEPENDS=   ${LOCALBASE}/modules/fuse.ko:${PORTSDIR}/sysutils/fusefs-kmod -MAN8=          glusterfs.8 +MAN8=          glusterfs.8 gluster.8  GNU_CONFIGURE= yes  USE_LDCONFIG=  yes  USE_AUTOTOOLS= libtool:15 diff --git a/extras/Solaris/Prototype b/extras/Solaris/Prototype index 369234210a9..c6120234a37 100644 --- a/extras/Solaris/Prototype +++ b/extras/Solaris/Prototype @@ -9,6 +9,7 @@ d none /usr/sfw/share 0755 root bin  d none /usr/sfw/share/man 0755 root bin  d none /usr/sfw/share/man/man8 0755 root bin  f none /usr/sfw/share/man/man8/glusterfs.8 0644 root root +f none /usr/sfw/share/man/man8/gluster.8 0644 root root  d none /usr/sfw/share/doc 0755 root bin  d none /usr/sfw/share/doc/glusterfs 0755 root root  d none /usr/sfw/share/doc/glusterfs/examples 0755 root root diff --git a/glusterfs.spec.in b/glusterfs.spec.in index 4ea1b31443c..3e1aceb24db 100644 --- a/glusterfs.spec.in +++ b/glusterfs.spec.in @@ -145,6 +145,7 @@ fi  %{_sbindir}/gluster  %{_sbindir}/glusterd  %{_mandir}/man8/*glusterfs.8* +%{_mandir}/man8/*gluster.8*  %dir /var/log/glusterfs  %exclude %{_libdir}/glusterfs/%{version}/transport/ib-verbs*  %exclude %{_libdir}/glusterfs/%{version}/xlator/mount/fuse*  | 
