[Linux-cluster] gnbd - convert manpages to the man package
Bastian Blank
bastian at waldi.eu.org
Thu Feb 17 15:20:25 UTC 2005
Hi folks
I've converted the gnbd manpages to the man package.
Bastian
--
Vulcans worship peace above all.
-- McCoy, "Return to Tomorrow", stardate 4768.3
-------------- next part --------------
=== man/fence_gnbd.8
==================================================================
--- man/fence_gnbd.8 (revision 328)
+++ man/fence_gnbd.8 (local)
@@ -1,116 +1,87 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'fence_gnbd(8)''fence_gnbd(8)'
+.TH fence_gnbd 8
-\fBNAME\fP
-.in +7
+.SH NAME
fence_gnbd - I/O Fencing agent for GNBD-based GFS clusters
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBfence_gnbd -s\fP \fIclient_ip\fP \fB-t\fP \fIserver_ip\fP
+.SH SYNOPSIS
+.B fence_gnbd
+[\fIOPTION\fR]...
-.in
-.sp
-\fBDESCRIPTION\fP
-.in +7
+.SH DESCRIPTION
fence_gnbd is an I/O Fencing agent used when GFS is accessed through GNBD. It
uses the gnbd_import program and tells a GNBD server to ignore I/O from a
specified machine.
-.sp
+
fence_gnbd accepts options on the command line as well as from stdin.
fence_node sends the options through stdin when it execs the agent.
fence_gnbd can be run by itself with command line options which is useful
for testing.
-.sp
-.in
-\fBOPTIONS\fP
-.in
+
+.SH OPTIONS
+.TP
\fB-h\fP
-.in +7
Print out a help message describing available options, then exit.
-.sp
-.in
+.TP
\fB-m\fP
-.in +7
Selects multipath style fencing. With multipath style fencing, if fence_gnbd
cannot contact the kgnbd_portd process on the gnbd server node, it will fence
that server node. This is necessary to insure that there is no way for the
fenced client to access the storage through that server.
\fBWARNING:\fP Multipath style fencing must be used on a node if it is using
pool multipathing with GNBD devices.
-.in
+.TP
\fB-q\fP
-.in +7
quiet mode, no output.
-.sp
-.in
+.TP
\fB-s\fP \fInode\fP
-.in +7
gnbd client machine to fence.
-.sp
-.in
+.TP
\fB-t\fP \fInode\fP
-.in +7
server machine to fence the gnbd client from. If this option is
not given, the specified gnbd client node will be fenced from all gnbd server
nodes that have GNBDs imported by the machine running fence_gnbd.
Using the -t option is strongly recommended. The -t option may be used
multiple times to fence a client from multiple servers.
-.sp
-.in
+.TP
\fB-V\fP
-.in +7
Print out a version message, then exit.
-.sp
-.in
-.in -7
-\fBSTDIN PARAMETERS\fP
-.in +7
+.SH STDIN PARAMETERS
+.TP
\fIagent = < param >\fP
-.sp
This option is used by fence_node(8) and is ignored by fence_gnbd.
-.sp
-
+.TP
\fIipaddr = < clustername >\fP
-.sp
The cluster name of the node to be fenced (required) \fBNOTE:\fP This parameter
no longer allows the IP address of the node to be used. This parameter is
deprecated. Please use \fInodename\fP instead.
-.sp
+.TP
\fInodename = < clustername >\fP
-.sp
The cluster name of the node to be fenced (required)
-.sp
+.TP
\fIservers = < hostname [ hostname ... ] >\fP
-.sp
A whitespace seperated list of the servers to fence the client from, in
either IP address or hostname form.
-.sp
+.TP
\fIoption = multipath\fP
-.sp
Select multipath style fencing. \fBWARNING:\fP When multipath style fencing is
used, if the kgnbd_portd process of a gnbd server node cannot be contacted, it
is fenced as well, using its appropriate fencig method. This means that when
a client is fenced, any node listed as its server that does not have the
gnbd_serv module loaded (which starts kgnbd_portd) will also be fenced.
-.sp
+.TP
\fIretrys = < param >\fP
-.sp
Number of times to retry connecting to the server after a failed attempt,
before the server is fenced. This parameter is only valid when used
with multipath style fencing (see above). The default is 3.
-.sp
+.TP
\fIwait_time = < param >\fP
-.sp
length of time, in seconds, to wait between retrys. This parameter
is only valid when used with multipath sytle fencing (see above). The default
is 2.
-.sp
-.in -7
-\fBSEE ALSO\fP
-.in +7
+
+.SH SEE ALSO
fence(8), fenced(8), gnbd_import(8)
=== man/gnbd.8
==================================================================
--- man/gnbd.8 (revision 328)
+++ man/gnbd.8 (local)
@@ -1,21 +1,15 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'GNBD(8)''GNBD(8)'
-'\" View with 'groff -t -e -mandoc -Tlatin1 gnbd.8 | less'
+.TH gnbd 8
-\fBNAME\fP
-.in +7
+.SH NAME
GNBD reference guide
-.in
-\fBSYNOPSIS\fP
-.in +7
+.SH SYNOPSIS
Overview of manpages and their locations
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
+
+.SH DESCRIPTION
The GFS Network Block Device has two parts, the client (which includes the
\fBgnbd.ko\fP module and \fBgnbd_import\fP, \fBgnbd_recvd\fP, and
\fBgnbd_monitor\fP programs) and the server
@@ -27,17 +21,23 @@
device distributed with the Linux kernel) is GNBD's ability to have multiple
clients all accessing the same served file or block device at the same
time.
-.sp
+
The GNBD documentation has been split into a number of sections. Please
refer to the table below to determine which man page coincides with the
command/feature you are looking for.
-.sp
- \fBgnbd\fP GNBD overview (this man page)
- \fBgnbd_import\fP Configure a GNBD Client
- \fBgnbd_export\fP Configure a GNBD Server
- \fBfence_gnbd\fP Fence method for GNBD
-.sp
-.in
-\fBSEE ALSO\fP
-.in +7
+
+.TP 16
+gnbd
+GNBD overview (this man page)
+.TP
+gnbd_import
+Configure a GNBD Client
+.TP
+gnbd_export
+Configure a GNBD Server
+.TP
+fence_gnbd
+Fence method for GNBD
+
+.SH SEE ALSO
gfs(8), fence(8), fence_gnbd(8)
=== man/gnbd_export.8
==================================================================
--- man/gnbd_export.8 (revision 328)
+++ man/gnbd_export.8 (local)
@@ -1,37 +1,29 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gnbd_export(8)''gnbd_export(8)'
+.TH gnbd_export 8
-\fBNAME\fP
-.in +7
+.SH NAME
gnbd_export - the interface to export GNBDs
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBgnbd_export\fP [options]
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
+.SH SYNOPSIS
+.B gnbd_export
+[\fIOPTION\fR]...
+
+.SH DESCRIPTION
gnbd_export exports local block devices or files as GNBDs.
-.sp
-.in
-\fBOPTIONS\fP
-.in +7
+
+.SH OPTIONS
+.TP
\fB-a\fP
-.in +7
Validate.
-.sp
+
This option forces all server processes to send a ping message to the clients
they are connected to. This forces servers with faulty connections to quit.
-.sp
-.in
+.TP
\fB-c\fP
-.in +7
Enable caching.
-.sp
+
Reads from the exported GNBD will take advantage of the linux page cache.
This option is used with \fB-e\fP. \fBNOTE:\fP If this option is not specified,
gnbd will run with a noticeable performance decrease. Also, if this option
@@ -50,48 +42,38 @@
the \fB-c\fP option can also be used locally, but you must access the device
directly. You MUST NOT use gnbd_import to import devices exported from the
same machine.
-.sp
-.in
+.TP
\fB-d\fI pathname\fR
-.in +7
Device.
-.sp
+
Specify the device to export as a GNBD. This option is used with \fB-e\fP.
\fIpathname\fR may be either a block device or a regular file. Usually block
devices are used, because this increases GNBD performance.
-.sp
-.in
+.TP
\fB-e\fI gnbdname\fR
-.in +7
Export.
-.sp
+
Export a device as a GNBD with the Device name \fIgnbdname\fR. You must also
specify the pathname of the device with the \fB-d\fP option. Once a GNBD
has been exported, clients can import it with \fBgnbd_import\fP.
-.sp
-.in
+.TP
\fB-h\fP
-.in +7
Help.
-.sp
+
Print the usage information.
-.sp
-.in
+.TP
\fB-l\fP
-.in +7
List.
-.sp
+
List all exported GNBDs and kgnbd_portd server information. The listing
contains each server's number (which is only for internal use), its Device
name, the pathname of the device that is being exported, it's size in
512 byte sectors, and information on whether or not it is cached, and if not,
what it's timeout is.
-.sp
-.in
+.TP
\fB-O\fP
-.in +7
Override
-.sp
+
This option allows you to unexport gnbd devices, even if they are still in
use. When an agent other than fence_gnbd is used to fence gnbd client nodes,
occasionally gnbd server threads are not correctly cleaned up. This causes
@@ -99,40 +81,30 @@
In this case, using the \fB-O\fP option with either \fB-r\fP or \fB-R\fP will
allow you to unexport the GNBD devices. \fBWARNING:\fP Make sure
that no clients have the GNBD imported before using this option.
-.sp
-.in
+.TP
\fB-o\fP
-.in +7
Readonly
-.sp
+
export the server in readonly mode.
-.sp
-.in
+.TP
\fB-q\fP
-.in +7
Quiet.
-.sp
+
Only prints out error messages.
-.sp
-.in
+.TP
\fB-R\fP
-.in +7
Remove All.
-.sp
+
Remove all exported GNBDs.
-.sp
-.in
+.TP
\fB-r\fP [\fIGNBD(s)\fR]
-.in +7
Remove.
-.sp
+
Remove named GNBD(s).
-.sp
-.in
+.TP
\fB-t\fP [\fIseconds\fR]
-.in +7
Timeout.
-.sp
+
Set the exported GNBD to timeout mode This option is used with \fB-p\fP.
This is the default for uncached GNBDs. For cached GNBDs, the default is wait
mode (For GFS versions up through 5.2, all GNBDs were in wait mode). In wait
@@ -144,25 +116,18 @@
pending and future requests as failures until the imported GNBD is closed. The
default timeout period is 60 seconds. Timeout mode is necessary for failover to
work with dm multipathing over gnbd.
-.sp
-.in
+.TP
\fB-v\fP
-.in +7
Verbose.
-.sp
+
Increase the verbosity of the output. This option is the most useful with
\fB-l\fP. If it is used along with \fB-l\fP, an extended list of information
on each exported device will be printed.
-.sp
-.in
+.TP
\fB-V\fP
-.in +7
Version information.
-.sp
+
Print out version information.
-.sp
-.in
-.in -7
-\fBSEE ALSO\fP
-.in +7
+
+.SH SEE ALSO
gnbd_import(8), gnbd(8)
=== man/gnbd_import.8
==================================================================
--- man/gnbd_import.8 (revision 328)
+++ man/gnbd_import.8 (local)
@@ -1,78 +1,61 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gnbd_import(8)''gnbd_import(8)'
+.TH gnbd_import 8
-\fBNAME\fP
-.in +7
+.SH NAME
gnbd_import - manipulate GNBD block devices on a client
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBgnbd_import\fP [options]
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
-gnbd_import imports, lists, and removes GNBDs from the system. GNBD is simila
- to
+.SH SYNOPSIS
+.B gnbd_import
+[\fIOPTION\fR]...
+
+.SH DESCRIPTION
+gnbd_import imports, lists, and removes GNBDs from the system. GNBD is similar to
the Network Block Device (nbd) in the Linux kernel, except that it allows
multiple clients to connect at once and has a built-in fence command.
-.sp
-.in
-\fBOPTIONS\fP
-.in +7
+
+.SH OPTIONS
+.TP
\fB-a\fP
-.in +7
Validate.
-.sp
+
Restart failed gnbd_recvd processes. Usually, if a gnbd becomes
disconnected, the \fBgnbd_recvd\fP process for that device will automatically
try to reconnect. If that process is killed, \fBgnbd_import -a\fP will
restart it.
-.sp
-.in
+.TP
\fB-c \fIserver\fR
-.in +7
Check fenced.
-.sp
+
List all the IP addresses currently IO fenced from the specified \fIserver\fR.
If the sepecified server does not have any IP addresses fenced, nothing will
be returned. If the server machine is not running gnbd_serv, an error will
be returned.
-.sp
-.in
+.TP
\fB-e \fIserver\fR
-.in +7
List exported.
-.sp
+
List GNBDs exported by the specified \fIserver\fR, along with the port at
which they can be accessed. If the specified server is not exporting any GNBDs,
nothing will be returned. If the server machine is not running gnbd_serv, an
error will be returned.
-.sp
-.in
+.TP
\fB-h\fP
-.in +7
Help.
-.sp
+
Print the usage information.
-.sp
-.in
+.TP
\fB-i \fIserver\fR
-.in +7
Import.
-.sp
+
Import all GNBDs which the specified \fIserver\fR has exported. This will not
allow a GNBD to be imported if another one with the same name has already been
imported.
-.sp
-.in
+.TP
\fB-l\fP
-.in +7
List.
-.sp
+
List all imported GNBDs. If no options are specified, this is the default
action. There are eight fields for each device: Device name, Minor #,
Proc name, Server, Port, State, Readonly and Sectors. The Device name is the
@@ -94,59 +77,47 @@
to the server, but which haven't been completed yet. Readonly tells whether
the gnbd server exported this device as readonly. Sectors is the device size
in 512 bytes sectors.
-.sp
-.in
+.TP
\fB-O\fP
-.in +7
Override
-.sp
+
This makes gnbd_import run in non-interactive mode. It will no longer prompt
the user before attempting unsafe actions. It is recommended that you do
not use this option.
-.sp
-.in
+.TP
\fB-p\fP
-.in +7
Port.
-.sp
+
Change the port to connect to on the server. This option is used with
\fB-c\fP, \fB-e\fP and \fB-i\fP. If the port option is not set, gnbd_import
will try to connect to port 14567 on the server machine to find the gnbd_serv
daemon. You should only need to use this if you have changed the gnbd_serv
port from its default.
-.sp
-.in
+.TP
\fB-q\fP
-.in +7
Quiet mode.
-.sp
+
Only print out errors or questions.
-.sp
-.in
+.TP
\fB-R\fP
-.in +7
Remove All.
-.sp
+
Remove all of the imported GNBDs from the system. Only GNBDs that are in the
\fBClosed Disconnected Clear\fP state can be removed (See the \fB-l\fP
option), unless \fB-O\fP is used. Remove All stops after the first failed
remove.
-.sp
-.in
+.TP
\fB-r\fP [\fIGNBD\fR | \fILIST\fR]
-.in +7
Remove.
-.sp
+
Remove named GNBD(s) from system. Only GNBDs that are in the \fBClosed
Disconnected Clear\fP state can be removed (See the \fB-l\fP option), unless
the \fB-O\fP option is used.
Remove stops after the first failed remove.
-.sp
-.in
+.TP
\fB-s\fP \fIhost\fR
-.in +7
Fence.
-.sp
+
IO fence the specified host. This command is generally invoked by \fBfenced\fP.
\fBWARNING\fP It is
not always possible to seamlessly reconnect a client that has had its
@@ -154,45 +125,33 @@
what you are doing. See the \fB-t\fP option for more information. Once a host
is fenced from a server, it will not be able to access any GNBDs on that server
until it is unfenced (see the \fB-u\fP option).
-.sp
-.in
+.TP
\fB-t\fP \fIserver\fR
-.in +7
Fence from Server.
-.sp
+
Specify a server for the IO fence (only used with the \fB-s\fP option).
-.sp
-.in
+.TP
\fB-u\fP \fIhost\fR
-.in +7
Unfence.
-.sp
+
Unfence the specified host. \fBWARNING\fP: Unfencing a client at the incorrect
time can result in data corruption. In normal operation, it should never be
necessary to run this comman. See the \fB-t\fP option.
-.sp
-.in
+.TP
\fB-V\fP
-.in +7
Version information.
-.sp
+
Print out version information.
-.sp
-.in
+.TP
\fB-v\fP
-.in +7
Verbose output.
-.sp
+
Print additional messages during the operation of gnbd_import.
-.sp
-.in -14
-\fBSEE ALSO\fP
-.in +7
+
+.SH SEE ALSO
gnbd_export(8)
-.sp
-.in
-\fBBUGS\fP
-.in +7
+
+.SH BUGS
A computer should not import a GNBD device that it exports. Any
significant amount of IO on that device will cause a kernel deadlock. This is
a problem common to most NBDs. Instead, the underlying device should be
-------------- 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/d386b4ec/attachment.sig>
More information about the Linux-cluster
mailing list