[Ocfs2-tools-commits] mmatsuna commits r690 - in trunk:
debugfs.ocfs2 mkfs.ocfs2
svn-commits at oss.oracle.com
svn-commits at oss.oracle.com
Fri Mar 18 18:35:55 CST 2005
Author: mmatsuna
Date: 2005-03-18 18:35:53 -0600 (Fri, 18 Mar 2005)
New Revision: 690
Modified:
trunk/debugfs.ocfs2/debugfs.ocfs2.8.in
trunk/mkfs.ocfs2/mkfs.ocfs2.8.in
Log:
mmatsuna - Updated man pages files mkfs.ocfs2.8.in and debugfs.ocfs2.8.in
Modified: trunk/debugfs.ocfs2/debugfs.ocfs2.8.in
===================================================================
--- trunk/debugfs.ocfs2/debugfs.ocfs2.8.in 2005-03-19 00:32:22 UTC (rev 689)
+++ trunk/debugfs.ocfs2/debugfs.ocfs2.8.in 2005-03-19 00:35:53 UTC (rev 690)
@@ -1,30 +1,30 @@
-.TH "debugfs.ocfs2" "8" "Dec 2004" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "debugfs.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
debugfs.ocfs2 \- OCFS2 file system debugger.
.SH "SYNOPSIS"
-\fBdebugfs.ocfs2\fR [\fB\-V\fR] [\fB\-?\fR] [\fB\-w\fR] [\fB\-f cmdfile\fR] \fIdevice\fR
+\fBdebugfs.ocfs2\fR [\fB\-f\fR \fIcmdfile\fR] [\fB\-V\fR] [\fB\-w\fR] [\fB\-?\fR] [\fIdevice\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 /dev/hdxx).
+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).
.SH "OPTIONS"
.TP
-\fB\-f cmdfile\fR
+\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.
.TP
-\fB\-w\fR
+\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.
.TP
-\fB\-V\fR
+\fB\-V, --version\fR
Print version information and exit.
.TP
-\fB\-?\fR
+\fB\-?, --help\fR
Displays help and exit.
.SH "SPECIFYING FILES"
-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.ocfs\fR. The \fIfilespec\fR argument may be specified in two forms. The first form is an inode number 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 opened by \fBdebugfs.ocfs2\fR. If not, the path is interpreted relative to the current working directory as maintained by \fBdebugfs.ocfs2\fR, which can be modified using the command \fIcd\fR. If the pathname is prefixed by a double forward slash ('//'), then it is interpreted relative to the root of the system directory of the filesystem opened by \fBdebugfs.ocfs2\fR.
+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 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 opened by \fBdebugfs.ocfs2\fR. If not, the path is interpreted relative to the current working directory as maintained by \fBdebugfs.ocfs2\fR, which can be modified using the command \fIcd\fR. If the pathname is prefixed by a double forward slash ('//'), then it is interpreted relative to the root of the system directory of the filesystem opened by \fBdebugfs.ocfs2\fR.
.SH "COMMANDS"
This is a list of the commands which debugfs.ocfs2 supports.
@@ -54,12 +54,12 @@
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, timestamps and permissions information on \fIoutfile\fR to match those of \fIfilespec\fR.
.TP
-\fIextent <block#>\fR
-Display the contents of the extent structure at \fI<block#>\fR.
+\fIextent block#\fR
+Display the contents of the extent structure at \fIblock#\fR.
.TP
-\fIgroup <block#>\fR
-Display the contents of the group structure at \fI<block#>\fR.
+\fIgroup block#\fR
+Display the contents of the group structure at \fIblock#\fR.
.TP
\fIhelp, ?\fR
@@ -70,11 +70,11 @@
Change the current working directory of the \fBdebugfs.ocfs2\fR process to the \fIdirectory\fR on the native filesystem.
.TP
-\fIlogdump <node#>\fR
-Display the contents of the journal for node \fI<node#>\fR.
+\fIlogdump node#\fR
+Display the contents of the journal for node \fInode#\fR.
.TP
-\fIls [-l] filespec\fR
+\fIls [-l] \fIfilespec\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
@@ -105,7 +105,7 @@
This tool has been modelled after \fBdebugfs\fR, a debugging tool for ext2.
.SH "SEE ALSO"
-.BR ocfs(5)
+.BR ocfs2(8)
.SH "AUTHOR"
Oracle Corporation
Modified: trunk/mkfs.ocfs2/mkfs.ocfs2.8.in
===================================================================
--- trunk/mkfs.ocfs2/mkfs.ocfs2.8.in 2005-03-19 00:32:22 UTC (rev 689)
+++ trunk/mkfs.ocfs2/mkfs.ocfs2.8.in 2005-03-19 00:35:53 UTC (rev 690)
@@ -1,29 +1,33 @@
-.TH "mkfs.ocfs2" "8" "July 2004" "Version @VERSION@" "OCFS2 Manual Pages"
+.TH "mkfs.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
.SH "NAME"
mkfs.ocfs2 \- Build an OCFS2 file system.
.SH "SYNOPSIS"
-\fBmkfs.ocfs2\fR [ \fB\-b\fR \fIblocksize\fR ] [ \fB\-c\fR \fIcluster\-size\fR ] [ \fB\-L\fR \fIvolume\-label\fR ] [ \fB\-n\fR \fInumber\-of\-nodes\fR ] [ \fB\-q\fR ] [ \fB\-v\fR ] [ \fB\-V\fR ] \fIdevice\fR [ \fIblocks\-count\fR ]
+\fBmkfs.ocfs2\fR [ \fB\-b\fR \fIblocksize\fR ] [ \fB\-c\fR \fIcluster\-size\fR ] [ \fB\-L\fR \fIvolume\-label\fR ] [ \fB\-n\fR \fInumber\-of\-nodes\fR ] [ \fB\-j\fR \fIjournal\-size\fR ] [ \fB\-q\fR ] [ \fB\-v\fR ] [ \fB\-V\fR ] \fIdevice\fR
.SH "DESCRIPTION"
.PP
\fBmkfs.ocfs2\fR is used to build an OCFS2 file system on a \fIdevice\fR, usually a partition in a shared disk. In order to prevent data loss, \fBmkfs.ocfs2\fR will not format a specified device if a node has it mounted. Different than OCFS, there is no need to mount the partition exclusively after formatting it.
.SH "OPTIONS"
.TP
\fB\-b\fR \fIblocksize\fR
-\fIBlocksize\fR can be specified in bytes or kbytes. The value of the blocksize can range from 512 to 4096 bytes (512-4k).
+\fIBlocksize\fR can be specified in bytes or kbytes. The value of the /fIblocksize\fR can range from 512 to 4096 bytes (512-4k).
.TP
-\fB\-C\fR \fIcluster\-size\fR
-\fICluster\-size\fR are specified in kbytes and range from 4k to 1M. The size of the cluster-size will determine the maximum filesystem size possible for the OCFS2 (32Gb\-8Tb). For database files, 128k \fIcluster\-size\fR is still recommended. For use as a generic filesystem, 4k \fIcluster\-size\fR is recommended.
+\fB\-c\fR \fIcluster\-size\fR
+\fIcluster\-size\fR are specified in kbytes and range from 4k to 1M. The size of the \fIcluster\-size\fR will determine the maximum filesystem size possible for the OCFS2 (32Gb\-8Tb). For database files, 128k \fIcluster\-size\fR is still recommended. For use as a generic filesystem, 4k \fIcluster\-size\fR is recommended.
.TP
\fB\-L\fR \fIvolume\-label\fR
-\fIVolume\-label\fR is usefull when the LABEL option is used to mount the partitions.
+\fIVolume\-label\fR is usefull when the \fILABEL\fR option is used to mount the partitions. The maximum \fIvolume-label\fR lenght allowed is 64 bytes.
.TP
\fB\-n\fR \fInumber\-of\-nodes\fR
-\fInumber\-of\-nodes\fR specify the max number of nodes where the partition will be mounted. That will allow a better control of allocated space and make OCFS2 more efficient.
+\fInumber\-of\-nodes\fR specify the max number of nodes where the partition will be mounted. The maximum \fInumber\-of\-nodes\fR allowed is 255. That will allow a better control of allocated space and make OCFS2 more efficient.
.TP
+\fB\-j\fR \fIjournal\-size\fR
+\fIjournal\-size\fR specify the size of the journal that will be created. Valid sizes range from 4Mb to 500Mb.
+
+.TP
\fB\-q\fR
Execute \fBmkfs.ocfs2\fR in quiet mode.
@@ -35,10 +39,6 @@
\fB\-V\fR
Print version and exit.
-.TP
-\fB[blocks\-count]\fR
-Specify the number of blocks on the device. If not specified, \fBmkfs.ocfs2\fR will automatically take the whole partition and format it.
-
.SH "BUGS"
Stuff.
More information about the Ocfs2-tools-commits
mailing list