cluster: STABLE3 - man pages: group_tool

cluster: STABLE3 - man pages: group_tool

[David Teigland]

Gitweb:        http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=b0374bf72e4fb6a6e8e1a6cf8001fe3008c29de5
Commit:        b0374bf72e4fb6a6e8e1a6cf8001fe3008c29de5
Parent:        71acc49eadd17dcd132df673bfb8120bb2821671
Author:        David Teigland <teigland@redhat.com>
AuthorDate:    Tue Apr 7 16:21:27 2009 -0500
Committer:     David Teigland <teigland@redhat.com>
CommitterDate: Tue Apr 7 16:21:27 2009 -0500

man pages: group_tool

Updates for recent changes.

Signed-off-by: David Teigland <teigland@redhat.com>
---
 group/man/group_tool.8 |   45 ++++++++++++++++++++++++++++++++++-----------
 1 files changed, 34 insertions(+), 11 deletions(-)

diff --git a/group/man/group_tool.8 b/group/man/group_tool.8
index 2665ea6..b0c623d 100644
--- a/group/man/group_tool.8
+++ b/group/man/group_tool.8
@@ -14,47 +14,70 @@ The group_tool program displays information about fence, dlm and gfs groups.
 
 .SH SUBCOMMANDS
 
-group_tool ls -a [-n]
+\fBgroup_tool ls\fP [-n]
 
   Queries individual daemons, and displays full daemon and group state.
   It is a shortcut for:
+
   fence_tool ls [-n]
+.br
   dlm_tool ls [-n]
+.br
   gfs_control ls [-n]
 
-group_tool ls [-v]
-
-  Queries groupd or individual daemons, depending on groupd compat mode.
-  Displays limited cluster2-style output of daemon and group state.
+\fBgroup_tool compat\fP
 
-group_tool compat
+  Queries groupd about compatibility mode currently running:
 
-  Queries groupd about compatibility mode currently running.  Any ls command
-  also includes this query and displays the result.  Possible results:
   groupd not running
+.br
   groupd compatibility mode 0
+.br
   groupd compatibility mode 1
+.br
   groupd compatibility mode 2 (pending)
+.br
 
-group_tool dump [gfs|dlm|fence|plocks] [name]
+\fBgroup_tool dump\fP [gfs|dlm|fence|plocks] [name]
 
   Dumps debug info from daemons:
 
   group_tool dump gfs: dump gfs_controld debug log
+.br
 	(same as gfs_control dump)
+.br
   group_tool dump dlm: dump dlm_controld debug log
+.br
 	(same as dlm_tool dump)
+.br
   group_tool dump fence: dump fenced debug log
+.br
 	(same as fence_tool dump)
+.br
   group_tool dump plocks <x>: dump plock state
+.br
 	(same as dlm_tool plocks <x>)
+.br
   group_tool dump: dump groupd debug log
+.br
 
 
 .SH OPTIONS
 .TP
+\fB-g <num>\fP
+Select daemons to query with ls
+.br
+0: query fenced, dlm_controld, gfs_controld (default)
+.br
+1: query groupd (for old compat mode)
+.br
+2: query groupd (1) when in compat mode, otherwise daemons (0)
+.TP
+\fB-n\fP
+Show all node information (with ls -g0)
+.TP
 \fB-v\fP
-Verbose output, used with the 'ls' subcommand.
+Show extra event information (with ls -g1)
 .TP
 \fB-V\fP
 Print the version information and exit.
@@ -63,5 +86,5 @@ Print the version information and exit.
 Print out a help message describing available options, then exit.
 
 .SH SEE ALSO
-groupd(8)
+groupd(8), fence_tool(8), dlm_tool(8), gfs_control(8)
 

cluster: STABLE3 - man pages: group_tool

[David Teigland]

Gitweb:        http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=7adbe0ef27635a0139b5d3789e12a3cc2019ae5e
Commit:        7adbe0ef27635a0139b5d3789e12a3cc2019ae5e
Parent:        abc092893125eae0cfdd87f4671f62a05507310e
Author:        David Teigland <teigland@redhat.com>
AuthorDate:    Fri Mar 20 13:50:30 2009 -0500
Committer:     David Teigland <teigland@redhat.com>
CommitterDate: Tue Apr 7 15:03:55 2009 -0500

man pages: group_tool

Signed-off-by: David Teigland <teigland@redhat.com>
---
 group/man/group_tool.8 |   60 ++++++++++++++++++++++++++---------------------
 1 files changed, 33 insertions(+), 27 deletions(-)

diff --git a/group/man/group_tool.8 b/group/man/group_tool.8
index 6cf5e7f..2665ea6 100644
--- a/group/man/group_tool.8
+++ b/group/man/group_tool.8
@@ -10,52 +10,58 @@ group_tool
 
 .SH DESCRIPTION
 
-The group_tool program displays the status of fence, dlm and gfs groups.
-The information is read from the groupd daemon which controls the fenced,
-dlm_controld and gfs_controld daemons.  group_tool will also dump debug
-logs from various daemons.
+The group_tool program displays information about fence, dlm and gfs groups.
 
 .SH SUBCOMMANDS
 
-.TP
-\fBls\fP
-displays the list of groups and their membership.  It is the default
-subcommand if none is specified.
+group_tool ls -a [-n]
 
-.TP
-\fBdump\fP
-dumps the debug log from groupd.
+  Queries individual daemons, and displays full daemon and group state.
+  It is a shortcut for:
+  fence_tool ls [-n]
+  dlm_tool ls [-n]
+  gfs_control ls [-n]
 
-.TP
-\fBdump fence\fP
-dumps the debug log from fenced.
+group_tool ls [-v]
 
-.TP
-\fBdump gfs\fP
-dumps the debug log from gfs_controld.
+  Queries groupd or individual daemons, depending on groupd compat mode.
+  Displays limited cluster2-style output of daemon and group state.
+
+group_tool compat
+
+  Queries groupd about compatibility mode currently running.  Any ls command
+  also includes this query and displays the result.  Possible results:
+  groupd not running
+  groupd compatibility mode 0
+  groupd compatibility mode 1
+  groupd compatibility mode 2 (pending)
+
+group_tool dump [gfs|dlm|fence|plocks] [name]
+
+  Dumps debug info from daemons:
+
+  group_tool dump gfs: dump gfs_controld debug log
+	(same as gfs_control dump)
+  group_tool dump dlm: dump dlm_controld debug log
+	(same as dlm_tool dump)
+  group_tool dump fence: dump fenced debug log
+	(same as fence_tool dump)
+  group_tool dump plocks <x>: dump plock state
+	(same as dlm_tool plocks <x>)
+  group_tool dump: dump groupd debug log
 
-.TP
-\fBdump plocks\fP <fsname>
-prints the posix locks on the named gfs fs from gfs_controld.
 
 .SH OPTIONS
 .TP
 \fB-v\fP
 Verbose output, used with the 'ls' subcommand.
 .TP
-\fB-D\fP
-Run the daemon in the foreground and print debug statements to stdout.
-.TP
 \fB-V\fP
 Print the version information and exit.
 .TP
 \fB-h\fP 
 Print out a help message describing available options, then exit.
 
-.SH DEBUGGING
-The groupd daemon keeps a circular buffer of debug messages that can be
-dumped with the 'group_tool dump' command.
-
 .SH SEE ALSO
 groupd(8)