dlm: master - dlm_tool: update man page

David Teigland teigland at fedoraproject.org
Thu Apr 5 21:44:48 UTC 2012


Gitweb:        http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=adff37be43519da0cf40d7de541d217fbcf842c5
Commit:        adff37be43519da0cf40d7de541d217fbcf842c5
Parent:        878c9fa5cd0d9a8be0f6e65361f50f43a8ec4843
Author:        David Teigland <teigland at redhat.com>
AuthorDate:    Thu Apr 5 15:13:07 2012 -0500
Committer:     David Teigland <teigland at redhat.com>
CommitterDate: Thu Apr 5 15:13:07 2012 -0500

dlm_tool: update man page

and help output

Signed-off-by: David Teigland <teigland at redhat.com>
---
 dlm_tool/dlm_tool.8 |  105 +++++++++++++++++++++++++--------------------------
 dlm_tool/main.c     |   22 +++++-----
 2 files changed, 63 insertions(+), 64 deletions(-)

diff --git a/dlm_tool/dlm_tool.8 b/dlm_tool/dlm_tool.8
index df9aa64..9b061a0 100644
--- a/dlm_tool/dlm_tool.8
+++ b/dlm_tool/dlm_tool.8
@@ -1,4 +1,4 @@
-.TH DLM_TOOL 8 2009-01-20 cluster cluster
+.TH DLM_TOOL 8 2012-04-05 dlm dlm
 
 .SH NAME
 dlm_tool \- a utility for the dlm and dlm_controld daemon
@@ -10,89 +10,88 @@ dlm_tool \- a utility for the dlm and dlm_controld daemon
 .I name
 ]
 
-.SH DESCRIPTION
-.TP
+.SH COMMANDS 
+
 .B ls
-Display internal dlm_controld state about lockspaces.
+.br
+	Display dlm_controld internal lockspace state.
+
+.B status
+.br
+	Dump dlm_controld daemon state.
 
-.TP
 .B dump
-Dump dlm_controld debug buffer.
+.br
+	Dump dlm_controld debug buffer.
 
-.TP
-.B log_plock
-Dump dlm_controld plock debug buffer.
+.B dump_config
+.br
+	Dump dlm_controld config settings.
 
-.TP
-.BI plocks " name"
-Dump posix locks from dlm_controld for the lockspace.
+.BI fence_ack " nodeid"
+.br
+	Quit trying to fence a node.
 
-.TP
-.BI lockdump " name"
-Minimal display of locks from the lockspace.
+.B log_plock
+.br
+	Dump dlm_controld plock debug buffer.
 
-.TP
-.BI lockdebug " name"
-Extended display of locks from the lockspace.
+.BI plocks " name"
+.br
+	Dump posix locks from dlm_controld for the lockspace.
 
-.TP
 .BI join " name"
-Join a lockspace.
+.br
+	Join a lockspace.
 
-.TP
 .BI leave " name"
-Leave a lockspace.
+.br
+	Leave a lockspace.
 
-.TP
-.BI deadlock_check " name"
-Start a deadlock detection cycle for the lockspace.
+.BI lockdebug " name"
+.br
+	Complete display of locks from the lockspace.
+
+.BI lockdump " name"
+.br
+	Minimal display of locks from the lockspace (deprecated).
 
 .SH OPTIONS
-.TP
+
 .B \-n
 Show all node information in ls.
 
-.TP
-.BI \-d " num"
-Resource directory enabled (1) or disabled (0) during join. Default 0.
+.B \-d
+0|1 Resource directory off/on in join, default 0
 
-.TP
-.BI \-e " num"
-Exclusive create off/on (0/1) in join. Default 0.
+.B \-e
+0|1 Exclusive create off/on in join, default 0
 
-.TP
-.BI \-f " num"
-FS memory allocation off/on (0/1) in join. Default 0.
+.B \-f
+0|1 FS (filesystem) flag off/on in join, default 0
 
-.TP
 .BI \-m " mode"
-The permission mode (in octal) of the lockspace device created by join.
-Default 0600.
+Permission mode for lockspace device (octal), default 0600
 
-.TP
-.B \-M
-Dump MSTCPY locks in addition to locks held by local processes.
-
-.TP
 .B \-s
-Summary following lockdebug output (experimental, format may change).
+Summary following lockdebug output (experiemental)
 
-.TP
 .B \-v
-Verbose lockdebug output.
+Verbose lockdebug output
 
-.TP
 .B \-w
-Wide lockdebug output.
+Wide lockdebug output
+
+.B \-M
+Include MSTCPY locks in lockdump output
 
-.TP
 .B \-h
-Print a help message describing available options, then exit.
+Print help, then exit
 
-.TP
 .B \-V
-Print program version information, then exit.
+Print program version information, then exit
 
 .SH SEE ALSO
-.BR dlm_controld (8)
+.BR dlm_controld (8),
+.BR dlm.conf (5)
 
diff --git a/dlm_tool/main.c b/dlm_tool/main.c
index 1fb6b3e..8dba291 100644
--- a/dlm_tool/main.c
+++ b/dlm_tool/main.c
@@ -183,23 +183,23 @@ static void print_usage(void)
 {
 	printf("Usage:\n");
 	printf("\n");
-	printf("dlm_tool [options] [join | leave | lockdump | lockdebug |\n"
-	       "                    ls | dump | dump_config | log_plock | plocks |\n"
-	       "                    fence_ack]\n");
+	printf("dlm_tool [command] [options] [name]\n");
+	printf("\n");
+	printf("Commands:\n");
+	printf("ls, status, dump, dump_config, fence_ack\n");
+	printf("log_plock, plocks\n");
+	printf("join, leave, lockdebug\n");
 	printf("\n");
 	printf("Options:\n");
 	printf("  -n               Show all node information in ls\n");
-	printf("  -d <n>           Resource directory off/on (0/1) in join, default 0\n");
-	printf("  -e <n>           Exclusive create off/on (0/1) in join, default 0\n");
-	printf("  -f <n>           FS memory allocation off/on (0/1) in join, default 0\n");
+	printf("  -d 0|1           Resource directory off/on in join, default 0\n");
+	printf("  -e 0|1           Exclusive create off/on in join, default 0\n");
+	printf("  -f 0|1           FS (filesystem) flag off/on in join, default 0\n");
 	printf("  -m <mode>        Permission mode for lockspace device (octal), default 0600\n");
-	printf("  -M               Print MSTCPY locks in lockdump\n"
-	       "                   (remote locks that are locally mastered)\n");
-	printf("  -s               Summary following lockdebug output\n");
-	printf("                   (experimental, format not fixed)\n");
+	printf("  -s               Summary following lockdebug output (experimental)\n");
 	printf("  -v               Verbose lockdebug output\n");
 	printf("  -w               Wide lockdebug output\n");
-	printf("  -h               Print this help, then exit\n");
+	printf("  -h               Print help, then exit\n");
 	printf("  -V               Print program version information, then exit\n");
 	printf("\n");
 }


More information about the cluster-commits mailing list