[Ocfs2-tools-commits] smushran commits r1221 - in trunk: debugfs.ocfs2 fsck.ocfs2 mkfs.ocfs2 mount.ocfs2 mounted.ocfs2 o2cb_ctl ocfs2cdsl ocfs2console tunefs.ocfs2

svn-commits@oss.oracle.com svn-commits at oss.oracle.com
Mon Jul 24 16:10:13 CDT 2006


Author: smushran
Signed-off-by: mfasheh
Date: 2006-07-24 16:10:11 -0500 (Mon, 24 Jul 2006)
New Revision: 1221

Modified:
   trunk/debugfs.ocfs2/debugfs.ocfs2.8.in
   trunk/fsck.ocfs2/fsck.ocfs2.8.in
   trunk/fsck.ocfs2/fsck.ocfs2.checks.8.in
   trunk/mkfs.ocfs2/mkfs.ocfs2.8.in
   trunk/mount.ocfs2/mount.ocfs2.8.in
   trunk/mounted.ocfs2/mounted.ocfs2.8.in
   trunk/o2cb_ctl/o2cb_ctl.8.in
   trunk/ocfs2cdsl/ocfs2cdsl.8.in
   trunk/ocfs2console/ocfs2console.8.in
   trunk/tunefs.ocfs2/tunefs.ocfs2.8.in
Log:
manpages refreshed
Signed-off-by: mfasheh

Modified: trunk/debugfs.ocfs2/debugfs.ocfs2.8.in
===================================================================
--- trunk/debugfs.ocfs2/debugfs.ocfs2.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/debugfs.ocfs2/debugfs.ocfs2.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,28 +1,55 @@
-.TH "debugfs.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "debugfs.ocfs2" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 debugfs.ocfs2 \- OCFS2 file system debugger.
 .SH "SYNOPSIS"
-\fBdebugfs.ocfs2\fR [\fB\-f\fR \fIcmdfile\fR] [\fB\-V\fR] [\fB\-w\fR] [\fB\-?\fR] [\fIdevice\fR]
+\fBdebugfs.ocfs2\fR [\fB\-f\fR \fIcmdfile\fR] [\fB\-R\fR \fIcommand\fR] [\fB\-V\fR] [\fB\-w\fR] [\fB\-n\fR] [\fB\-?\fR] [\fIdevice\fR]
+.TP
+\fBdebugfs.ocfs2\fR \fB\-l\fR [\fItracebit\fR ... [\fBallow\fR|\fBoff\fR|\fBdeny\fR]] ...
+.TP
+\fBdebugfs.ocfs2\fR \fB\-d, --decode\fR \fIlockname\fR
+.TP
+\fBdebugfs.ocfs2\fR \fB\-e, --encode\fB \fIlock_type inode_num generation\fR
+
 .SH "DESCRIPTION"
 .PP 
-The \fBdebugfs.ocfs2\fR is an interactive file system debugger. It can be
-used to examine the state of an OCFS2 filesystem. \fIdevice\fR is the
-special file corresponding the device containing the OCFS2 filesystem
-(e.g \fI/dev/hdxx\fR).
+The \fBdebugfs.ocfs2\fR program is an interactive file system debugger useful
+in displaying on-disk \fBOCFS2\fR filesystem structures on the specified \fIdevice\fR.
+
 .SH "OPTIONS"
+
 .TP
-\fB\-f, --file\fR \fIcmdfile\fR 
-Causes \fBdebugfs.ocfs2\fR to read in commands from \fIcmdfile\fR and
-execute them. It exits after all the commands are executed.
+\fB\-d, --decode\fR \fIlockname\fR
+Display the lock type, inode number and the inode generation number encoded in the \fIlockname\fR.
 
 .TP
-\fB\-w, --write\fR 
-Specifies that the filesystem should be opened in \fIread-write\fR mode.
-Without this option, the filesystem is opened in the \fIread-only\fR mode.
+\fB\-e, --encode\fR \fIlock_type inode_num generation\fR
+Display the lockname obtained by encoding the lock type, inode number and the inode generation number.
 
 .TP
+\fB\-f, --file\fR \fIcmdfile\fR
+Executes the debugfs commands in \fIcmdfile\fR.
+
+.TP
+\fB\-l\fR [\fItracebit\fR ... [\fBallow\fR|\fBoff\fR|\fBdeny\fR]] ...
+Control \fBOCFS2\fR filesystem tracing by enabling and disabling trace bits.
+Do \fIdebugfs.ocfs2 -l\fR to get the list of all trace bits.
+
+.TP
+\fB\-n, --noprompt\fR
+Hide prompt.
+
+.TP
+\fB\-R, --request\fR \fIcommand\fR
+Executes a single debugfs command.
+
+.TP
+\fB\-w, --write\fR
+Opens the filesystem in \fIRW\fR mode. By default the filesystem is opened
+in \fIRO\fR mode.
+
+.TP
 \fB\-V, --version\fR 
-Print version information and exit.
+Display version and exit.
 
 .TP
 \fB\-?, --help\fR 
@@ -32,7 +59,7 @@
 Many \fBdebugfs.ocfs2\fR commands take a \fIfilespec\fR as an argument
 to specify an inode (as opposed to a pathname) in the filesystem which
 is currently opened by \fBdebugfs.ocfs2\fR. The \fIfilespec\fR argument
-may be specified in two forms. The first form is an inode number
+may be specified in two forms. The first form is an inode number or lockname
 surrounded by angle brackets, e.g., <32>. The second form is a pathname;
 if the pathname is prefixed by a forward slash ('/'), then it is
 interpreted relative to the root of the filesystem which is currently
@@ -43,9 +70,19 @@
 to the root of the system directory of the filesystem opened by
 \fBdebugfs.ocfs2\fR.
 
+.SH "LOCKNAMES"
+Locknames are specially formatted strings used by the file system
+to uniquely identify objects in the filesystem. Most locknames used
+by \fIOCFS2\fR are generated using the inode number and its generation
+number and can be decoded using the \fIdecode\fR command or used directly
+in place of an inode number in commands requiring a \fIfilespec\fR. Like
+inode numbers, locknames need to be enclosed in angle brackets, e.g.,
+<M000000000000000040c40c044069cf>. To generate a lockname for a given object,
+use the \fIencode\fR command.
+
 .SH "COMMANDS"
 This is a list of the commands which debugfs.ocfs2 supports.
-
+ 
 .TP
 \fIcat filespec\fR
 Dump the contents of inode \fIfilespec\fR to stdout.
@@ -67,6 +104,10 @@
 Show the currently open device.
 
 .TP
+\fIdecode <lockname>\fR
+Display the inode number encoded in the \fIlockname\fR.
+
+.TP
 \fIdump [-p] filespec outfile\fR
 Dump the contents of the inode \fIfilespec\fR to the output file
 \fIoutfile\fR. If the \fI-p\fR is given, set the owner, group,
@@ -74,14 +115,34 @@
 those of \fIfilespec\fR.
 
 .TP
+\fIencode filespec\fR
+Display the lockname for the \fIfilespec\fR.
+
+.TP
 \fIextent block#\fR
 Display the contents of the extent structure at \fIblock#\fR.
 
 .TP
+\fIfindpath [<lockname>|<inode#>]\fR
+Display the pathname for the inode specified by \fIlockname\fR or \fIinode#\fR. This
+command does not display all the hard-linked paths for the inode.
+
+.TP
+\fIfs_locks\fR
+Display the locks and their status as maintained by the filesystem. This command
+expects the debugfs filesystem mounted, \fImount -t debugfs debugfs /path\fR,
+at the appropriate path. If \fI/sys/kernel/debug\fR exists on your distribution,
+mount it at that path. Else, mount it at \fI/debug\fR.
+
+.TP
 \fIgroup block#\fR
-Display the contents of the group structure at \fIblock#\fR.
+Display the contents of the group descriptor at \fIblock#\fR.
 
 .TP
+\fIhb\fR
+Display the contents of the heartbeat system file.
+
+.TP
 \fIhelp, ?\fR
 Print the list of commands understood by \fBdebugfs.ocfs2\fR.
 
@@ -91,15 +152,23 @@
 to the \fIdirectory\fR on the native filesystem.
 
 .TP
+\fIlocate [<lockname>|<inode#>] ...\fR
+Display all pathnames for the inode(s) specified by \fIlockname\fRs or \fIinode#\fRs.
+
+.TP
 \fIlogdump node#\fR
 Display the contents of the journal for node \fInode#\fR.
 
 .TP
-\fIls [-l] \fIfilespec\fR
+\fIls [-l] filespec\fR
 Print the listing  of the files in the directory \fIfilespec\fR. The
 \fI-l\fR flag will list files in the long format.
 
 .TP
+\fIncheck [<lockname>|<inode#>] ...\fR
+See \fIlocate\fR.
+
+.TP
 \fIopen device\fR
 Open the filesystem on \fIdevice\fR.
 
@@ -120,7 +189,7 @@
 
 .TP
 \fIstat filespec\fR
-Display the contents of the inode structure of the inode \fIfilespec\fR.
+Display the contents of the inode structure for the \fIfilespec\fR.
 
 .TP
 \fIstats\fR
@@ -141,4 +210,4 @@
 Oracle Corporation
 
 .SH "COPYRIGHT"
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/fsck.ocfs2/fsck.ocfs2.8.in
===================================================================
--- trunk/fsck.ocfs2/fsck.ocfs2.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/fsck.ocfs2/fsck.ocfs2.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH "fsck.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "fsck.ocfs2" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 fsck.ocfs2 \- Check an \fIOCFS2\fR file system.
 .SH "SYNOPSIS"
@@ -17,7 +17,7 @@
 should be read from.
 
 .TP
-\fB\-b\fR \fIblocksize\fR
+\fB\-B\fR \fIblocksize\fR
 The \fIblock size\fR, specified in bytes, can range from 512 to 4096.  A value of 0, the default, is used to indicate that the blocksize should be automatically detected.
 
 .TP
@@ -96,4 +96,4 @@
 by Theodore Y. Ts'o <tytso at mit.edu>.
 
 .SH "COPYRIGHT"
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/fsck.ocfs2/fsck.ocfs2.checks.8.in
===================================================================
--- trunk/fsck.ocfs2/fsck.ocfs2.checks.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/fsck.ocfs2/fsck.ocfs2.checks.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH "fsck.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "fsck.ocfs2" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 fsck.ocfs2.checks \- Consistency checks that 
 .BR fsck.ocfs2(8)
@@ -640,4 +640,4 @@
 Oracle Corporation.
 
 .SH "COPYRIGHT"
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/mkfs.ocfs2/mkfs.ocfs2.8.in
===================================================================
--- trunk/mkfs.ocfs2/mkfs.ocfs2.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/mkfs.ocfs2/mkfs.ocfs2.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH "mkfs.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "mkfs.ocfs2" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 mkfs.ocfs2 \- Creates an \fIOCFS2\fR file system.
 .SH "SYNOPSIS"
@@ -108,4 +108,4 @@
 Oracle Corporation
 
 .SH "COPYRIGHT"
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/mount.ocfs2/mount.ocfs2.8.in
===================================================================
--- trunk/mount.ocfs2/mount.ocfs2.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/mount.ocfs2/mount.ocfs2.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH "mount.ocfs2" "8" "May 2006" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "mount.ocfs2" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 mount.ocfs2 \-  mount using the Oracle Cluster File System 2 (OCFS2)
 .SH "SYNOPSIS"
@@ -25,4 +25,4 @@
 Oracle Corporation
 
 .SH "COPYRIGHT"
-Copyright \(co 2002, 2004-2006 Oracle Corporation
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/mounted.ocfs2/mounted.ocfs2.8.in
===================================================================
--- trunk/mounted.ocfs2/mounted.ocfs2.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/mounted.ocfs2/mounted.ocfs2.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH "mounted.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "mounted.ocfs2" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 mounted.ocfs2 \- Detects all \fIOCFS2\fR volumes on a system.
 .SH "SYNOPSIS"
@@ -51,4 +51,4 @@
 Oracle Corporation
 
 .SH "COPYRIGHT"
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/o2cb_ctl/o2cb_ctl.8.in
===================================================================
--- trunk/o2cb_ctl/o2cb_ctl.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/o2cb_ctl/o2cb_ctl.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH "o2cb_ctl" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "o2cb_ctl" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 o2cb_ctl \- Control program for the \fIO2CB\fR cluster service.
 .SH "SYNOPSIS"
@@ -23,8 +23,8 @@
 .SH "DESCRIPTION"
 .PP 
 \fBo2cb_ctl\fR is the control program for the \fIO2CB\fR cluster service.
-One is strongly recommended not to use this tool directly but instead
-use \fIocfs2console\fR to do the same.
+Users are not advised to use this program directly but instead use the
+\fIO2CB\fR init service and/or \fIocfs2console\fR.
 
 .SH "OPTIONS"
 
@@ -104,7 +104,7 @@
 
 o2cb_ctl -C -n node5 -t node -a number=5
 .br
-	-a ip_address=139.185.118.5 -a ip_port=7777
+	-a ip_address=192.168.0.5 -a ip_port=7777
 .br
 	-a cluster=mycluster
 
@@ -116,7 +116,7 @@
 .TP
 To change the IP address of node5:
 
-o2cb_ctl -H -n node5 -a ip_address=130.35.68.5
+o2cb_ctl -H -n node5 -a ip_address=192.168.1.5
 
 .SH "SEE ALSO"
 .BR mkfs.ocfs2(8)
@@ -130,4 +130,4 @@
 Oracle Corporation
 
 .SH "COPYRIGHT"
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/ocfs2cdsl/ocfs2cdsl.8.in
===================================================================
--- trunk/ocfs2cdsl/ocfs2cdsl.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/ocfs2cdsl/ocfs2cdsl.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH "ocfs2cdsl" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "ocfs2cdsl" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 ocfs2cdsl \- Create context dependent symbolic link (CDSL).
 .SH "SYNOPSIS"
@@ -83,4 +83,4 @@
 Oracle Corporation
 
 .SH "COPYRIGHT"
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/ocfs2console/ocfs2console.8.in
===================================================================
--- trunk/ocfs2console/ocfs2console.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/ocfs2console/ocfs2console.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH OCFS2CONSOLE 8 "January 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH OCFS2CONSOLE 8 "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH NAME
 ocfs2console - GUI console for \fIOCFS2\fR.
 .SH SYNOPSIS
@@ -22,4 +22,4 @@
 Oracle Corporation
 
 .SH COPYRIGHT
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.

Modified: trunk/tunefs.ocfs2/tunefs.ocfs2.8.in
===================================================================
--- trunk/tunefs.ocfs2/tunefs.ocfs2.8.in	2006-07-24 21:09:11 UTC (rev 1220)
+++ trunk/tunefs.ocfs2/tunefs.ocfs2.8.in	2006-07-24 21:10:11 UTC (rev 1221)
@@ -1,4 +1,4 @@
-.TH "tunefs.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "tunefs.ocfs2" "8" "July 2006" "Version @VERSION@" "OCFS2 Manual Pages"
 .SH "NAME"
 tunefs.ocfs2 \- Change \fIOCFS2\fR file system parameters.
 .SH "SYNOPSIS"
@@ -69,4 +69,4 @@
 Oracle Corporation
 
 .SH "COPYRIGHT"
-Copyright \(co 2004, 2005 Oracle. All rights reserved.
+Copyright \(co 2004, 2006 Oracle. All rights reserved.




More information about the Ocfs2-tools-commits mailing list