[Ocfs2-tools-devel] [PATCH 22/28] manpages: Refreshes manpages
Sunil Mushran
sunil.mushran at oracle.com
Fri Aug 19 15:16:19 PDT 2011
Signed-off-by: Sunil Mushran <sunil.mushran at oracle.com>
---
debugfs.ocfs2/debugfs.ocfs2.8.in | 24 ++++--
documentation/samples/cluster.conf | 41 ++++++---
fsck.ocfs2/fsck.ocfs2.8.in | 15 ++--
fsck.ocfs2/fsck.ocfs2.checks.8.in | 11 ++-
mkfs.ocfs2/mkfs.ocfs2.8.in | 159 +++++++++++++++++----------------
mount.ocfs2/mount.ocfs2.8.in | 172 ++++++++++++++++++++++++++----------
mounted.ocfs2/mounted.ocfs2.8.in | 73 +++++++++-------
o2cb_ctl/o2cb.8.in | 48 ++++++----
o2cb_ctl/o2cb_ctl.8.in | 1 -
o2image/o2image.8.in | 45 +++++++---
o2info/o2info.1.in | 146 ++++++++++++++++---------------
ocfs2_hb_ctl/ocfs2_hb_ctl.8.in | 25 +++---
tunefs.ocfs2/tunefs.ocfs2.8.in | 42 +++++----
13 files changed, 487 insertions(+), 315 deletions(-)
diff --git a/debugfs.ocfs2/debugfs.ocfs2.8.in b/debugfs.ocfs2/debugfs.ocfs2.8.in
index 4adc8c7..03c1f80 100644
--- a/debugfs.ocfs2/debugfs.ocfs2.8.in
+++ b/debugfs.ocfs2/debugfs.ocfs2.8.in
@@ -1,4 +1,4 @@
-.TH "debugfs.ocfs2" "8" "July 2011" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "debugfs.ocfs2" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
debugfs.ocfs2 \- OCFS2 file system debugger.
.SH "SYNOPSIS"
@@ -167,7 +167,7 @@ Display the directory free space list.
Display the lockname for the \fIfilespec\fR.
.TP
-\fIextent block#\fR
+\fIextent <block#>\fR
Display the contents of the extent structure at \fIblock#\fR.
.TP
@@ -189,10 +189,14 @@ contents of the lock value block and \fI-f <file>\fR to specify a
saved copy of /sys/kernel/debug/ocfs2/<UUID>/locking_state.
.TP
-\fIgroup block#\fR
+\fIgroup <block#>\fR
Display the contents of the group descriptor at \fIblock#\fR.
.TP
+\fIgrpextents <block#>\fR
+Display free extents in the chain group.
+
+.TP
\fIhb\fR
Display the contents of the heartbeat system file.
@@ -225,6 +229,10 @@ Print the listing of the files in the directory \fIfilespec\fR. The
\fI\-l\fR flag will list files in the long format.
.TP
+\fInet_stats [interval [count]]\fR
+Display net statistics.
+
+.TP
\fIncheck [<lockname>|<inode#>] ...\fR
See \fIlocate\fR.
@@ -276,13 +284,15 @@ Display extended attributes associated with the given \fIfilespec\fR.
This tool has been modelled after \fBdebugfs\fR, a debugging tool for ext2.
.SH "SEE ALSO"
-.BR mkfs.ocfs2(8)
.BR fsck.ocfs2(8)
-.BR tunefs.ocfs2(8)
+.BR fsck.ocfs2.checks(8)
+.BR mkfs.ocfs2(8)
+.BR mount.ocfs2(8)
.BR mounted.ocfs2(8)
-.BR ocfs2console(8)
.BR o2image(8)
-.BR o2cb(7)
+.BR o2info(1)
+.BR ocfs2(7)
+.BR tunefs.ocfs2(8)
.SH "AUTHOR"
Oracle Corporation
diff --git a/documentation/samples/cluster.conf b/documentation/samples/cluster.conf
index 76830ca..c6a9286 100644
--- a/documentation/samples/cluster.conf
+++ b/documentation/samples/cluster.conf
@@ -1,18 +1,37 @@
+cluster:
+ heartbeat_mode = global
+ node_count = 3
+ name = webcluster
+
node:
+ number = 7
+ cluster = webcluster
ip_port = 7777
- ip_address = 192.168.0.112
- number = 0
- name = node0
- cluster = ocfs2
+ ip_address = 192.168.0.107
+ name = node7
node:
+ number = 6
+ cluster = webcluster
ip_port = 7777
- ip_address = 192.168.0.116
- number = 1
- name = node1
- cluster = ocfs2
+ ip_address = 192.168.0.106
+ name = node6
-cluster:
- node_count = 2
- name = ocfs2
+node:
+ number = 10
+ cluster = webcluster
+ ip_port = 7777
+ ip_address = 192.168.0.110
+ name = node10
+
+heartbeat:
+ cluster = webcluster
+ region = 77D95EF51C0149D2823674FCC162CF8B
+
+heartbeat:
+ cluster = webcluster
+ region = DCDA2845177F4D59A0F2DCD8DE507CC3
+heartbeat:
+ cluster = webcluster
+ region = BBA1DBD0F73F449384CE75197D9B7098
diff --git a/fsck.ocfs2/fsck.ocfs2.8.in b/fsck.ocfs2/fsck.ocfs2.8.in
index 06e943a..21706dd 100644
--- a/fsck.ocfs2/fsck.ocfs2.8.in
+++ b/fsck.ocfs2/fsck.ocfs2.8.in
@@ -1,4 +1,4 @@
-.TH "fsck.ocfs2" "8" "September 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "fsck.ocfs2" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
fsck.ocfs2 \- Check an \fIOCFS2\fR file system.
.SH "SYNOPSIS"
@@ -114,13 +114,14 @@ The exit code returned by \fBfsck.ocfs2\fR is the sum of the following condition
.br
.SH "SEE ALSO"
-.BR mkfs.ocfs2(8)
.BR debugfs.ocfs2(8)
-.BR tunefs.ocfs2(8)
+.BR fsck.ocfs2.checks(8)
+.BR mkfs.ocfs2(8)
+.BR mount.ocfs2(8)
.BR mounted.ocfs2(8)
-.BR ocfs2console(8)
-.BR o2cb(7)
-
+.BR o2image(8)
+.BR o2info(1)
+.BR tunefs.ocfs2(8)
.SH "AUTHORS"
Oracle Corporation. This man page entry derives some text, especially the exit code summary, from
@@ -128,4 +129,4 @@ Oracle Corporation. This man page entry derives some text, especially the exit
by Theodore Y. Ts'o <tytso at mit.edu>.
.SH "COPYRIGHT"
-Copyright \(co 2004, 2010 Oracle. All rights reserved.
+Copyright \(co 2004, 2011 Oracle. All rights reserved.
diff --git a/fsck.ocfs2/fsck.ocfs2.checks.8.in b/fsck.ocfs2/fsck.ocfs2.checks.8.in
index e706ea5..14198fd 100644
--- a/fsck.ocfs2/fsck.ocfs2.checks.8.in
+++ b/fsck.ocfs2/fsck.ocfs2.checks.8.in
@@ -1,4 +1,4 @@
-.TH "fsck.ocfs2.checks" "8" "September 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "fsck.ocfs2.checks" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
fsck.ocfs2.checks \- Consistency checks that
.BR fsck.ocfs2(8)
@@ -1138,10 +1138,17 @@ index entry will cause lookups on this name to fail.
Answering yes will rebuild the directory index, restoring the missing entry.
.SH "SEE ALSO"
+.BR debugfs.ocfs2(8)
.BR fsck.ocfs2(8)
+.BR mkfs.ocfs2(8)
+.BR mount.ocfs2(8)
+.BR mounted.ocfs2(8)
+.BR o2image(8)
+.BR o2info(1)
+.BR tunefs.ocfs2(8)
.SH "AUTHORS"
Oracle Corporation.
.SH "COPYRIGHT"
-Copyright \(co 2004, 2010 Oracle. All rights reserved.
+Copyright \(co 2004, 2011 Oracle. All rights reserved.
diff --git a/mkfs.ocfs2/mkfs.ocfs2.8.in b/mkfs.ocfs2/mkfs.ocfs2.8.in
index d1173dd..51d25ab 100644
--- a/mkfs.ocfs2/mkfs.ocfs2.8.in
+++ b/mkfs.ocfs2/mkfs.ocfs2.8.in
@@ -1,4 +1,4 @@
-.TH "mkfs.ocfs2" "8" "February 2011" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "mkfs.ocfs2" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
mkfs.ocfs2 \- Creates an \fIOCFS2\fR file system.
.SH "SYNOPSIS"
@@ -41,13 +41,13 @@ Specify this option to disable this check.
Create the journal using options specified on the command\-line. Journal
options are comma separated, and may take an argument using the equals
('=') sign. The following options are supported:
-.RS 1.2i
+
+.RS
.TP
\fBsize\fR=\fIjournal\-size\fR
Create a journal of size \fIjournal\-size\fR. Minimum size is 4M.
If omitted, a value is heuristically determined based upon the file system size.
-.RE
-.RS 1.2i
+
.TP
\fBblock32\fR
Use a standard 32bit journal. The journal will be able to access up to
@@ -55,8 +55,7 @@ Use a standard 32bit journal. The journal will be able to access up to
\fIOCFS2\fR volumes since the beginning. The journal is compatible with
all versions of \fIOCFS2\fR. Prepending \fBno\fR is equivalent to the
\fBblock64\fR journal option.
-.RE
-.RS 1.2i
+
.TP
\fBblock64\fR
Use a 64bit journal. The journal will be able to access up to 2^64-1
@@ -89,18 +88,17 @@ down using \fItunefs.ocfs2\fR.
Specify how the filesystem is going to be used, so that \fImkfs.ocfs2\fR can
chose optimal filesystem parameters for that use. The supported
filesystem types are:
-.RS 1.2i
+
+.RS
.TP
\fBmail\fR
Appropriate for file systems that will host lots of small files.
-.RE
-.RS 1.2i
+
.TP
\fBdatafiles\fR
Appropriate for file systems that will host a relatively small number
of very large files.
-.RE
-.RS 1.2i
+
.TP
\fBvmstore\fR
Appropriate for file systems that will host Virtual machine images.
@@ -109,47 +107,40 @@ Appropriate for file systems that will host Virtual machine images.
.TP
\fB\-\-fs\-features=\fR\fR\fI[no]sparse...\fR
Turn specific file system features on or off. A comma separated list of feature flags can be provided, and \fImkfs.ocfs2\fR will try to create the file system with those features set according to the list. To turn a feature on, include it in the list. To turn a feature off, prepend \fBno\fR to the name. Choices here will override individual features set via the \fB\-\-fs\-feature\-level\fR option. \fBRefer to the section titled feature compatibility before selecting specific features.\fR The following flags are supported:
-.RS 1.2i
+
+.RS
.TP
\fBbackup-super\fR
\fImkfs.ocfs2\fR, by default, makes up to 6 backup copies of the super block at offsets 1G, 4G, 16G, 64G, 256G and 1T depending on the size of the volume. This can be useful in disaster recovery. This feature is fully compatible with all versions of the file system and generally should not be disabled.
-.RE
-.RS 1.2i
+
.TP
\fBlocal\fR
Create the file system as a local mount, so that it can be mounted without a cluster stack.
-.RE
-.RS 1.2i
+
.TP
\fBsparse\fR
Enable support for sparse files. With this, \fIOCFS2\fR can avoid allocating (and zeroing) data to fill holes. Turn this feature on if you can, otherwise extends and some writes might be less performant.
-.RE
-.RS 1.2i
+
.TP
\fBunwritten\fR
Enable unwritten extents support. With this turned on, an application can request that a range of clusters be pre-allocated within a file. \fIOCFS2\fR will mark those extents with a special flag so that expensive data zeroing doesn't have to be performed. Reads and writes to a pre-allocated region act as reads and writes to a hole, except a write will not fail due to lack of data allocation. This feature requires \fBsparse\fR file support to be turned on.
-.RE
-.RS 1.2i
+
.TP
\fBinline-data\fR
Enable inline-data support. If this feature is turned on, \fIOCFS2\fR will store small files and directories inside the inode block. Data is transparently moved out to an extent when it no longer fits inside the inode block. In some cases, this can also make a positive impact on cold-cache directory and file operations.
-.RE
-.RS 1.2i
+
.TP
\fBextended-slotmap\fR
-The slot-map is a hidden file on an \fIOCFS2\fR fs which is used to map mounted nodes to system file resources. The extended slot map allows a larger range of possible node numbers, which is useful for userspace cluster stacks. This feature is automatically turned on when needed, thus users have no need to turn this on manually.
-.RE
-.RS 1.2i
+The slot-map is a hidden file on an \fIOCFS2\fR fs which is used to map mounted nodes to system file resources. The extended slot map allows a larger range of possible node numbers, which is useful for userspace cluster stacks. If required, this feature is automatically turned on by \fImkfs.ocfs2\fR.
+
.TP
\fBmetaecc\fR
Enables metadata checksums. With this enabled, the file system computes and stores the checksums in all metadata blocks. It also computes and stores an error correction code capable of fixing single bit errors.
-.RE
-.RS 1.2i
+
.TP
\fBrefcount\fR
Enables creation of reference counted trees. With this enabled, the file system allows users to create inode-based snapshots and clones known as \fBreflinks\fR.
-.RE
-.RS 1.2i
+
.TP
\fBxattr\fR
Enable extended attributes support. With this enabled, users can attach name:value pairs to objects
@@ -158,50 +149,54 @@ NUL byte. While it is not required, printable names (ASCII) are recommended. The
arbitrary binary data. Attributes can be attached to all types of inodes: regular files, directories,
symbolic links, device nodes, etc. This feature is required for users wanting to use extended security
facilities like POSIX ACLs or SELinux.
-.RE
-.RS 1.2i
+
.TP
\fBusrquota\fR
Enable user quota support. With this feature enabled, filesystem will track amount of space
and number of inodes (files, directories, symbolic links) each user owns. It is then possible
to limit the maximum amount of space or inodes user can have. See a documentation of
quota-tools package for more details.
-.RE
-.RS 1.2i
+
.TP
\fBgrpquota\fR
Enable group quota support. With this feature enabled, filesystem will track amount of space
and number of inodes (files, directories, symbolic links) each group owns. It is then possible
to limit the maximum amount of space or inodes user can have. See a documentation of
quota-tools package for more details.
-.RE
-.RS 1.2i
+
.TP
\fBindexed-dirs\fR
Enable directory indexing support. With this feature enabled, the file system creates indexed tree for non-inline directory entries. For large scale directories, directory entry lookup perfromance from the indexed tree is faster then from the legacy directory blocks.
-.RE
-.RS 1.2i
+
.TP
\fBdiscontig-bg\fR
Enables discontiguous block groups. With this feature enabled, the file system is able to grow
the inode and the extent allocators even when there is no contiguous free chunk available. It
allows the file system to grow the allocators in smaller (discontiguous) chunks.
+
+.TP
+\fBclusterinfo\fR
+Enables storing the cluster stack information in the superblock. This feature is needed
+to support userspace cluster stacks and the global heartbeat mode in the \fBo2cb\fR
+cluster stack. If needed, this feature is automatically turned on by \fImkfs.ocfs2\fR.
.RE
.TP
\fB\-\-fs\-feature\-level=\fR\fR\fIfeature\-level\fR
Choose from a set of pre-determined file-system features. This option is designed to allow users to conveniently choose a set of file system features which fits their needs. There is no downside to trying a set of features which your module might not support - if it won't mount the new file system simply reformat at a lower level. Feature levels can be fine-tuned via the \fB\-\-fs\-features\fR option. Currently, there are 3 types of feature levels:
-.RS 1.2i
+
+.RS
.TP
\fBmax-compat\fR
Chooses fewer features but ensures that the file system can be mounted from older versions of the \fIOCFS2\fR module.
-.RE
-.RS 1.2i
+
.TP
\fBdefault\fR
-The default feature set tries to strike a balance between providing new features and maintaining compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR, \fBunwritten\fR \fBinline-data\fR \fBxattr\fR, \fBindexed-dirs\fR, \fBdiscontig-bg\fR, \fBrefcount\fR and \fBextended-slotmap\fR.
-.RE
-.RS 1.2i
+The default feature set tries to strike a balance between providing new features and maintaining
+compatibility with relatively recent versions of \fIOCFS2\fR. It currently enables \fBsparse\fR,
+\fBunwritten\fR, \fBinline-data\fR, \fBxattr\fR, \fBindexed-dirs\fR, \fBdiscontig-bg\fR, \fBrefcount\fR,
+\fBextended-slotmap\fR and \fBclusterinfo\fR.
+
.TP
\fBmax-features\fR
Choose the maximum amount of features available. This will typically provide the best performance from \fIOCFS2\fR at the expense of creating a file system that is only compatible with very recent versions of the \fIOCFS2\fR kernel module.
@@ -209,12 +204,12 @@ Choose the maximum amount of features available. This will typically provide the
.TP
\fB\-\-cluster\-stack\fR
-Specify the cluster stack. This option is normally not required as \fBmkfs.ocfs2\fR
+Specify the cluster stack. This option is normally not required as \fImkfs.ocfs2\fR
chooses the currently active cluster stack. It is required only if the cluster stack
is not online and the user wishes to use a stack other than the default,
-\fBO2CB\fR. Other cluster stacks known to work with \fIOCFS2\fR are \fBPCMK\fR
-\fI(Pacemaker)\fR and \fBCMAN\fR. Once set, \fIOCFS2\fR will only allow mounting
-the volume if the active cluster stack (and name) matches the one specified on-disk.
+\fBo2cb\fR. Other supported cluster stacks are \fBpcmk\fR (Pacemaker) and \fBcman\fR
+(rgmanager). Once set, \fIOCFS2\fR will only allow mounting the volume if the active
+cluster stack and cluster name matches the one specified on-disk.
.TP
\fB\-\-cluster\-name\fR
@@ -223,10 +218,11 @@ a \fIcluster\-stack\fR.
.TP
\fB\-\-global\-heartbeat\fR
-Enable global heartbeat for the \fBO2CB\fR cluster stack. This option is not required
-if the \fBO2CB\fR cluster stack with global heartbeat is online. However, if the
-cluster stack is not up, then this option is required as are \fIcluster\-stack\fR and
-\fIcluster\-name\fR. For more, refer to \fBo2cb(7)\fR.
+Enable the global heartbeat mode of the \fBo2cb\fR cluster stack. This option is not
+required if the \fBo2cb\fR cluster stack with global heartbeat is online as \fImkfs.ocfs2\fR
+will detect the active stack. However, if the cluster stack is not up, then this option
+is required alongwith \fIcluster\-stack\fR and \fIcluster\-name\fR. For more, refer to
+\fBo2cb(7)\fR.
.TP
\fB\-\-no-backup-super\fR
@@ -245,7 +241,7 @@ Quiet mode.
Specify a custom UUID in the plain (2A4D1C581FAA42A1A41D26EFC90C1315) or
traditional (2a4d1c58-1faa-42a1-a41d-26efc90c1315) format. This option in
\fBnot\fR recommended because the file system uses the UUID to uniquely identify
-a file system. \fIIf more than one file system were to have the same UUID, one
+a file system. \fBIf more than one file system were to have the same UUID, one
is very likely to encounter erratic behavior, if not, outright file system
corruption.\fR
@@ -267,28 +263,29 @@ consume the given number of file system blocks (see \fB-b\fR) on the device.
.SH "FEATURE COMPATIBILITY"
This section lists the file system features that have been added to the \fIOCFS2\fR
file system and the version that it first appeared in. The table below lists the versions
-of the mainline Linux kernel and that of the file system for the Enterprise Linux
-Distributions. Users should use this information to enable only those features that
-are available in the file system that they are using. Before enabling new features,
-users are advised to review to the section titled \fBfeature values\fR.
+of the mainline Linux kernel and ocfs2-tools. Users should use this information to
+enable only those features that are available in the file system that they are using.
+Before enabling new features, users are advised to review to the section titled
+\fBfeature values\fR.
.TS
CENTER ALLBOX;
-LI LI LI
-LB C C.
-Feature Mainline Kernel Version Enterprise OCFS2 Version
-local Linux 2.6.20 OCFS2 1.2
-sparse Linux 2.6.22 OCFS2 1.4
-unwritten Linux 2.6.23 OCFS2 1.4
-inline-data Linux 2.6.24 OCFS2 1.4
-extended-slotmap Linux 2.6.27 OCFS2 1.6
-metaecc Linux 2.6.29 OCFS2 1.6
-grpquota Linux 2.6.29 OCFS2 1.6
-usrquota Linux 2.6.29 OCFS2 1.6
-xattr Linux 2.6.29 OCFS2 1.6
-indexed-dirs Linux 2.6.30 OCFS2 1.6
-refcount Linux 2.6.32 OCFS2 1.6
-discontig-bg Linux 2.6.35 OCFS2 1.6
+LB LB LB
+LI C C.
+Feature Kernel Version Tools Version
+local Linux 2.6.20 ocfs2-tools 1.2
+sparse Linux 2.6.22 ocfs2-tools 1.4
+unwritten Linux 2.6.23 ocfs2-tools 1.4
+inline-data Linux 2.6.24 ocfs2-tools 1.4
+extended-slotmap Linux 2.6.27 ocfs2-tools 1.6
+metaecc Linux 2.6.29 ocfs2-tools 1.6
+grpquota Linux 2.6.29 ocfs2-tools 1.6
+usrquota Linux 2.6.29 ocfs2-tools 1.6
+xattr Linux 2.6.29 ocfs2-tools 1.6
+indexed-dirs Linux 2.6.30 ocfs2-tools 1.6
+refcount Linux 2.6.32 ocfs2-tools 1.6
+discontig-bg Linux 2.6.35 ocfs2-tools 1.6
+clusterinfo Linux 2.6.37 ocfs2-tools 1.8
.TE
.TS
@@ -297,13 +294,14 @@ L.
Users can query the features enabled in the file system as follows:
.TE
-.TS
-;
-L.
-[root at node1 ~]# tunefs.ocfs2 -Q "Label: %V\\nFeatures: %H %O\\n" /dev/sdg1
+.in +4n
+.nf
+.sp
+# \fBtunefs.ocfs2 -Q "Label: %V\\nFeatures: %H %O\\n" /dev/sdg1\fR
Label: apache_files_10
Features: sparse inline-data unwritten
-.TE
+.fi
+.in
.SH "FEATURE VALUES"
This section lists the hex values that are associated with the file system features.
@@ -334,7 +332,7 @@ mount option, or, disabling that on-disk feature using \fBtunefs.ocfs2\fR.
.TS
CENTER ALLBOX;
LI LI LI
-LB C C.
+LI C C.
Feature Category Hex value
local Incompat 8
sparse Incompat 10
@@ -345,6 +343,7 @@ indexed-dirs Incompat 400
metaecc Incompat 800
refcount Incompat 1000
discontig-bg Incompat 2000
+clusterinfo Incompat 4000
unwritten RO Compat 1
usrquota RO Compat 2
grpquota RO Compat 4
@@ -354,10 +353,12 @@ grpquota RO Compat 4
.SH "SEE ALSO"
.BR debugfs.ocfs2(8)
.BR fsck.ocfs2(8)
-.BR tunefs.ocfs2(8)
+.BR mount.ocfs2(8)
.BR mounted.ocfs2(8)
-.BR ocfs2console(8)
.BR o2cb(7)
+.BR o2image(8)
+.BR o2info(1)
+.BR tunefs.ocfs2(8)
.SH "AUTHORS"
Oracle Corporation
diff --git a/mount.ocfs2/mount.ocfs2.8.in b/mount.ocfs2/mount.ocfs2.8.in
index 3bd1d09..67f5dec 100644
--- a/mount.ocfs2/mount.ocfs2.8.in
+++ b/mount.ocfs2/mount.ocfs2.8.in
@@ -1,4 +1,4 @@
-.TH "mount.ocfs2" "8" "September 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "mount.ocfs2" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
mount.ocfs2 \- mount an \fIOCFS2\fR filesystem
.SH "SYNOPSIS"
@@ -6,18 +6,18 @@ mount.ocfs2 \- mount an \fIOCFS2\fR filesystem
.SH "DESCRIPTION"
.PP
\fBmount.ocfs2\fR mounts an \fIOCFS2\fR filesystem at \fIdir\fR. It is usually
-invoked indirectly by the mount(8) command when using the \fI-t ocfs2\fR option.
+invoked indirectly by the \fBmount(8)\fR command.
.SH "OPTIONS"
.TP
\fB\_netdev\fR
-The filesystem resides on a device that requires network access (used to prevent
-the system from attempting to mount these filesystems until the network has
-been enabled on the system). \fImount.ocfs2\fR transparently appends this option
-during mount. However, users mounting the volume via /etc/fstab must explicitly
-specify this mount option to delay the system from mounting the volume until
-after the network has been enabled.
+Indicates that the file system resides on a device that requires network access
+(used to prevent the system from attempting to mount these filesystems until the
+network has been enabled on the system). \fBmount.ocfs2(8)\fR transparently appends
+this option during mount. However, users mounting the volume via /etc/fstab must
+explicitly specify this mount option to delay the system from mounting the volume
+until after the network has been enabled.
.TP
\fBnoatime\fR
@@ -25,21 +25,22 @@ The file system will not update access time.
.TP
\fBrelatime\fR
-The file system only update atime if the previous atime is older than mtime or ctime.
+The file system will update atime only if the on-disk atime is older than mtime
+or ctime.
.TP
\fBstrictatime,atime\_quantum=nrsec\fR
The file system will always perform atime updates, but the minimum update
-interval is specified by atime_quantum. Atime_quantum defaults to 60 secs,
-set it to zero to always update atime. These two options need work together.
+interval is specified by atime_quantum which defaults to 60 secs. Set it to
+zero to always update atime. These two options need work together.
.TP
-\fBacl / noacl\fR
-Enables / disables POSIX ACLs (Access Control Lists) support.
+\fB[no]acl\fR
+Enables / disables POSIX ACLs (access control lists) support.
.TP
-\fBuser_xattr / nouser_xattr\fR
-Enables / disables Extended User Attributes.
+\fB[no]user_xattr\fR
+Enables / disables extended user attributes.
.TP
\fBcommit=nrsec\fR
@@ -47,47 +48,80 @@ Sync all data and metadata every nrsec seconds. The default value is 5 seconds.
Zero means default.
.TP
-\fBdata=ordered / data=writeback\fR
+\fBdata=[ordered|writeback]\fR
Specifies the handling of file data during metadata journalling.
-.RS 1.2i
+
+.RS
.TP
\fBordered\fR
-This is the default mode. All data is forced directly out to the main file
-system prior to its metadata being committed to the journal.
-.RE
-.RS 1.2i
+This is the default mode. Data is flushed to disk before the corresponding meta-data
+is committed to the journal.
+
.TP
\fBwriteback\fR
-Data ordering is not preserved - data may be written into the main file system
-after its metadata has been committed to the journal. This is rumored to be
-the highest-throughput option. While it guarantees internal file system
-integrity, it can allow old data to appear in files after a crash and journal
-recovery.
+Data ordering is not preserved - data may be flushed to disk after the corresponding
+meta-data is committed to the journal. This is rumored to be the higher-throughput
+option. While it guarantees internal file system integrity, it can allow old data to
+appear in files after a crash and journal recovery.
.RE
.TP
-\fBdatavolume\fR
-\fIThis mount option has been \fBdeprecated\fR in OCFS2 1.6\fR. It has been used
-in the past (\fIOCFS2 1.2\fR and \fIOCFS2 1.4\fR), to force the Oracle RDBMS to
-issue direct IOs to the hosted data files, control files, redo logs, archive logs,
-voting disk, cluster registry, etc. It has been deprecated because it is no longer
-required. Oracle RDBMS users should instead use the \fIinit.ora\fR parameter,
-\fIfilesystemio_options\fR, to enable direct IOs.
+\fBerrors=[remount-ro|errors=panic]\fR
+Specifies the behavior when an on-disk corruption is encountered.
+.RS
.TP
-\fBerrors=remount-ro / errors=panic\fR
-Define the behavior when an error is encountered. (Either remount the file
-system read-only, or panic and halt the system.) By default, the file system
-is remounted read only.
+\fBremount-ro\fR
+This is the default mode. The file system is remounted read-only.
+
+.TP
+\fBpanic\fR
+The system is halted via panic.
+.RE
.TP
\fBlocalflocks\fR
-This disables cluster-aware flock(2).
+This disables cluster-aware \fBflock(2)\fR.
+
+.TP
+\fBcoherency=[full|coherency]\fR
+Specifies the extent of coherency for the cached file data across the cluster.
+This mount option works with Linux kernel \fB2.6.37\fR and later.
+
+.RS
+.TP
+\fBfull\fR
+This is the default mode. The file system ensures the cached file data is coherent
+across the cluster for all IO modes.
+
+.TP
+\fBbuffered\fR
+The file system only ensures the cached file data coherency for buffered mode IOs.
+It does not perform IO serialization for direct IOs. This allows multiple nodes to
+perform concurrent direct IOs to the same file. This is the recommended mode for
+volumes hosting \fIdatabase\fR files.
+.RE
+
+.TP
+\fBresv_level=level\fR
+Specifies the level of allocation reservation for files. The higher the value, the more
+aggressive it is. Valid values are between 0 (reservation off) to 8 (maximum space
+for reservation). It defaults to 2. This mount option works with Linux kernel
+\fB2.6.35\fR and later.
+
+.TP
+\fBdir_resv_level=level\fR
+By default, directory reservation scales with file reserveration. Users should rarely
+need to change this value. If the file allocation reservation is turned off, this option
+will have no effect. This mount option works with Linux kernel \fB2.6.35\fR and later.
+.TP
+\fBinode64\fR
+Indicates that the file system can create inodes at any location in the volume, including
+those which will result in inode numbers greater than 4 billion.
.TP
-\fBintr / nointr\fR
-The default is intr that allows signals to interrupt cluster operations.
-nointr disables signals during cluster operations.
+\fB[no]intr\fR
+Specifies whether a signal can interrupt IOs. It is disabled by default.
.TP
\fBro\fR
@@ -97,16 +131,64 @@ Mount the file system read-only.
\fBrw\fR
Mount the file system read-write.
+.SH "NOTES"
+.PP
+To mount and umount a \fIOCFS2\fR volume, do:
+
+.in +4n
+.nf
+# \fBmount /dev/sda1 /mount/path\fR
+ ...
+# \fBumount /mount/path\fR
+.fi
+.in
+
+Users mounting a clustered volume should be aware of the following:
+
+.in +4n
+1. The cluster stack must to be online for a clustered mount to succeed.
+
+2. The clustered mount operation is not instantaneous; it must wait for the node to join the DLM domain.
+
+3. Likewise, clustered umount is also not instantaneous; it involves migrating all mastered lock-resources to the other nodes in the cluster.
+.in
+
+If the mount fails, detailed errors can be found via \fBdmesg(8)\fR. These might include incorrect
+cluster configuration (say, a missing node or incorrect IP address) or a firewall interfering with
+\fBo2cb\fR network traffic. Check the configuration as listed in \fBo2cb(7)\fR or the man page of
+the active cluster stack.
+
+To auto-mount volumes on startup, the file system tools include an \fIocfs2\fR init service.
+This runs after the \fIo2cb\fR init service has started the cluster. The \fIocfs2\fR init service
+mounts all \fIOCFS2\fR volumes listed in /etc/fstab.
+
+.in +4n
+.nf
+# \fBchkconfig --add o2cb\fR
+o2cb 0:off 1:off 2:on 3:on 4:off 5:on 6:off
+
+$ \fBchkconfig --add ocfs2\fR
+o2cb 0:off 1:off 2:on 3:on 4:off 5:on 6:off
+
+$ \fBcat /etc/fstab\fR
+ ...
+/dev/sda1 /u01 ocfs2 _netdev,defaults 0 0
+ ...
+.fi
+.in
+
.SH "SEE ALSO"
-.BR mkfs.ocfs2(8)
+.BR debugfs.ocfs2(8)
.BR fsck.ocfs2(8)
-.BR tunefs.ocfs2(8)
+.BR mkfs.ocfs2(8)
.BR mounted.ocfs2(8)
-.BR debugfs.ocfs2(8)
.BR o2cb(7)
+.BR o2image(8)
+.BR o2info(1)
+.BR tunefs.ocfs2(8)
.SH "AUTHORS"
Oracle Corporation
.SH "COPYRIGHT"
-Copyright \(co 2004, 2010 Oracle. All rights reserved.
+Copyright \(co 2004, 2011 Oracle. All rights reserved.
diff --git a/mounted.ocfs2/mounted.ocfs2.8.in b/mounted.ocfs2/mounted.ocfs2.8.in
index 99868fc..7d7c823 100644
--- a/mounted.ocfs2/mounted.ocfs2.8.in
+++ b/mounted.ocfs2/mounted.ocfs2.8.in
@@ -1,55 +1,66 @@
-.TH "mounted.ocfs2" "8" "September 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "mounted.ocfs2" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
mounted.ocfs2 \- Detects all \fIOCFS2\fR volumes on a system.
.SH "SYNOPSIS"
\fBmounted.ocfs2\fR [\fB\-d\fR] [\fB\-f\fR] [\fIdevice\fR]
.SH "DESCRIPTION"
.PP
-\fBmounted.ocfs2\fR is used to detect \fIOCFS2\fR volume(s) on a system.
-This tool assumes that the nodes detected on the system are part of the
-same cluster as the one specified in \fI/etc/ocfs2/cluster.conf\fR.
+\fBmounted.ocfs2\fR is used to detect \fIOCFS2\fR volume(s) on a system. When run without
+specifying a \fIdevice\fR, it scans all the partitions listed in /proc/partitions.
.SH "OPTIONS"
.TP
\fB\-d\fR
-Lists the \fIOCFS2\fR volumes along with their labels and uuids.
-If a device is not specified, it scans all the devices in /proc/partitions.
+Lists the \fIOCFS2\fR volumes along with their labels and uuids. It also lists the
+cluster stack, cluster name and the cluster flags. The possible cluster stacks are
+\fBo2cb\fR, \fBpcmk\fR and \fBcman\fR. \fBNone\fR indicates a local mount or a
+non-clustered volume. A \fBG\fR cluster flag indicates \fIglobal-heartbeat\fR for
+the \fBo2cb\fR cluster stack.
.TP
\fB\-f\fR
-Lists the \fIOCFS2\fR volumes along with the list of nodes that have
-mounted the volume. The node names are listed if the \fIO2CB\fR cluster
-is online. \fBNote:\fR As this information is gathered using dirty-read,
-the information may be stale.
+Lists the \fIOCFS2\fR volumes along with the list of nodes that have mounted the
+volume.
+
+.SH "NOTE"
+As this utility gathers information without taking any cluster locks, the information
+listed in the full detect mode could be stale. This is only problematic for volumes that
+were not cleanly umounted by the last node. Such volumes will show up mounted (as per
+this utility) on one or more nodes but are in fact not mounted on any node. Such volumes
+are awaiting slot-recovery which is auto-performed on the next mount (or file system check).
.SH "EXAMPLES"
-[root at node1 ~]# mounted.ocfs2 -d
-.br
-Device FS Stack UUID Label
-.br
-/dev/sdb1 ocfs2 local 2D1C9636FE38462DB43A75D1DA592207 vmvol
-.br
-/dev/sdj1 ocfs2 o2cb FF2E239B02D941FEAF25BDAE8DD553B9 dbstore
-.br
-
-
-[root at node1 ~]# mounted.ocfs2 -f
-.br
-Device FS Nodes
-.br
-/dev/sdb1 ocfs2 node15, node1
-.br
+.TS
+;
+L.
+[root at node1 ~]# \fBmounted.ocfs2 -d\fR
+Device Stack Cluster F UUID Label
+/dev/sdc1 None 23878C320CF3478095D1318CB5C99EED localmount
+/dev/sdd1 o2cb webcluster G 8AB016CD59FC4327A2CDAB69F08518E3 webvol
+/dev/sdg1 o2cb webcluster G 77D95EF51C0149D2823674FCC162CF8B logsvol
+/dev/sdh1 o2cb webcluster G BBA1DBD0F73F449384CE75197D9B7098 scratch
+/dev/sdk1 o2cb webcluster G DCDA2845177F4D59A0F2DCD8DE507CC3 hb1
+
+[root at node1 ~]# \fBmounted.ocfs2 -f\fR
+Device Stack Cluster F Nodes
+/dev/sdc1 None
+/dev/sdd1 o2cb webcluster G node1, node3, node10
+/dev/sdg1 o2cb webcluster G node1, node3, node10
+/dev/sdh1 o2cb webcluster G Not mounted
+/dev/sdk1 o2cb webcluster G node1, node3, node10
+.TE
.SH "SEE ALSO"
-.BR mkfs.ocfs2(8)
+.BR debugfs.ocfs2(8)
.BR fsck.ocfs2(8)
+.BR mkfs.ocfs2(8)
+.BR mount.ocfs2(8)
+.BR o2image(8)
+.BR o2info(1)
.BR tunefs.ocfs2(8)
-.BR debugfs.ocfs2(8)
-.BR ocfs2console(8)
-.BR o2cb(7)
.SH "AUTHORS"
Oracle Corporation
.SH "COPYRIGHT"
-Copyright \(co 2004, 2010 Oracle. All rights reserved.
+Copyright \(co 2004, 2011 Oracle. All rights reserved.
diff --git a/o2cb_ctl/o2cb.8.in b/o2cb_ctl/o2cb.8.in
index 376c0bc..cb7e5d7 100644
--- a/o2cb_ctl/o2cb.8.in
+++ b/o2cb_ctl/o2cb.8.in
@@ -1,4 +1,4 @@
-.TH "o2cb" "8" "September 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "o2cb" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
o2cb \- Cluster registration utility for the \fIO2CB\fR cluster stack.
.SH "SYNOPSIS"
@@ -105,36 +105,46 @@ not been enabled.
Stops global heartbeat on all regions for the cluster. It will silently exit
if global heartbeat has not been enabled.
+.TP
+\fBcluster-status\fR \fI[cluster-name]\fR
+Shows whether the given cluster is offline or online. If no cluster is provided,
+it shows the currently active cluster, if any.
+
.SH "EXAMPLE"
-.TS
-;
-L.
To create a cluster, mycluster having two nodes, node1 and node2, do:
-[root at node1 ~]# \fBo2cb add-cluster mycluster\fR
-[root at node1 ~]# \fBo2cb add-node mycluster node1 --ip 10.10.10.1\fR
-[root at node1 ~]# \fBo2cb add-node mycluster node2 --ip 10.10.10.2\fR
+.in +4n
+.nf
+.sp
+$ \fBo2cb add-cluster mycluster\fR
+$ \fBo2cb add-node mycluster node1 --ip 10.10.10.1\fR
+$ \fBo2cb add-node mycluster node2 --ip 10.10.10.2\fR
+.fi
+.in
To specify a global heartbeat device, /dev/sda1, do:
-[root at node1 ~]# \fBo2cb add-heartbeat mycluster /dev/sda1\fR
+.in +4n
+.nf
+.sp
+$ \fBo2cb add-heartbeat mycluster /dev/sda1\fR
+.fi
+.in
To enable global heartbeat, do:
-[root at node1 ~]# \fBo2cb heartbeat-mode mycluster global\fR
-
-.TE
-
+.in +4n
+.nf
+.sp
+$ \fBo2cb heartbeat-mode mycluster global\fR
+.fi
+.in
.SH "SEE ALSO"
-.BR mkfs.ocfs2(8)
-.BR debugfs.ocfs2(8)
-.BR fsck.ocfs2(8)
-.BR tunefs.ocfs2(8)
-.BR mounted.ocfs2(8)
-.BR ocfs2console(8)
.BR o2cb(7)
+.BR o2cb.sysconfig(5)
+.BR ocfs2.cluster.conf(5)
.SH "AUTHORS"
Oracle Corporation
.SH "COPYRIGHT"
-Copyright \(co 2010 Oracle. All rights reserved.
+Copyright \(co 2010, 2011 Oracle. All rights reserved.
diff --git a/o2cb_ctl/o2cb_ctl.8.in b/o2cb_ctl/o2cb_ctl.8.in
index b51db16..9a3c7db 100644
--- a/o2cb_ctl/o2cb_ctl.8.in
+++ b/o2cb_ctl/o2cb_ctl.8.in
@@ -134,7 +134,6 @@ $ o2cb_ctl -H -n node5 -a ip_address=192.168.1.5
.BR fsck.ocfs2(8)
.BR tunefs.ocfs2(8)
.BR mounted.ocfs2(8)
-.BR ocfs2console(8)
.BR o2cb(7)
.SH "AUTHORS"
diff --git a/o2image/o2image.8.in b/o2image/o2image.8.in
index c1b2c47..cc9dd47 100644
--- a/o2image/o2image.8.in
+++ b/o2image/o2image.8.in
@@ -1,13 +1,13 @@
-.TH "o2image" "8" "September 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "o2image" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
o2image \- Copy or restore \fIOCFS2\fR file system meta-data
.SH "SYNOPSIS"
\fBo2image\fR [\fB\-r\fR] [\fB\-I\fR] \fIdevice\fR \fIimage-file\fR
.SH "DESCRIPTION"
.PP
-\fBo2image\fR copies the \fIOCFS2\fR file system meta-data from the device to the specified image-file.
-This image file contains the file system skeleton that includes the inodes, directory names
-and file names. It does \fBnot\fR include any file data.
+\fBo2image\fR copies the \fIOCFS2\fR file system meta-data from the device to the
+specified image-file. This image file contains the file system skeleton that includes
+the inodes, directory names and file names. It does \fBnot\fR include any file data.
This image file can be useful to debug certain problems that are not reproducible otherwise.
Like on-disk corruptions. It could also be used to analyse the file system layout in an aging
@@ -39,26 +39,43 @@ corrupt the file system.\fR
.TP
\fB\-i\fR
-Interactive mode - before writing out the image file print it's size and ask whether to proceed. This setting only applies when '-I' is not specified. It can be useful when the file system holding the image is low on disk space and the user might need to free up space once the target image size is calculated.
+Interactive mode - before writing out the image file print it's size and ask whether
+to proceed. This setting only applies when '-I' is not specified. It can be useful
+when the file system holding the image is low on disk space and the user might need
+to free up space once the target image size is calculated.
.SH "EXAMPLES"
+Copies metadata blocks from /dev/sda1 device to sda1.out file.
-.TS
-;
-L.
-[root at node1 ~]# o2image /dev/sda1 sda1.out
-Copies metadata blocks from /dev/sda1 device to sda1.out file
+.in +4n
+.nf
+.sp
+# \fBo2image /dev/sda1 sda1.out\fR
+.fi
+.in
-[root at node1 ~] o2image -I /dev/sda1 sda1.out
-\fBUse with CAUTION\fR. Copies meta-data blocks from sda1.out onto the /dev/sda1 device.
-.TE
+Copies meta-data blocks from sda1.out onto the /dev/sda1 device. \fBAs this command
+over-writes an existing volume, please use with CAUTION\fR.
+
+.in +4n
+.nf
+.sp
+# \fBo2image -I /dev/sda1 sda1.out\fR
+.fi
+.in
.SH "SEE ALSO"
.BR debugfs.ocfs2(8)
.BR fsck.ocfs2(8)
+.BR fsck.ocfs2.checks(8)
+.BR mkfs.ocfs2(8)
+.BR mount.ocfs2(8)
+.BR mounted.ocfs2(8)
+.BR o2info(1)
+.BR tunefs.ocfs2(8)
.SH "AUTHORS"
Oracle Corporation
.SH "COPYRIGHT"
-Copyright \(co 2007, 2010 Oracle. All rights reserved.
+Copyright \(co 2007, 2011 Oracle. All rights reserved.
diff --git a/o2info/o2info.1.in b/o2info/o2info.1.in
index fd84967..dcb5db3 100644
--- a/o2info/o2info.1.in
+++ b/o2info/o2info.1.in
@@ -1,46 +1,54 @@
-.TH "o2info" "1" "October 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "o2info" "1" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
-o2info \- Dump \fIOCFS2\fR file system information on disk.
+o2info \- Show \fIOCFS2\fR file system information.
.SH "SYNOPSIS"
\fBo2info\fR [\fB\-C|\-\-cluster\-coherent\fR] [\fB\-\-fs\-features\fR] [\fB\-\-volinfo\fR] [\fB\-\-mkfs\fR] [\fB\-\-freeinode\fR] [\fB\-\-freefrag\fR \fIchunksize\fR] [\fB\-\-space\-usage\fR] [\fB\-\-filestat\fR] <\fBdevice or file\fR>
.SH "DESCRIPTION"
.PP
-\fBo2info\fR is designed to be an information tool, to display \fIOCFS2\fR file system information on disk. Its main goal on one hand, is to provide a tool to display fs info in a comprehensive way and providing the information which may be missing in \fBdebugfs.ocfs\fR and \fBtunefs.ocfs2\fR such as global bitmap free space fragmentation and free inode info for each slot, on the other hand, it also aims to become a info tool(\fBnot\fR an administration one), which therefore allows all users who may have no read privilege on the underlying device to use the utility. In practice, \fB'o2info /path/to/file/on/ocfs2/vol'\fR use a new \fBOCFS2_IOC_INFO\fR ioctl to get info from fs for a mounted case. For a privileged user(e.g, root), the same info however, can also be accessed by \fB'o2info /dev/sdxN'\fR to direcly manipulate the raw device.
+\fBo2info\fR shows information about \fIOCFS2\fR file systems. It differs from \fBdebugfs.ocfs2(8)\fR
+in that it allows users with limited read priviledges to query similar information. Users do not have
+to have the read privilege on the device as is expected by \fBdebugfs.ocfs2(8)\fR. This utility allows
+users to provide a path to an object on a mounted file system. The user needs to have the read priviledge
+on that object.
.SH "OPTIONS"
.TP
\fB\-C, \-\-cluster\-coherent\fR
-Enable cluster (in)coherency for mounted case, means it will attempt to acquire a global PR lock when querying info from a cluster filesystem, which may degrade the performance, default is none cluster-coherency.
+Force cluster coherency when querying a mounted file systems. The is disabled by default.
+Enable this only if accurate information is required as it involves taking cluster locks.
.TP
\fB\-\-fs\-features\fR
-List all compat, incompat and ro-compat fs features on \fIOCFS2\fR filesystem.
+Show all the file system features (compat, incompat, ro compat) enabled on the file system.
.TP
\fB\-\-volinfo\fR
-Dump basic volume information, such as blocksize, clustersize, volume label and UUID etc.
+Show file system information such as label, uuid, block and cluster sizes, node slots, etc.
.TP
\fB\-\-mkfs\fR
-Dump an original format of mkfs.ocfs's arguments, importantly, which can be used directly as a fresh mkfs retry:
-#mkfs.ocfs2 "$(o2info --mkfs /dev/name/or/path/of/file)" /dev/sdaX
+Show file system information in \fBmkfs.ocfs2(8)\fR format.
.TP
\fB\-\-freeinode\fR
-Display free inode space for all nodes in \fIOCFS2\fR cluster.
+Show the inode (allocated/free) count for all slots in the file system.
.TP
\fB\-\-freefrag\fR \fIchunksize\fR
-Report free space fragmentation on \fIOCFS2\fR filesystems, it prints how many chunks of chunksize are available as contiguous and aligned free space by scanning the global allocation bitmap. In the meantime, the percentage of contiguous free clusters of size and of alignment chunksize is reported, what's more, it also displays the minimum/maximum/average free chunk size in filesystem, along with a histogram of all free chunks. \fBNOTE\fR, chunksize specified must be a power of two and be equal to or larger than filesystem's clustersize.
+Show the free space fragmentation of the file system. The chunksize should be equal to or
+greater than the cluster size.
.TP
\fB\-\-space\-usage\fR
-Display file's usage information on disk in terms of how many physical blocks it consumed, how many reserved space and holes in it.
+Show the disk space used by a file in block sized units. It also provides the block count
+of the holes, shared extents and unwritten extents.
.TP
\fB\-\-filestat\fR
-Display inode's standard stat information, other than this, it also dumps inode's extended info such as extents, fragmentation, holes, unwritten and shared space in clusters.
+Show the extended \fBstat(1)\fR information that includes the number of clusters consumed
+by extended attributes, unwritten extents, shared extents and holes, along with the file
+fragmentation score.
.TP
\fB\-V, \-\-version\fR
@@ -48,80 +56,76 @@ Show version and exit.
.TP
\fB\-h, \-\-help\fR
-Display help and exit.
+Show help and exit.
+
+.SH "NOTE"
+.PP
+The utility uses custom info ioctls to query information from a mounted file system. As these
+info ioctls were added starting in Linux kernel 2.6.37, this utility will not work on mounted
+\fIOCFS2\fR file systems running on systems having older kernels.
.SH "EXAMPLES"
-[oracle at node1 ~]# o2info --volinfo /storage/testfile # For none-privileged users.
-.br
-[root at node1 ~]# o2info --volinfo /dev/sda1
-.br
- Label: ocfs2-volume
-.br
- UUID: 976D8E630B3A4F1F95497311A92901FC
-.br
+.PP
+Non-priviledged users can query the volume information by providing the path to a file on
+a mounted file system. Priviledged users can provide the path to the device.
+
+.in +4n
+.nf
+# \fBo2info --volinfo /ocfs2/testfile\fR
+ Label: webhome
+ UUID: 8AB016CD59FC4327A2CDAB69F08518E3
Block Size: 4096
-.br
-Cluster Size: 4096
-.br
- Node Slots: 4
-.br
- Features: backup-super strict-journal-super sparse inline-data xattr
-.br
+Cluster Size: 131072
+ Node Slots: 8
+ Features: backup-super strict-journal-super sparse extended-slotmap
+ Features: inline-data xattr indexed-dirs refcount discontig-bg clusterinfo
Features: unwritten
+.fi
+.in
+
+The same goes for querying file system fragmentation.
-[oracle at node1 ~]# o2info --freefrag 64 /storage/testfile # For none-privileged users.
-.br
-[root at node1 ~]# o2info --freefrag 64 /dev/sda1
-.br
+.in +4n
+.nf
+# \fBo2info --freefrag 128 /ocfs2/testfile\fR
Blocksize: 4096 bytes
-.br
-Clustersize: 32768 bytes
-.br
-Total clusters: 915704
-.br
-Free clusters: 891687 (97.4%)
-.br
-
-Min. free extent: 32 KB
-.br
-Max. free extent: 1032160 KB
-.br
-Avg. free extent: 663552 KB
-.br
-
-Chunksize: 131072 bytes (4 clusters)
-.br
-Total chunks: 228927
-.br
-Free chunks: 222888 (97.4%)
-.br
+Clustersize: 131072 bytes
+Total clusters: 409599
+Free clusters: 376537 (91.92%)
+
+Min. free extent: 256 KB
+Max. free extent: 4091648 KB
+Avg. free extent: 172672 KB
+
+Chunksize: 131072 bytes (1 clusters)
+Total chunks: 409600
+Free chunks: 376537 (91.9%)
HISTOGRAM OF FREE EXTENT SIZES:
-.br
Extent Size Range : Free extents Free Clusters Percent
-.br
- 32K... 64K- : 1 1 0.00%
-.br
- 1M... 2M- : 9 288 0.03%
-.br
- 8M... 16M- : 2 831 0.09%
-.br
- 32M... 64M- : 1 2047 0.23%
-.br
- 128M... 256M- : 1 8191 0.92%
-.br
- 256M... 512M- : 2 21706 2.43%
-.br
- 512M... 1024M- : 27 858623 96.29%
-.br
-
+ 256K... 512K- : 4 10 0.00%
+ 512K... 1024K- : 251 1179 0.31%
+ 1M... 2M- : 5 72 0.02%
+ 8M... 16M- : 3 288 0.08%
+ 32M... 64M- : 1 447 0.12%
+ 128M... 256M- : 2 3371 0.90%
+ 1G... 2G- : 1 13823 3.67%
+ 2G... 4G- : 12 357347 94.90%
+.fi
+.in
.SH "SEE ALSO"
.BR debugfs.ocfs2(8)
+.BR fsck.ocfs2(8)
+.BR fsck.ocfs2.checks(8)
+.BR mkfs.ocfs2(8)
+.BR mount.ocfs2(8)
+.BR mounted.ocfs2(8)
+.BR o2image(8)
.BR tunefs.ocfs2(8)
.SH "AUTHORS"
Oracle Corporation
.SH "COPYRIGHT"
-Copyright \(co 2010 Oracle. All rights reserved.
+Copyright \(co 2010, 2011 Oracle. All rights reserved.
diff --git a/ocfs2_hb_ctl/ocfs2_hb_ctl.8.in b/ocfs2_hb_ctl/ocfs2_hb_ctl.8.in
index 26fc01b..55e4783 100644
--- a/ocfs2_hb_ctl/ocfs2_hb_ctl.8.in
+++ b/ocfs2_hb_ctl/ocfs2_hb_ctl.8.in
@@ -1,6 +1,6 @@
-.TH "ocfs2_hb_ctl" "8" "September 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "ocfs2_hb_ctl" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
-ocfs2_hb_ctl \- Starts and stops the \fIOCFS2\fR heartbeat on a given device.
+ocfs2_hb_ctl \- Starts and stops the \fIO2CB\fR \fBlocal\fR heartbeat on a given device.
.SH "SYNOPSIS"
.B ocfs2_hb_ctl
@@ -33,9 +33,13 @@ ocfs2_hb_ctl \- Starts and stops the \fIOCFS2\fR heartbeat on a given device.
.SH "DESCRIPTION"
.PP
-\fBocfs2_hb_ctl\fR starts and stops the heartbeat on a \fIOCFS2\fR device.
+\fBocfs2_hb_ctl\fR starts and stops \fBlocal\fR heartbeat on a \fIOCFS2\fR device.
\fBUsers are strongly urged not to use this tool directly\fR. It is automatically
-invoked by \fImount.ocfs2\fR and other tools that require heartbeat notifications.
+invoked by \fBmount.ocfs2(8)\fR and other tools that require heartbeat notifications.
+
+This utility only operates in the \fBlocal\fR heartbeat mode. It fails silently
+when run in \fBglobal\fR heartbeat mode. More information on the heartbeat modes
+can be found in \fBo2cb(7)\fR.
The tools accepts devices to be specified by its name or its uuid. Service denotes
the application that is requesting the heartbeat notification.
@@ -72,15 +76,14 @@ This option is usable only with the \fBO2CB\fR cluster stack.
Displays help and exit.
.SH "SEE ALSO"
-.BR mkfs.ocfs2(8)
-.BR fsck.ocfs2(8)
-.BR tunefs.ocfs2(8)
-.BR mounted.ocfs2(8)
-.BR ocfs2console(8)
-.BR debugfs.ocfs2(8)
+.BR mount.ocfs2(8)
+.BR o2cb(7)
+.BR o2cb(8)
+.BR o2cb.sysconfig(5)
+.BR ocfs2.cluster.conf(5)
.SH "AUTHORS"
Oracle Corporation
.SH "COPYRIGHT"
-Copyright \(co 2004, 2010 Oracle. All rights reserved.
+Copyright \(co 2004, 2011 Oracle. All rights reserved.
diff --git a/tunefs.ocfs2/tunefs.ocfs2.8.in b/tunefs.ocfs2/tunefs.ocfs2.8.in
index 61de226..4184e08 100644
--- a/tunefs.ocfs2/tunefs.ocfs2.8.in
+++ b/tunefs.ocfs2/tunefs.ocfs2.8.in
@@ -1,4 +1,4 @@
-.TH "tunefs.ocfs2" "8" "September 2010" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "tunefs.ocfs2" "8" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
tunefs.ocfs2 \- Change \fIOCFS2\fR file system parameters.
.SH "SYNOPSIS"
@@ -6,7 +6,7 @@ tunefs.ocfs2 \- Change \fIOCFS2\fR file system parameters.
.SH "DESCRIPTION"
.PP
-\fBtunefs.ocfs2\fR is used to adjust \fIOCFS2\fR file system parameters on disk.
+\fBtunefs.ocfs2(8)\fR is used to adjust \fIOCFS2\fR file system parameters on disk.
The tool expects the cluster to be online as it needs to take the appropriate
cluster locks to write safely to disk.
@@ -19,11 +19,11 @@ volume so that it can be mounted on the node that has the original volume mounte
.TP
\fB\-\-fs\-features=\fR\fI[no]sparse...\fR
-Turn specific file system features on or off. \fItunefs.ocfs2\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. For a list of feature names, see the man page for \fBmkfs.ocfs2\fR.
+Turn specific file system features on or off. \fBtunefs.ocfs2(8)\fR will attempt to enable or disable the feature list provided. To enable a feature, include it in the list. To disable a feature, prepend \fBno\fR to the name. For a list of feature names, refer to \fBmkfs.ocfs2(8)\fR.
.TP
\fB\-J, \-\-journal\-options\fR \fIoptions\fR
-Modify the journal using options specified on the command\-line. Journal options are comma separated, and may take an argument using the equals ('=') sign. For a list of possible options, see the man page for \fBmkfs.ocfs2\fR.
+Modify the journal using options specified on the command\-line. Journal options are comma separated, and may take an argument using the equals ('=') sign. For a list of possible options, refer to \fBmkfs.ocfs2(8)\fR.
.TP
\fB\-L, \-\-label\fR \fIvolume\-label\fR
@@ -39,7 +39,7 @@ the space consumed by the journals for those slots.
.TP
\fB\-S, \-\-volume\-size\fR
Grow the size of the \fIOCFS2\fR file system. If \fIblocks-count\fR is not
-specified, \fItunefs.ocfs2\fR extends the volume to the current size of
+specified, \fBtunefs.ocfs2(8)\fR extends the volume to the current size of
the device.
.TP
@@ -79,7 +79,12 @@ Quiet mode.
.TP
\fB\-U, \-\-uuid\-reset\fR[=\fInew-uuid]\fR
-Set the volume UUID for the file system. If not provided, will auto generate a new UUID. The format of the provided UUID should be 178BDC83D50241EF94EB474A677D498B or 178BDC83-D502-41EF-94EB-474A677D498B.
+Reset the volume UUID of the file system. If not provided, the utility will auto
+generate it. For custom UUID, specify in either the plain (2A4D1C581FAA42A1A41D26EFC90C1315)
+or the traditional (2a4d1c58-1faa-42a1-a41d-26efc90c1315) format. Users specifying
+custom UUIDs must be careful to ensure that no two volumes have the same UUID. \fBIf more
+than one file system were to have the same UUID, one is very likely to encounter erratic
+behavior, if not, outright file system corruption.\fR
.TP
\fB\-v, \-\-verbose\fR
@@ -102,7 +107,7 @@ Always answer No in interactive command line.
Backs up the superblock to fixed offsets (1G, 4G, 16G, 64G, 256G and 1T)
on disk. This option is useful for users to backup the superblock on volumes
that the user either explicitly disallowed while formatting, or, used a
-version of \fImkfs.ocfs2\fR (1.2.2 or older) that did not provide this
+version of \fBmkfs.ocfs2(8)\fR (1.2.2 or older) that did not provide this
facility.
.TP
@@ -115,29 +120,32 @@ Updating on-disk cluster information to match the running cluster.
.TP
\fIblocks-count\fR
-During resize, \fItunefs.ocfs2\fR automatically determines the size of the given
+During resize, \fBtunefs.ocfs2(8)\fR automatically determines the size of the given
device and grows the file system such that it uses all of the available space on
the device. This optional argument specifies that the file system should be
extended to consume only the given number of file system blocks on the device.
.SH "EXAMPLES"
-[root at node1 ~]# tunefs.ocfs2 -Q "UUID = %U\\nNumSlots = %N\\n" /dev/sda1
-.br
+.TS
+;
+L.
+[root at node1 ~]# \fBtunefs.ocfs2 -Q "UUID = %U\\nNumSlots = %N\\n" /dev/sda1\fR
UUID = CBB8D5E0C169497C8B52A0FD555C7A3E
-.br
NumSlots = 4
-.br
+.TE
.SH "SEE ALSO"
-.BR mkfs.ocfs2(8)
-.BR fsck.ocfs2(8)
.BR debugfs.ocfs2(8)
+.BR fsck.ocfs2(8)
+.BR fsck.ocfs2.checks(8)
+.BR mkfs.ocfs2(8)
+.BR mount.ocfs2(8)
.BR mounted.ocfs2(8)
-.BR ocfs2console(8)
-.BR o2cb(7)
+.BR o2image(8)
+.BR o2info(1)
.SH "AUTHORS"
Oracle Corporation
.SH "COPYRIGHT"
-Copyright \(co 2004, 2010 Oracle. All rights reserved.
+Copyright \(co 2004, 2011 Oracle. All rights reserved.
--
1.7.4.1
More information about the Ocfs2-tools-devel
mailing list