[Cluster-devel] cluster/magma/man magma_tool.8
lhh at sourceware.org
lhh at sourceware.org
Fri Jan 26 22:18:27 UTC 2007
CVSROOT: /cvs/cluster
Module name: cluster
Branch: RHEL4
Changes by: lhh at sourceware.org 2007-01-26 22:18:23
Modified files:
magma/man : magma_tool.8
Log message:
Fix markup for magma_tool man page; fix from Eric S. Raymond
Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/cluster/magma/man/magma_tool.8.diff?cvsroot=cluster&only_with_tag=RHEL4&r1=1.1.2.1&r2=1.1.2.2
--- cluster/magma/man/Attic/magma_tool.8 2005/01/28 19:36:18 1.1.2.1
+++ cluster/magma/man/Attic/magma_tool.8 2007/01/26 22:18:13 1.1.2.2
@@ -3,166 +3,96 @@
.\" This copyrighted material is made available to anyone wishing to use,
.\" modify, copy, or redistribute it subject to the terms and conditions
.\" of the GNU General Public License v.2.
-
-.tl 'magma_tool(8)''magma_tool(8)'
-'\" View with 'groff -t -e -mandoc -Tlatin1 ccs_tool.8 | less'
-
-\fBNAME\fP
-.in +7
+.TH magma_tool 8
+.SH NAME
magma_tool - Magma API test program
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBmagma_tool\fP <\fBcommand\fP>
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
+.SH SYNOPSIS\fP
+\fBmagma_tool\fP \fIcommand\fP
+
+.SH DESCRIPTION\fP
\fBmagma_tool\fP is part of the Magma cluster API abstraction library.
Its primary purpose is for API debugging and tweaking; it does not control
anything and has no configuration information to speak of.
-.sp
-.in
-\fBOPTIONS\fP
-.in +7
+.SH OPTIONS
+.TP
\fB-h\fP
-.in +7
Help. Print out the usage.
-.sp
-.in
-.in -7
-\fBPLUGIN COMMANDS\fP
-.in +7
+.SH PLUGIN COMMANDS
+.TP
\fBlist\fP
-.in +7
This command is used to list plugins and other files in Magma's plugin
directory and whether or not they are legal plugins. This will list all
non-directory files in Magma's plugin directory, whether or not they are
legal plugins, and why.
-
-.sp
-.in
+.TP
\fBenable\fP \fI<filename>\fP
-.in +7
This command is used to enable a plugin in Magma's plugin directory.
It is synonymous with "chmod u+r <filename>". Files without in the
plugin directory without the user-readable bit set (S_IRUSR) are ignored.
-
-.sp
-.in
+.TP
\fBdisable\fP \fI<filename>\fP
-.in +7
This command is used to disable a plugin in Magma's plugin directory.
It is synonymous with "chmod u+r <filename>". Files without in the
plugin directory without the user-readable bit set (S_IRUSR) are ignored.
-.sp
-.in
-
-.in -7
-\fBAPI TEST COMMANDS\fP
-.in +7
+.SH API TEST COMMANDS\fP
These commands may all be preceded by the option \fIlogin\fP. If specified,
magma_tool will log in to the service/node group on cluster infrastructures
where this notion is supported.
-
-.sp
+.TP
\fBlock\fP \fI[resource]\fP
-.in +7
This causes magma_tool to connect to the underlying cluster infrastructure
and/or lock manager and acquire a clusterlock. If \fI[resource]\fP is not
specified, then the name "Something" is used.
-
-.sp
-.in
+.TP
\fBlisten\fP \fI[group]\fP
-.in +7
This causes magma_tool to connect to the underlying cluster infrastructure
and/or lock manager and listen for events in the group \fI[group]\fP. This
is only useful with the \fIlogin\fP flag.
-
-.sp
-.in
+.TP
\fBlocalname\fP \fI[group]\fP
-.in +7
This causes magma_tool to connect to the underlying cluster infrastructure
and/or lock manager and request the local node name, which it then displays.
-
-.sp
-.in
+.TP
\fBlocalid\fP \fI[group]\fP
-.in +7
This causes magma_tool to connect to the underlying cluster infrastructure
and/or lock manager and request the local node ID, which it then displays.
-
-.sp
-.in
+.TP
\fBmembers\fP \fI[group]\fP
-.in +7
This causes magma_tool to connect to the underlying cluster infrastructure
and/or lock manager and request the list of members, which it then displays.
If \fI[group]\fP is specified, then only the members of the given service
or node group are listed.
-
-.sp
-.in
+.TP
\fBquorum\fP \fI[group]\fP
-.in +7
This causes magma_tool to connect to the underlying cluster infrastructure
and/or lock manager and request the local node's quorum status as well as
whether or not it is a member of \fI[group]\fP.
-
-
-.sp
-.in
+.TP
\fBconfig\fP \fI<item>\fP
-.in +7
This displays compile-time information; see below.
-.sp
-.in
-
-.in -7
-\fBCONFIGURATION\fP
-.in +7
+.SH CONFIGURATION
+.TP
\fBconfig cflags\fP
-.in +7
Displays the compiler flags needed to build applications against Magma.
-
-.sp
-.in
+.TP
\fBconfig libs\fP
-.in +7
Displays the compiler linker flags needed to build applications against
Magma.
-
-.sp
-.in
+.TP
\fBconfig libs-nt\fP
-.in +7
Displays the compiler linker flags needed to build applications against
-Magma's lightweight, mostly-reentrant library..
-
-.sp
-.in
+Magma's lightweight, mostly-reentrant library.
+.TP
\fBconfig plugindir\fP
-.in +7
Displays directory Magma uses for plugins.
-
-.sp
-.in
+.TP
\fBconfig libdir\fP
-.in +7
Displays where Magma's dynamic libraries reside.
-
-.sp
-.in
+.TP
\fBconfig slibdir\fP
-.in +7
Displays where Magma's static libraries reside.
-
-.sp
-.in
More information about the Cluster-devel
mailing list