--- gulm_tool.8-orig 2006-12-21 20:35:02.000000000 -0500 +++ gulm_tool.8 2006-12-21 20:35:12.000000000 -0500 @@ -1,25 +1,20 @@ .\" .\" Copyright 2001-2003 Sistina Software, Inc. .\" Copyright (C) 2004 Red Hat, Inc. All rights reserved. - - -.\" groff -t -e -mandoc -Tlatin1 gulm_tool.8 | less - -.tl 'gulm_tool(8)' 'gulm_tool(8)' - -\fBNAME\fP -.in +7 +.\" +.\" t +.TH gulm_tool 8 +.SH NAME gulm_tool - Interface to Grand Unified Lock Manager -.sp -.in -7 -\fBSYNOPSIS\fP -.in +7 -\fBgulm_tool\fP command [options] -.sp -.in -7 -\fBDESCRIPTION\fP -.in +7 +.SH SYNOPSIS +.B gulm_tool +.IR command +[ +.I options +] + +.SH DESCRIPTION \fBgulm_tool\fP is an interface to a variety of options available to running \fBlock_gulmd\fP servers. @@ -32,69 +27,44 @@ different ports for the \fBlock_gulmd\fP servers, you will need to use the numbers. If you don't specify the port, "core" is assumed. -.sp -.in -7 - -\fBCOMMANDS\fP -.in +7 - -.\"====================================== -\fBCommands that only core understands\fP -.in +7 +.SH COMMANDS +.SS Commands that only core understands +.TP \fBshutdown\fP \fIserver\fR:core -.in +7 -This command is use to stop a gulm server cleanly. This can only be sent +This command is used to stop a gulm server cleanly. This can only be sent to the "core" port. - +.sp The use of this command is the proper way to shutdown gulm servers. It is preferred over the use of SIGTERM. Any other method will result in a fencing action against the server node. -.sp -.in -7 - +.TP \fBnodelist\fP \fIserver\fR:core -.in +7 Get a list of the nodes currently logged into the master server. -.in -7 - +.TP \fBnodeinfo\fP \fIserver\fR:core \fInode name\fR -.in +7 Get information for a single node. -.in -7 - +.TP \fBservicelist\fP \fIserver\fR:core -.in +7 Get list of services connected to this node. -.in -7 - -\fBforeceexpire\fP \fIserver\fR:core \fInode name\fR -.in +7 +.TP +\fBforeceexpire\fR \fIserver\fR:core \fInode name\fR Force the node to move into the Expired State. This will cause the node to be fenced. -.in -7 - - -.in -7 -.\"====================================== -\fBCommands that can be sent to any server\fP -.in +7 +.SS Commands that can be sent to any server +.TP \fBgetstats\fP \fIserver:port\fR -.in +7 This gets a list of whatever statistics the specified server carries. -.sp -.in -7 - +.TP \fBsetverb\fP \fIserver:port\fR \fIverbose_flags\fR -.in +7 Sets which types of messages can be logged. - +.sp \fIverbose flags\fR is a comma separated list of the possible flags. If a flag is prefixed with a '-', it is unset, other wise it is set. The special flag 'clear' unsets all verbosity flags. Any flag that is not recognized is ignored. - +.P The verbosity flags for gulm: .TS @@ -136,36 +106,22 @@ same as -v "ReallyAll,-Network3,-LockUpdates" T} .TE - +.PP Since Network3, and LockUpdates are so verbose, and rarely needed, they are excluded from the 'All' flag. - +.PP Do not use ReallyAll unless you are willing to deal with 100M and larger log files. A loaded system can produce up to a megabyte a minute with the ReallyAll flag. -.sp -.in -7 - -.in -7 -.\"====================================== -\fBCommands that only gulm_tool understands\fP -.in +7 - +.SS Commands that only \fBgulm_tool\fP understands +.TP \fBversion\fP or \fB-V\fP -.in +7 Print out the version information of this program. -.in -7 - +.TP \fB--help\fP or \fB-h\fP -.in +7 Print out the commands with brief descriptions. -.in -7 - -.in -7 -.in -7 -\fBSEE ALSO\fP -.in +7 -lock_gulmd(8) +.SH SEE ALSO +.BR lock_gulmd (8)