[Linux-cluster] gfs - convert manpages to the man package
Bastian Blank
bastian at waldi.eu.org
Thu Feb 17 14:08:55 UTC 2005
On Thu, Feb 17, 2005 at 03:00:55PM +0100, Bastian Blank wrote:
> I've converted the gfs manpages to the man package.
I attached the wrong diff.
Bastian
--
Vulcans do not approve of violence.
-- Spock, "Journey to Babel", stardate 3842.4
-------------- next part --------------
=== man/gfs.8
==================================================================
--- man/gfs.8 (revision 310)
+++ man/gfs.8 (local)
@@ -1,32 +1,40 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gfs(8)''gfs(8)'
+.TH gfs 8
-\fBNAME\fP
-.in +7
+.SH NAME
GFS 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 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
- gfs GFS overview (this man page)
- gfs_mount Mounting a GFS file system
- gfs_fsck The GFS file system checker
- gfs_grow Growing a GFS file system
- gfs_jadd Adding a journal to a GFS file system
- gfs_mkfs Make a GFS file system
- gfs_quota Manipulate GFS disk quotas
- gfs_tool Tool to manipulate a GFS file system
-.sp
-.in
+.TP 16
+gfs
+GFS overview (this man page)
+.TP
+gfs_mount
+Mounting a GFS file system
+.TP
+gfs_fsck
+The GFS file system checker
+.TP
+gfs_grow
+Growing a GFS file system
+.TP
+gfs_jadd
+Adding a journal to a GFS file system
+.TP
+gfs_mkfs
+Make a GFS file system
+.TP
+gfs_quota
+Manipulate GFS disk quotas
+.TP
+gfs_tool
+Tool to manipulate a GFS file system
=== man/gfs_fsck.8
==================================================================
--- man/gfs_fsck.8 (revision 310)
+++ man/gfs_fsck.8 (local)
@@ -1,26 +1,20 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gfs_fsck(8)''gfs_fsck(8)'
+.TH gfs_fsck 8
-\fBNAME\fP
-.in +7
+.SH NAME
gfs_fsck - Offline GFS file system checker
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBgfs_fsck\fP [\fBoptions\fP] \fIdevice\fR
-.sp
-.in
-\fBWARNING\fP
-.in +7
+.SH SYNOPSIS
+.B gfs_fsck
+[\fIOPTION\fR]... \fIDEVICE\fR
+
+.SH WARNING
All GFS nodes \fImust\fP have the GFS filesystem unmounted before running
gfs_fsck. Failure to unmount all nodes may result in filesystem corruption.
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
+
+.SH DESCRIPTION
gfs_fsck will check that the GFS file system on a device is structurally valid.
It should not be run on a mounted file system. If file system corruption is
detected, it will attempt to repair the file system. There is a limit to what
@@ -34,44 +28,29 @@
fix. The first step to ensuring a healthy file system is the selection of
reliable hardware (i.e. storage systems that will write complete blocks - even
in the event of power failure).
-.sp
-.in
-\fBOPTIONS\fP
-.in +7
-
+.SH OPTIONS
+.TP
\fB-h\fP
-.in +7
Help.
-.sp
-This prints out the proper command line usage syntax.
-.sp
-.in
+This prints out the proper command line usage syntax.
+.TP
\fB-q\fP
-.in +7
Quiet.
-.sp
-.in
-
+.TP
\fB-V\fP
-.in +7
Version.
-.sp
-Print out the current version name.
-.sp
-.in
+Print out the current version name.
+.TP
\fB-v\fP
-.in +7
Verbose operation.
-.sp
-Print more information while running.
-.in
+Print more information while running.
+.TP
\fB-y\fP
-.in +7
Yes to all questions.
-.sp
+
By specifying this option, gfs_fsck will not prompt before making
changes.
=== man/gfs_grow.8
==================================================================
--- man/gfs_grow.8 (revision 310)
+++ man/gfs_grow.8 (local)
@@ -1,27 +1,16 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gfs_grow(8)''gfs_grow(8)'
-'\"
-'\" This file is maintained by:
-'\" Steven Whitehouse <steve at sistina.com>
-'\"
-'\" View with 'groff -t -e -mandoc -Tlatin1 gfs_grow.8 | less'
-'\"
+.TH gfs_grow 8
-\fBNAME\fP
-.in +7
+.SH NAME
gfs_grow - Expand a GFS filesystem
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBgfs_grow\fP\ [options]\ \fIdevice\ |\ mount_point\fR\ [\fIdevice\ |
-\ mount_point\fR...]
-.in
+.SH SYNOPSIS
+.B gfs_grow
+[\fIOPTION\fR]... <\fIDEVICE\fR|\fIMOINTPOINT\fR>...
-\fBDESCRIPTION\fP
-.in +7
+.SH DESCRIPTION
gfs_grow is used to expand a GFS filesystem after the device
upon which the filesystem resides has also been expanded. By
running gfs_grow on a GFS filesystem, you are requesting that
@@ -30,61 +19,48 @@
filesystem extension. When this operation is complete, the resource
index for the filesystem is updated so that all nodes in the
cluster can use the extra storage space which has been added.
-.sp
+
You may only run gfs_grow on a mounted filesystem; expansion of
unmounted filesystems is not supported. You only need to
run gfs_grow on one node in the cluster. All the other nodes will
see the expansion has occurred and automatically start to use the
newly available space.
-.sp
+
You must be superuser to execute \fBgfs_grow\fP. The gfs_grow
tool tries to prevent you from corrupting your filesystem by checking as
many of the likely problems as it can. When expanding a filesystem,
only the last step of updating the resource index affects the currently
mounted filesystem and so failure part way through the expansion process
should leave your filesystem in its original unexpanded state.
-.sp
+
You can run gfs_grow with the \fB-Tv\fP flags to get a display
of the current state of a mounted GFS filesystem. This can be useful
to do after the expansion process to see if the changes have been
successful.
-.sp
+
\fBgfs_grow\fP will consume all the remaining space in a device and add
it to the filesystem. If you want to add journals too, you need to add
the journals first using \fBgfs_jadd\fP.
-.in
-.sp
-\fBOPTIONS\fP
-.in
+
+.SH OPTIONS
+.TP
\fB-h\fP
-.in +7
Prints out a short usage message and exits.
-.in
-.sp
+.TP
\fB-q\fP
-.in +7
Quiet. Turns down the verbosity level.
-.sp
-.in
+.TP
\fB-T\fP
-.in +7
Test. Do all calculations, but do not write any data to the disk and do
not expand the filesystem. This is used to discover what the tool would
have done were it run without this flag. You probably want to turn the
verbosity level up in order to gain most information from this option.
-.sp
-.in
+.TP
\fB-V\fP
-.in +7
Version. Print out version information, then exit.
-.sp
-.in
+.TP
\fB-v\fP
-.in +7
Verbose. Turn up verbosity of messages.
-.in
-.sp
-.in -7
-\fBSEE ALSO\fP
-.in +7
+
+.SH SEE ALSO
gfs_mkfs(8) gfs_jadd(8)
=== man/gfs_jadd.8
==================================================================
--- man/gfs_jadd.8 (revision 310)
+++ man/gfs_jadd.8 (local)
@@ -1,27 +1,16 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gfs_jadd(8)''gfs_jadd(8)'
-'\"
-'\" This file is maintained by:
-'\" Steven Whitehouse <steve at sistina.com>
-'\"
-'\" View with 'groff -t -e -mandoc -Tlatin1 gfs_jadd.8 | less'
-'\"
+.TH gfs_jadd 8
-\fBNAME\fP
-.in +7
+.SH NAME
gfs_jadd \- Add journals to a GFS filesystem
-.in
-\fBSYNOPSIS\fP
-.in +8
-\fBgfs_jadd\fP\ [options]\ [\fB-j\fP\ \fI<num>\fR]\ [\fB-J\fP\ \fI\
-<size>\fR]\ \fBdevice\fP\ |\fB mount_point\fP\ [\fBdevice\fP\ |\fBmount_point\fP...]
+.SH SYNOPSIS
+.B gfs_jadd
+[\fIOPTION\fR]... <\fIDEVICE\fR|\fIMOINTPOINT\fR>...
-.in
-\fBDESCRIPTION\fP
-.in +7
+.SH DESCRIPTION
\fIgfs_jadd\fR is used to add journals to a GFS filesystem after
the device upon which the filesystem resides has been grown.
By running \fIgfs_jadd\fR
@@ -54,54 +43,36 @@
This can be useful to do after the journal addition process to see if the
changes have been successful.
-.in
-\fBOPTIONS\fR
-.in +7
+.SH OPTIONS
+.TP
\fB-j num\fP
-.in +7
The number of new journals to add. This defaults to 1.
-.sp
-.in
+.TP
\fB-J size\fP
-.in +7
The size of the new journals in megabytes. The defaults to 128MB (the
minimum size allowed is 32MB). If you want to add journals of different
sizes to the filesystem, you'll need to run gfs_jadd once for each
different size of journal. The size you specify here will be rounded
down so that it is a multiple of the journal segment size which was
specified at filesystem creation time.
-.sp
-.in
+.TP
\fB-h\fP
-.in +7
Help. Prints out a short usage message and exits.
-.sp
-.in
+.TP
\fB-q\fP
-.in +7
Quiet. Turns down the verbosity level.
-.sp
-.in
+.TP
\fB-T\fP
-.in +7
Test. Do all calculations, but do not write any data to the disk and do
not add journals. This is used to discover what the tool would
have done were it run without this flag. You probably want to turn the
verbosity level up in order to gain most information from this option.
-.sp
-.in
+.TP
\fB-V\fP
-.in +7
Version. Print version information, then exit.
-.sp
-.in
+.TP
\fB-v\fP
-.in +7
Verbose. Turn up verbosity of messages.
-.sp
-.in
-.in -7
-\fBSEE ALSO\fP
-.in +7
-\fIgfs_mkfs(8) gfs_grow(8)\fR
-.in -7
+
+.SP SEE ALSO
+gfs_mkfs(8) gfs_grow(8)
=== man/gfs_mkfs.8
==================================================================
--- man/gfs_mkfs.8 (revision 310)
+++ man/gfs_mkfs.8 (local)
@@ -1,112 +1,79 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gfs_mkfs(8)''gfs_mkfs(8)'
+.TH gfs_mkfs 8
-\fBNAME\fP
-.in +7
+.SH NAME
gfs_mkfs - Make a GFS filesystem
-.sp
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBgfs_mkfs\fP [options] \fIBlockDevice\fR
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
-gfs_mkfs is used to create a Global File System on the
-block device \fIBlockDevice\fR.
-.sp
-.in
-\fBOPTIONS\fP
-.in +7
+
+.SH SYNOPSIS
+.B gfs_mkfs
+[\fIOPTION\fR]... \fIDEVICE\fR
+
+.SH DESCRIPTION
+gfs_mkfs is used to create a Global File System.
+
+.SH OPTIONS
+.TP
\fB-b\fP \fIBlockSize\fR
-.in +7
Set the filesystem block size to \fIBlockSize\fR (must be a power of
two). The minimum block size is 512. The FS block size cannot exceed
the machine's memory page size. On the most architectures (i386,
x86_64, s390, s390x), the memory page size is 4096 bytes. On other
architectures it may be bigger. The default block size is 4096 bytes.
In general, GFS filesystems should not deviate from the default value.
-.in
-.sp
+.TP
\fB-D\fP
-.in +7
Enable debugging output.
-.in
-.sp
+.TP
\fB-h\fP
-.in +7
Print out a help message describing available
options, then exit.
-.in
-.sp
+.TP
\fB-J\fP \fIMegaBytes\fR
-.in +7
The size of the journals in Megabytes. The default journal size is
128 megabytes. The minimum size is 32 megabytes.
-.in
-.sp
+.TP
\fB-j\fP \fINumber\fR
-.in +7
The number of journals for gfs_mkfs to create. You need at least one
journal per machine that will mount the filesystem.
-.in
-.sp
+.TP
\fB-O\fP
-.in +7
This option prevents gfs_mkfs from asking for confirmation before writing
the filesystem.
-.in
-.sp
+.TP
\fB-p\fP \fILockProtoName\fR
-.in +7
LockProtoName is the name of the locking protocol to use. Acceptable
locking protocols are \fIlock_gulm\fR or if you are using GFS
as a local filesystem (\fB1 node only\fP), you can specify the
\fIlock_nolock\fR protocol.
-.in
-.sp
+.TP
\fB-q\fP
-.in +7
Be quiet. Don't print anything.
-.in
-.sp
+.TP
\fB-r\fP \fIMegaBytes\fR
-.in +7
gfs_mkfs will try to make Resource Groups about this big.
The default is 256 MB.
-.in
-.sp
+.TP
\fB-s\fP \fIBlocks\fR
-.in +7
Journal segment size in filesystem blocks. This value must be at
least two and not large enough to produce a segment size greater than
4MB.
-.in
-.sp
+.TP
\fB-t\fP \fILockTableName\fR
-.in +7
The lock table field appropriate to the lock module you're using.
For lock_gulm, it is \fIclustername:fsname\fR.
Clustername is the cluster.ccs:cluster/name string for the cluster which
will use this filesystem (1 to 16 characters). Fsname is a unique
file system name used to distinguish this GFS file system from others
created (1 to 16 characters). Lock_nolock doesn't use this field.
-.in
-.sp
+.TP
\fB-V\fP
-.in +7
Print program version information, then exit.
-.in
-.sp
-.in -7
-\fBEXAMPLE\fP
-.in +7
+
+.SH EXAMPLE
+.TP
gfs_mkfs -t mycluster:mygfs -p lock_gulm -j 2 /dev/pool/mygfs
-.sp
-.in +7
This will make a Global File System on the block device
"/dev/pool/mygfs". It will belong to "mycluster" and register itself
as wanting locking for "mygfs". It will use GULM for locking and make
=== man/gfs_mount.8
==================================================================
--- man/gfs_mount.8 (revision 310)
+++ man/gfs_mount.8 (local)
@@ -4,21 +4,17 @@
.\" 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 'gfs_mount(8)''gfs_mount(8)'
-\fBNAME\fP
-.in +7
+.TH gfs_mount 8
+
+.SH NAME
gfs_mount - GFS mount options
-.in
-.sp
-\fBSYNOPSIS\fP
-.in +7
-\fBmount\fP [StandardMountOptions] \fB-t\fP gfs \fIdevice\fR \fImountpoint\fR \fB-o\fP [GFSOption1,GFSOption2,GFSOptionX...]
-.in
-.sp
-\fBDESCRIPTION\fP
-.in +7
+
+.SH SYNOPSIS
+.B mount
+[\fIStandardMountOptions\fR] \fB-t\fP gfs \fIDEVICE\fR \fIMOUNTPOINT\fR \fB-o\fP [GFSOption1,GFSOption2,GFSOptionX...]
+
+.SH DESCRIPTION
GFS may be used as a local (single computer) filesystem, but its real purpose
is in clusters, where multiple computers (nodes) share a common storage device.
@@ -68,13 +64,10 @@
If you have trouble mounting GFS, check the syslog (e.g. /var/log/messages)
for specific error messages.
-.sp
-.in
-\fBOPTIONS\fP
-.in +7
+.SH OPTIONS
+.TP
\fBlockproto=\fP\fILockModuleName\fR
-.in +5
This specifies which inter-node lock protocol is used by the GFS filesystem
for this mount, overriding the default lock protocol name stored in the
filesystem's on-disk superblock.
@@ -91,10 +84,8 @@
The \fBlockproto\fP mount option should be used only under special
circumstances in which you want to temporarily use a different lock protocol
without changing the on-disk default.
-.in
-.sp
+.TP
\fBlocktable=\fP\fILockTableName\fR
-.in +5
This specifies the identity of the cluster and of the filesystem for this
mount, overriding the default cluster/filesystem identify stored in the
filesystem's on-disk superblock. The cluster/filesystem name is recognized
@@ -114,10 +105,8 @@
circumstances in which you want to mount the filesystem in a different cluster,
or mount it as a different filesystem name, without changing the on-disk
default.
-.in
-.sp
+.TP
\fBhostdata=\fP\fIHostIDInfo\fR
-.in +5
This field sends host (the computer on which the filesystem is being mounted)
identity information to the lock module.
@@ -126,20 +115,16 @@
used as default by lock_gulm.
This field is ignored by \fIlock_dlm\fR and \fIlock_nolock\fR.
-.in
-.sp
+.TP
\fBlocalcaching\fP
-.in +5
This flag tells GFS that it is running as a local (not clustered) filesystem,
so it can turn on some block caching optimizations that can't be used when
running in cluster mode.
This is turned on automatically by the lock_nolock module,
but can be overridden by using the \fBignore_local_fs\fP option.
-.in
-.sp
+.TP
\fBlocalflocks\fP
-.in +5
This flag tells GFS that it is running as a local (not clustered) filesystem,
so it can allow the kernel VFS layer to do all flock and fcntl file locking.
When running in cluster mode, these file locks require inter-node locks,
@@ -148,10 +133,8 @@
This is turned on automatically by the lock_nolock module,
but can be overridden by using the \fBignore_local_fs\fP option.
-.in
-.sp
+.TP
\fBoopses_ok\fP
-.in +5
Normally, GFS automatically turns on the "kernel.panic_on_oops"
sysctl to cause the machine to panic if an oops (an in-kernel
segfault or GFS assertion failure) happens. An oops on one machine of
@@ -166,29 +149,23 @@
This is turned on automatically by the lock_nolock module,
but can be overridden by using the \fBignore_local_fs\fP option.
-.in
-.sp
+.TP
\fBignore_local_fs\fP
-.in +5
By default, using the nolock lock module automatically turns on the
\fBlocalcaching\fP and \fBlocalflocks\fP optimizations. \fBignore_local_fs\fP
forces GFS to treat the filesystem as if it were a multihost (clustered)
filesystem, with \fBlocalcaching\fP and \fBlocalflocks\fP optimizations
turned off.
-.in
-.sp
+.TP
\fBupgrade\fP
-.in +5
This flag tells GFS to upgrade the filesystem's on-disk format to the version
supported by the current GFS software installation on this computer.
If you try to mount an old-version disk image, GFS will notify you via a syslog
message that you need to upgrade. Try mounting again, using the
\fB-o upgrade\fP option. When upgrading, only one node may mount the GFS
filesystem.
-.in
-.sp
+.TP
\fBnum_glockd\fP
-.in +5
Tunes GFS to alleviate memory pressure when rapidly aquiring many locks (e.g.
several processes scanning through huge directory trees). GFS' glockd kernel
daemon cleans up memory for no-longer-needed glocks. Multiple instances
@@ -196,40 +173,28 @@
one daemon, with a maximum of 32. Since this option was introduced, other
methods of rapid cleanup have been developed within GFS, so this option may go
away in the future.
-.in
-.sp
+.TP
\fBacl\fP
-.in +5
Enables POSIX Access Control List \fBacl\fP(5) support within GFS.
-.in
-.sp
+.TP
\fBsuiddir\fP
-.in +5
Sets owner of any newly created file or directory to be that of parent
directory, if parent directory has S_ISUID permission attribute bit set.
Sets S_ISUID in any new directory, if its parent directory's S_ISUID is set.
Strips all execution bits on a new file, if parent directory owner is different
from owner of process creating the file. Set this option only if you know
why you are setting it.
-.in
-.sp
-.in -7
-\fBLINKS\fP
-.in +7
+
+.SH LINKS
+.TP 30
http://sources.redhat.com/cluster
-.in +7
-- home site of GFS
-.in
-.sp
+.TP
http://www.suse.de/~agruen/acl/linux-acls/
-.in +7
-- good writeup on ACL support in Linux
-.in
-.in -7
-.sp
-\fBSEE ALSO\fP
-.in +7
+.SH SEE ALSO
+
\fBgfs\fP(8),
\fBmount\fP(8) for general mount options,
\fBchmod\fP(1) and \fBchmod\fP(2) for access permission flags,
@@ -239,6 +204,4 @@
\fBlock_gulmd\fP(8),
\fBumount\fP(8),
\fBinitrd\fP(4).
-.sp
-.in
=== man/gfs_quota.8
==================================================================
--- man/gfs_quota.8 (revision 310)
+++ man/gfs_quota.8 (local)
@@ -1,151 +1,104 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gfs_quota(8)''gfs_quota(8)'
+.TH gfs_quota 8
-\fBNAME\fP
-.in +7
+.SH NAME
gfs_quota - Manipulate GFS disk quotas
-.sp
-.in
-\fBSYNOPSIS\fP
-.in +7
-\fBgfs_quota\fP <list|sync|get|limit|warn|check|init> [options]
-.sp
-.in
-\fBDESCRIPTION\fP
-.in +7
+
+.SH SYNOPSIS
+.B gfs_quota
+<list|sync|get|limit|warn|check|init> [\fIOPTION\fR]...
+
+.SH DESCRIPTION
gfs_quota is used to examine and change quota values in a GFS filesystem.
This command has a number of different actions.
-.sp
-.in
-\fBACTIONS\fP
-.in +7
+
+.SH ACTIONS
+.TP
\fBlist\fP
-.in +7
List the contents of the quota file. Only IDs that have a non-zero hard limit,
warn limit, or value are printed.
-.in
-.sp
+.TP
\fBsync\fP
-.in +7
Sync any local quota changes to the quota file.
-.in
-.sp
+.TP
\fBget\fP
-.in +7
Get the current data for the ID specified by the -u or -g argument.
-.in
-.sp
+.TP
\fBlimit\fP
-.in +7
Set the current hard limit for the ID specified by the -u or -g argument to
the value specified by the -l argument on the specified filesystem.
The filesystem won't let the user or group use more than this much space.
A value of zero here means that no limit is enforced.
-.in
-.sp
+.TP
\fBwarn\fP
-.in +7
Set the current warn limit for the ID specified by the -u or -g argument to
the value specified by the -l argument on the specified filesystem.
The filesystem will start complaining to the user or group when more
than this much space is used. A value of zero here means that the
user won't ever be warned.
-.in
-.sp
+.TP
\fBcheck\fP
-.in +7
Scan a filesystem and make sure that what's out there on the disk matches
what's in the quota file. This is only accurate if the filesystem is
idle when this is running. If there is a mismatch, it is printed to
stdout. Note: GFS quotas are transactional and a quota check is \fBnot\fP
needed every time there is a system crash.
-.in
-.sp
+.TP
\fBinit\fP
-.in +7
Scan a filesystem and initialize the quota file with the values obtained
from the scan. The filesystem should be idle when this is run. You should
only need to do this if you upgrade a pre-quota GFS filesystem (pre-GFS 5.1).
-.in
-.sp
-.in -7
-\fBOPTIONS\fP
-.in +7
+
+.SH OPTIONS
\fB-b\fP
-.in +7
The units for disk space are filesystem blocks.
-.in
-.sp
+.TP
\fB-d\fP
-.in +7
Don't include the space allocated to GFS' hidden files in
what's reported for the root UID and GID values. This is useful
if you're trying to get the numbers reported by gfs_quota to match
up with the numbers reported by du.
-.in
-.sp
+.TP
\fB-f\fP \fIDirectory\fR
-.in +7
Specifies which filesystem to perform the action on.
-.in
-.sp
+.TP
\fB-g\fP \fIGID\fR
-.in +7
Specifies the group ID for get, limit, or warn. It can be either
the group name from the group file, or the GID number.
-.in
-.sp
+.TP
\fB-h\fP
-.in +7
Print out a help message describing available
options, then exit.
-.in
-.sp
+.TP
\fB-k\fP
-.in +7
The units for disk space are kilobytes.
-.in
-.sp
+.TP
\fB-l\fP \fISize\fR
-.in +7
Specifies the new value for the limit or warn actions.
The value is assumed to be in the units specified by the
-m, -k, -s, -b arguments. The default is megabytes.
-.in
-.sp
+.TP
\fB-m\fP
-.in +7
The units for disk space are megabytes. This is the default.
-.in
-.sp
+.TP
\fB-n\fP
-.in +7
Don't try to resolve UIDs and GIDs into user and group names.
-.in
-.sp
+.TP
\fB-s\fP
-.in +7
The units for disk space are sectors (512-byte blocks).
-.in
-.sp
+.TP
\fB-u\fP \fIUID\fR
-.in +7
Specifies the user ID for get, limit, or warn. It can be either
the username from the password file, or the UID number.
-.in
-.sp
+.TP
\fB-V\fP
-.in +7
Print program version information, then exit.
-.in
-.sp
-.in -7
-\fBEXAMPLE\fP
-.in +7
+
+.SH EXAMPLE
To set the hard limit for user "nobody" to
1048576 kilobytes on filesystem /gfs0
-.in +7
+
gfs_quota limit -l 1048576 -k -u nobody -f /gfs0
=== man/gfs_tool.8
==================================================================
--- man/gfs_tool.8 (revision 310)
+++ man/gfs_tool.8 (local)
@@ -1,147 +1,103 @@
.\" Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
.\" Copyright (C) 2004 Red Hat, Inc. All rights reserved.
-.tl 'gfs_tool(8)''gfs_tool(8)'
+.TH gfs_tool 8
-\fBNAME\fP
-.in +7
+.SH NAME
gfs_tool - interface to gfs ioctl calls
-.in
-.sp
-\fBSYNOPSIS\fP
-.in +7
-\fBgfs_tool\fP command [options]
-.in
-.sp
-\fBDESCRIPTION\fP
-.in +7
+
+.SH SYNOPSIS
+.B gfs_tool
+\fICOMMAND\fR [\fIOPTION\fR]...
+
+.SH DESCRIPTION
gfs_tool is an interface to a variety of the GFS ioctl calls.
-.sp
-.in
-\fBCOMMANDS\fP
-.in +7
+
+.SH COMMANDS
+.TP
\fBclearflag\fP \fIFlag\fR \fIFile1\fR \fIFile2\fR \fI...\fR
-.in +7
Clear an attribute flag on a file.
-.in
-.sp
+.TP
\fBcounters\fP \fIMountPoint\fR [-c]
-.in +7
Print out statistics about a filesystem. If -c is used, gfs_tool continues
to run printing out the stats once a second.
-.in
-.sp
+.TP
\fBdf\fP \fIMountPoint\fR
-.in +7
Print out a space usage summary of a given filesystem. The information
printed is more detailed than a standard "df".
-.in
-.sp
+.TP
\fBfreeze\fP \fIMountPoint\fR
-.in +7
Freeze (quiesce) a GFS cluster.
-.in
-.sp
+.TP
\fBgetsb\fP \fIMountPoint\fR
-.in +7
Print out the superblock of a mounted filesystem.
-.in
-.sp
+.TP
\fBgettune\fP \fIMountPoint\fR
-.in +7
Print out the current values of the tuning parameters in a running
filesystem.
-.in
-.sp
+.TP
\fBjindex\fP \fIMountPoint\fR
-.in +7
Print out the journal index of a mounted filesystem.
-.in
-.sp
+.TP
\fBlayout\fP \fIFile\fR \fI[buffersize]\fR
-.in +7
Print out on-disk layout information about a file or directory.
Buffersize is the size of the buffer (in bytes) that gfs_tool allocates
to store the file's metadata during processing. It defaults to 4194304
bytes. If you are printing a very big directory you may need to specify
a bigger size.
-.in
-.sp
+.TP
\fBlist\fP
-.in +7
List the currently mounted GFS filesystems. Each line represents
a filesystem. The columns represent (in order): 1) A number that
is a cookie that represents the mounted filesystem. 2) The name of the
device that holds the filesystem (well, the name as the Linux
kernel knows it). 3) The lock table field that the filesystem was
mounted with.
-.in
-.sp
+.TP
\fBlockdump\fP \fIMountPoint\fR \fI[buffersize]\fR
-.in +7
Print out information about the locks this machine holds for a given
filesystem. Buffersize is the size of the buffer (in bytes) that gfs_tool
allocates to store the lock data during processing. It defaults to 4194304
bytes.
-.in
-.sp
+.TP
\fBmargs\fP \fIarguments\fR
-.in +7
This loads arguments into the module what will override the mount
options passed with the -o field on the next mount. See gfs_mount(8).
-.in
-.sp
+.TP
\fBreclaim\fP \fIFile\fR
-.in +7
Returns unused on-disk metadata blocks to free blocks.
-.in
-.sp
+.TP
\fBrindex\fP \fIMountPoint\fR
-.in +7
Print out the resource group index of a mounted filesystem.
-.in
-.sp
+.TP
\fBquota\fP \fIMountPoint\fR
-.in +7
Print out the quota file of a mounted filesystem. Also see
the "gfs_quota list" command.
-.in
-.sp
+.TP
\fBsb\fP \fIdevice\fR \fBproto\fP \fI[newvalue]\fR
-.in +7
View (and possibly replace) the name of the locking protocol in the
file system superblock. The file system shouldn't be mounted by any
client when you do this.
-.in
-.sp
+.TP
\fBsb\fP \fIdevice\fR \fBtable\fP \fI[newvalue]\fR
-.in +7
View (and possibly replace) the name of the locking table in the
file system superblock. The file system shouldn't be mounted by any
client when you do this.
-.in
-.sp
+.TP
\fBsb\fP \fIdevice\fR \fBondisk\fP \fI[newvalue]\fR
-.in +7
View (and possibly replace) the ondisk format number in the
file system superblock. The file system shouldn't be mounted by any
client when you do this. No one should have to use this.
-.in
-.sp
+.TP
\fBsb\fP \fIdevice\fR \fBmultihost\fP \fI[newvalue]\fR
-.in +7
View (and possibly replace) the multihost format number in the
file system superblock. The file system shouldn't be mounted by any
client when you do this. No one should have to use this.
-.in
-.sp
+.TP
\fBsb\fP \fIdevice\fR \fBall\fP
-.in +7
Print out the superblock.
-.in
-.sp
+.TP
\fBsetflag\fP \fIFlag\fR \fIFile1\fR \fIFile2\fR \fI...\fR
-.in +7
Set an attribute flag on a file. There are four currently
supported flags. They are jdata, directio, inherit_jdata, and
inherit_directio.
@@ -162,35 +118,23 @@
regular files created in that directory automatically inherit the
\fIdirectio\fR flag. The \fIinherit_directio\fR is also inherited by
any new subdirectories created in that directory.
-.in
-.sp
+.TP
\fBsettune\fP \fIMountPoint\fR \fIparameter\fR \fInewvalue\fR
-.in +7
Set the value of tuning parameter. Use \fBgettune\fP for a listing of
tunable parameters.
-.in
-.sp
+.TP
\fBshrink\fP \fIMountPoint\fR
-.in +7
Causes any unused inodes to be thrown out of memory.
-.in
-.sp
+.TP
\fBstat\fP \fIFile\fR
-.in +7
Print out extended stat information about a file.
-.in
-.sp
+.TP
\fBunfreeze\fP \fIMountPoint\fR
-.in +7
Unfreeze a GFS cluster.
-.in
-.sp
+.TP
\fBversion\fP
-.in +7
Print out the version of GFS that this program goes with.
-.in
-.sp
+.TP
\fBwithdraw\fP \fIMountPoint\fR
-.in +7
Cause GFS to abnormally shutdown a given filesystem on this node.
-------------- 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/dca6e201/attachment.sig>
More information about the Linux-cluster
mailing list