[Linux-cluster] gfs - convert manpages to the man package
Bastian Blank
bastian at waldi.eu.org
Thu Feb 17 14:00:55 UTC 2005
Hi folks
I've converted the gfs manpages to the man package.
Bastian
--
Vulcans worship peace above all.
-- McCoy, "Return to Tomorrow", stardate 4768.3
-------------- next part --------------
=== man/ccs.7
==================================================================
--- man/ccs.7 (revision 321)
+++ man/ccs.7 (local)
@@ -4,16 +4,12 @@
.\" modify, copy, or redistribute it subject to the terms and conditions
.\" of the GNU General Public License v.2.
-.tl 'ccs(7)''ccs(7)'
-'\" View with 'groff -t -e -mandoc -Tlatin1 ccs.7 | less'
+.TH ccs 7
-\fBNAME\fP
-.in +7
+.SH NAME
ccs - Cluster Configuration System
-.in
-\fBDESCRIPTION\fP
-.in +7
+.SH DESCRIPTION
A cluster environment that shares resources has information that is
essential to correct operation which must be available to
every node in the cluster. This information may include:
@@ -21,31 +17,24 @@
more. \fICCS\fP is the system that makes it possible for the nodes in a
cluster to retrieve the information they need.
-.sp
-.in
-\fBOVERVIEW\fP
-.in +7
+.SH OVERVIEW
The following is a generic description of the steps one should take to produce
a working CCS environment.
-\fBStep 1)\fP
-.sp
+.SS Step 1
Choose a cluster name. It is important to determine
a name for the cluster before starting. The cluster name is what
binds a machine to specific resources that can only be shared by
machines that are members of the same cluster name.
-\fBStep 2)\fP
-.sp
+.SS Step 2
Create the directory \fI/etc/cluster\fP.
-\fBStep 3)\fP
-.sp
+.SS Step 3
Create the \fI/etc/cluster/cluster.conf\fP file, according to the
\fBcluster.conf(5)\fP man page, on one node in your cluster.
-\fBStep 4)\fP
-.sp
+.SS Step 4
Start \fBccsd\fP and test the cluster.conf file by using \fBccs_test\fP.
If you haven't started a cluster manager yet, you should use the 'force'
option to \fBccs_test\fP - see the \fBccs_test(8)\fP man page for more info.
@@ -53,16 +42,9 @@
If a failure occurs while parsing the config file, \fBccs_test\fP should
report "ccs_connect failed: No data available" and /var/log/messages
should report "Unable to parse /etc/cluster/cluster.conf".
-.sp
-.in
-\fBFORMAT OF THE CCS FILE\fP
-.in +7
-.sp
+.SH FORMAT OF THE CCS FILE
See \fBcluster.conf(5)\fP
-.sp
-.in
-\fBSEE ALSO\fP
-.in +7
+.SH SEE ALSO
ccsd(8), ccs_tool(8), ccs_test(8), cluster.conf(5)
=== man/ccs_test.8
==================================================================
--- man/ccs_test.8 (revision 321)
+++ man/ccs_test.8 (local)
@@ -4,33 +4,24 @@
.\" modify, copy, or redistribute it subject to the terms and conditions
.\" of the GNU General Public License v.2.
-.tl 'ccs_test(8)''ccs_test(8)'
-'\" View with 'groff -t -e -mandoc -Tlatin1 ccs_test.8 | less'
+.TH ccs_test 8
-\fBNAME\fP
-.in +7
+.SH NAME
ccs_test - The diagnostic tool for a running Cluster Configuration System.
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBccs_test\fP <\fBcommand\fP>
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
+.SH SYNOPSIS
+.B ccs_test
+<\fBcommand\fP>
+
+.SH DESCRIPTION
\fBccs_test\fP is part of the Cluster Configuration System (CCS). It
is a diagnostic tool designed to validate the correct operation of a
running CCS system. It will communicate with the CCS daemon - \fBccsd\fP -
to obtain any information stored in the system.
-.sp
-.in
-
-\fBCOMMANDS\fP
-.in +7
+.SH COMMANDS
+.TP
\fBconnect\fP \fI[force]\fP \fI[block]\fP \fI[cluster name]\fP
-.in +7
This command creates a connection to ccsd. It returns a descriptor, which
is used as an parameter to other commands.
@@ -44,10 +35,8 @@
only configuration files containing the given cluster name are valid
possibilities.
-.sp
-.in
+.TP
\fBget\fP \fI<desc>\fP \fI<request>\fP
-.in +7
Get the results of a given request. The 'desc' is the number returned
from the \fBconnect\fP command. The 'request' is a valid Xpath request.
@@ -55,89 +44,73 @@
Subsequent calls with the same 'request' will result in the subsequent
matches. Once all the matches have been returned, a subsequent call
will begin again with the first result.
-.sp
-.in
+.TP
\fBget_list\fP \fI<desc>\fP \fI<request>\fP
-.in +7
Similar to the \fBget\fP command. However, issuing subsequent calls
with the same 'request' will result in all matches being returned (one
at a time), then null, then starting over with the first result.
-.sp
-.in
+.TP
\fBset\fP \fI<desc>\fP \fI<path>\fP \fI<value>\fP
-.in +7
Sets a particular 'path' to the given 'value'. Not yet implemented.
-.sp
-.in
+.TP
\fBget_state\fP \fI<desc>\fP
-.in +7
Get the state associated with a given connection.
-.sp
-.in
+.TP
\fBset_state\fP \fI<desc>\fP \fI<ncwp>\fP
-.in +7
Set the current working path (cwp) to 'ncwp' for a given connection.
-.sp
-.in
-.in -7
-\fBEXAMPLES\fP
-.in +7
-\fBTo connect to ccsd:\fP
-.sp
+.SH EXAMPLES
+.SS To connect to ccsd:
+
> ccs_test connect
Connect successful.
Connection descriptor = 0
-.sp
+
Or, if the cluster is not yet quorate and the name of the cluster is 'mycluster':
-.sp
+
> ccs_test connect force block mycluster
Connect successful.
Connection descriptor = 0
-.sp
-\fBTo get the cluster name from ccsd:\fP
-.sp
+.SS To get the cluster name from ccsd:
+
> ccs_test get 0 //cluster/@name
Get successful.
Value = <mycluster>
-.sp
-\fBTo get the connection state:\fP
-.sp
+.SS To get the connection state:
+
> ccs_test get_state 0
Get state successful.
Current working path:
Previous query : //cluster/@name
-.sp
-\fBTo set the connection state:\fP
-.sp
+
+.SS To set the connection state:
+
> ccs_test set_state 0 //cluster
Set state successful.
-.sp
-\fBAfter setting the connection state, note the change:\fP
-.sp
+
+.SS After setting the connection state, note the change:
+
> ccs_test get_state 0
Get state successful.
Current working path: //cluster
Previous query : //cluster/@name
-.sp
-\fBAfter setting the connection state, you can now query with an absolute
-or relative path:\fP
-.sp
+.SS After setting the connection state, you can now query with an absolute or relative path:
+
> ccs_test get 0 @name
Get successful.
@@ -147,16 +120,12 @@
Get successful.
Value = <brassow>
-.sp
-\fBTo disconnect:\fP
-.sp
+.SS To disconnect:
+
> ccs_test disconnect 0
Disconnect successful.
-.sp
-.in -7
-\fBSEE ALSO\fP
-.in +7
+.SH SEE ALSO
ccs(7), ccsd(8), cluster.conf(5)
=== man/ccs_tool.8
==================================================================
--- man/ccs_tool.8 (revision 321)
+++ man/ccs_tool.8 (local)
@@ -4,48 +4,32 @@
.\" modify, copy, or redistribute it subject to the terms and conditions
.\" of the GNU General Public License v.2.
-.tl 'ccs_tool(8)''ccs_tool(8)'
-'\" View with 'groff -t -e -mandoc -Tlatin1 ccs_tool.8 | less'
+.TH ccs_tool 8
-\fBNAME\fP
-.in +7
+.SH NAME
ccs_tool - The tool used to make online updates of CCS config files.
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBccs_tool\fP [\fBoptions\fP] <\fBcommand\fP>
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
+.SH SYNOPSIS
+.B ccs_tool
+[\fIOPTION\fR].. <\fBcommand\fP>
+
+.SH DESCRIPTION
\fBccs_tool\fP is part of the Cluster Configuration System (CCS). It
is used to make online updates of CCS config files. Additionally, it
can be used to upgrade old style (GFS <= 6.0) CCS archives to the new
xml format.
-.sp
-.in
-\fBOPTIONS\fP
-.in +7
-
+.SH OPTIONS
+.TP
\fB-h\fP
-.in +7
Help. Print out the usage.
-.sp
-.in
-
+.TP
\fB-V\fP
-.in +7
Print the version information.
-.sp
-.in
-.in -7
-\fBCOMMANDS\fP
-.in +7
+.SH COMMANDS
+.TP
\fBupdate\fP \fI<xml file>\fP
-.in +7
This command is used to update the config file that ccsd is working with
while the cluster is operational (i.e. online). Run this on a single
machine to update all instances of ccsd across the cluster.
@@ -55,20 +39,12 @@
complete. Failure to do so will result in new nodes (or nodes rejoining
after a failure) not being allowed
to join the working set due to version number mismatches.
-
-.sp
-.in
+.TP
\fBupgrade\fP \fI<location>\fP
-.in +7
This command is used to upgrade an old CCS format archive to the new
xml format. \fI<location>\fP is the location of the old archive,
which can be either a block device archive or a file archive. The
converted configuration will be printed to stdout.
-.sp
-.in
-
-.in -7
-\fBSEE ALSO\fP
-.in +7
+.SH SEE ALSO
ccs(7), ccsd(8), cluster.conf(5)
=== man/ccsd.8
==================================================================
--- man/ccsd.8 (revision 321)
+++ man/ccsd.8 (local)
@@ -5,67 +5,42 @@
.\" modify, copy, or redistribute it subject to the terms and conditions
.\" of the GNU General Public License v.2.
-.tl 'ccsd(8)''ccsd(8)'
-'\" View with 'groff -t -e -mandoc -Tlatin1 ccsd.8 | less'
+.TH ccsd 8
-\fBNAME\fP
-.in +7
+.SH NAME
ccsd - The daemon used to access CCS cluster configuration files.
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBccsd\fP [\fBoptions\fP]
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
+.SH SYNOPSIS
+.B ccsd
+[\fIOPTION\fR]..
+
+.SH DESCRIPTION
\fBccsd\fP is part of the Cluster Configuration System (CCS). It is the
daemon which accesses cluster the configuration file for other cluster
applications. It must be run on each node that wishes to join a cluster.
-.sp
-.in
-
-\fBOPTIONS\fP
-.in +7
-
+.SH OPTIONS
+.TP
\fB-4\fP
-.in +7
Use IPv4 for all communication. By default, IPv6 is tried, then IPv4.
-.sp
-.in
-
+.TP
\fB-6\fP
-.in +7
Use IPv6 for all communication. By default, IPv6 is tried, then IPv4.
-.sp
-.in
-
+.TP
\fB-h\fP
-.in +7
Help. Print out the usage syntax.
-.sp
-.in
-
+.TP
\fB-m <multicast address>\fP
-.in +7
Used to specify the multicast address. The keyword "default" can be used,
in which case "ff02::3:1" is used for IPv6 and "224.0.2.5" is used for IPv4.
If you are using IPv4, the default action is to use broadcast. Specifying
this option will cause multicast to be used in that instance.
-.sp
-.in
-
+.TP
\fB-n\fP
-.in +7
No daemon. Run in the foreground.
-.sp
-.in
-
+.TP
\fB-P <port identifier>:<port number>\fP
-.in +7
You have the option of specifying the port numbers used by ccsd. The port
identifier is either: b, c, or f. "b" is the port which ccsd attempts to
communicate with ccsd processes on other machines, via broadcast/multicast, to
@@ -76,22 +51,12 @@
from the CCS library (or programs using it). This is known as the frontend port.
So, to change the frontend port one might specify \fI-P f:60000\fP.
-.sp
-.in
-
+.TP
\fB-t <ttl>\fP
-.in +7
Set the multicast threshold (aka time to live).
-.sp
-.in
-
+.TP
\fB-V\fP
-.in +7
Print the version information.
-.sp
-.in
-.in -7
-\fBSEE ALSO\fP
-.in +7
+.SH SEE ALSO
ccs(7), ccs_tool(8), ccs_test(8), cluster.conf(5)
=== man/cluster.conf.5
==================================================================
--- man/cluster.conf.5 (revision 321)
+++ man/cluster.conf.5 (local)
@@ -2,19 +2,12 @@
.\" Copyright 2001-2003 Sistina Software, Inc.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.\" groff -t -e -mandoc -Tlatin1 cluster.conf.5 | less
+.TH cluster.conf 5
-.tl 'cluster.conf(5)' 'cluster.conf(5)'
-
-\fBNAME\fP
-.in +7
+.SH NAME
cluster.conf - The configuration file for cluster products
-.sp
-.in -7
-
-\fBDESCRIPTION\fP
-.in +7
+.SH DESCRIPTION
The \fBcluster.conf\fP file is located in the /etc/cluster directory. It
is the source of information used by the cluster products - accessed
indirectly through CCS (see \fBccs(7)\fP). This file contains all the
@@ -186,10 +179,6 @@
</fencedevices>
</cluster>
-
-.sp
-.in -7
-\fBSEE ALSO\fP
-.in +7
+.SH SEE ALSO
ccs(7), ccs_tool(8), lock_gulmd(5), cman(5)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 197 bytes
Desc: Digital signature
URL: <http://listman.redhat.com/archives/linux-cluster/attachments/20050217/2023b6ed/attachment.sig>
More information about the Linux-cluster
mailing list