[Ocfs-tools-commits]
manish commits r192 - in trunk: . load_ocfs ocfs2/debugfs.ocfs2
ocfs2/mkfs.ocfs2
svn-commits at oss.oracle.com
svn-commits at oss.oracle.com
Fri Aug 6 15:53:51 CDT 2004
Author: manish
Date: 2004-08-06 14:53:49 -0500 (Fri, 06 Aug 2004)
New Revision: 192
Added:
trunk/load_ocfs/ocfs.conf.5.in
trunk/ocfs2/debugfs.ocfs2/debugfs.ocfs2.8.in
trunk/ocfs2/mkfs.ocfs2/mkfs.ocfs2.8.in
Modified:
trunk/configure.in
trunk/load_ocfs/Makefile
trunk/ocfs2/debugfs.ocfs2/Makefile
trunk/ocfs2/mkfs.ocfs2/Makefile
Log:
Manpages from Marcos
Modified: trunk/configure.in
===================================================================
--- trunk/configure.in 2004-08-03 02:16:02 UTC (rev 191)
+++ trunk/configure.in 2004-08-06 19:53:49 UTC (rev 192)
@@ -198,8 +198,11 @@
ocfs/fsck/fsck.ocfs.8
ocfs/format/mkfs.ocfs.8
ocfs/format/tuneocfs.8
+ocfs2/debugfs.ocfs2/debugfs.ocfs2.8
+ocfs2/mkfs.ocfs2/mkfs.ocfs2.8
ocfs_uid_gen/ocfs_uid_gen.8
load_ocfs/load_ocfs.8
+load_ocfs/ocfs.conf.5
ocfstool/ocfstool.8
vendor/common/ocfs-tools.spec
ocfs2/libocfs2/ocfs2_err.et
Modified: trunk/load_ocfs/Makefile
===================================================================
--- trunk/load_ocfs/Makefile 2004-08-03 02:16:02 UTC (rev 191)
+++ trunk/load_ocfs/Makefile 2004-08-06 19:53:49 UTC (rev 192)
@@ -4,7 +4,7 @@
SBIN_EXTRA = load_ocfs
-MANS = load_ocfs.8
+MANS = load_ocfs.8 ocfs.conf.5
INSTALL_RULES = install-sbin-links install-man-links
@@ -18,6 +18,6 @@
&& rm -f load_ocfs2.8 \
&& $(LN_S) load_ocfs.8 load_ocfs2.8
-DIST_FILES = load_ocfs.8.in
+DIST_FILES = load_ocfs.8.in ocfs.conf.5.in
include $(TOPDIR)/Postamble.make
Added: trunk/load_ocfs/ocfs.conf.5.in
===================================================================
--- trunk/load_ocfs/ocfs.conf.5.in 2004-08-03 02:16:02 UTC (rev 191)
+++ trunk/load_ocfs/ocfs.conf.5.in 2004-08-06 19:53:49 UTC (rev 192)
@@ -0,0 +1,82 @@
+.TH "/etc/ocfs.conf" "5" "July 2004" "Version @VERSION@" "OCFS2 Manual Pages"
+.SH "NAME"
+/etc/ocfs.conf \- OCFS/OCFS2 configuration file.
+.SH "SYNOPSIS"
+\fB/etc/ocfs.conf\fR
+.SH "DESCRIPTION"
+.PP
+\fB/etc/ocfs.conf\fR is commonly used by OCFS and OCFS2 to store the module initialization parameters. During the initialization process, the \fIload_ocfs/load_ocfs2\fR scripts will read and validate all the parameters set in the file \fI/etc/ocfs.conf\fR and use them to load the OCFS/OCFS2 module. If the \fI/etc/ocfs.o\fR file is missing, then the module will not be loaded. Oracle does recommend the use of the \fIocfstool\fR utility to generate a proper \fI/etc/ocfs.conf\fR file before trying to load the module. The \fI/etc/ocfs.conf\fR file is a plain text file and the format is purely "parameter = value".
+.SH "OPTIONS"
+
+.TP
+\fBnode_name\fR \fI(Mandatory - OCFS/OCFS2)\fR
+Specify the public hostname of the system.
+
+.TP
+\fBnode_number\fR \fI(OCFS/OCFS2)\fR
+Specify a node number related to the node name. If left blank, ocfs will choose a node number for the host. Use this parameter only when really necessary.
+
+.TP
+\fBdebug_context\fR \fI(OCFS/OCFS2)\fR
+
+.TP
+\fBdebug_level\fR \fI(OCFS/OCFS2)\fR
+
+.TP
+\fBip_address\fR \fI(Mandatory - OCFS/OCFS2)\fR
+Specify the IP Address of the interface used by OCFS/OFS2 to vote.
+
+.TP
+\fBip_port\fR \fI(Mandatory - OCFS)\fR
+Specify the IP port of the interface used by OCFS to vote.
+
+.TP
+\fBip_port_v2\fR \fI(Mandatory - OCFS2)\fR
+Specify the IP port of the interface used by OCFS2 to vote.
+
+.TP
+\fBguid\fR \fI(Mandatory - OCFS/OCFS2)\fR
+This parameter is automatically filled by the \fIocfs_uid_gen\fR or \fIocfstool\fR program. One should not fill this parameter manually. See \fIocfs_uid_gen(8)\fR for details.
+
+.TP
+\fBcomm_voting\fR \fI(OCFS)\fR
+When set to 1, enable network vote, 0 (zero) disable. The default value is 1. This parameter is not used by OCFS2.
+
+
+.SH "Examples"
+The following is an example of a /etc/ocfs.conf file used by OCFS2:
+
+ #
+ # ocfs ipcdlm config
+ #
+ ip_address = 139.185.118.88
+ ip_port_v2 = 7001
+ node_name = ca-test2
+ guid = FF201F07A0F44DB0BC120002A5DA2765
+
+The next example show a /etc/ocfs.conf configured to run both, OCFS and OCFS2 in parallel.
+
+ #
+ # ocfs ipcdlm config
+ #
+ ip_address = 139.185.118.88
+ ip_port = 7000
+ ip_port_v2 = 7001
+ node_name = ca-test2
+ comm_voting = 1
+ guid = FF201F07A0F44DB0BC120002A5DA2765
+
+.SH "BUGS"
+Stuff.
+
+.SH "SEE ALSO"
+.BR ocfs(5)
+.BR ocfstool(8)
+.BR ocfs_uid_gen(8)
+.BR load_ocfs(8)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2002 Oracle Corporation
Modified: trunk/ocfs2/debugfs.ocfs2/Makefile
===================================================================
--- trunk/ocfs2/debugfs.ocfs2/Makefile 2004-08-03 02:16:02 UTC (rev 191)
+++ trunk/ocfs2/debugfs.ocfs2/Makefile 2004-08-06 19:53:49 UTC (rev 192)
@@ -16,8 +16,10 @@
OBJS = $(subst .c,.o,$(CFILES))
-DIST_FILES = $(CFILES) $(HFILES) README
+MANS = debugfs.ocfs2.8
+DIST_FILES = $(CFILES) $(HFILES) README debugfs.ocfs2.8.in
+
DIST_RULES = dist-subdircreate
dist-subdircreate:
Added: trunk/ocfs2/debugfs.ocfs2/debugfs.ocfs2.8.in
===================================================================
--- trunk/ocfs2/debugfs.ocfs2/debugfs.ocfs2.8.in 2004-08-03 02:16:02 UTC (rev 191)
+++ trunk/ocfs2/debugfs.ocfs2/debugfs.ocfs2.8.in 2004-08-06 19:53:49 UTC (rev 192)
@@ -0,0 +1,100 @@
+.TH "debugfs.ocfs2" "8" "July 2004" "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\-N\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). \fBdebugfs.ocfs2\fR will automatically bind the \fIdevice\fR to a raw device to perform the operations and unbind it when the program is terminated. It is recommended that the system have at least one free raw device (not bound to any block device) defined or \fIdebufs.ocfs2\fR will fail.
+.SH "OPTIONS"
+.TP
+\fB\-V\fR
+Print version information and exit.
+
+.TP
+\fB\-?\fR
+Displays help and exit.
+
+.TP
+\fB\-w\fR
+Turn on write support.
+
+.TP
+\fB\-N\fR
+Do not bind \fIdevice\fR to raw.
+
+.SH "COMMANDS"
+This is a list of the commands which debugfs.ocfs2 supports.
+
+.TP
+\fIcurdev\fR
+Show current working device (raw device).
+
+.TP
+\fIopen\fR <device>
+Open a device
+
+.TP
+\fIclose\fR
+Close a device
+
+.TP
+\fIshow_super_stats, stats\fR \fI[-h]\fR
+Show superblock
+
+.TP
+\fIshow_inode_info, stat\fR \fI<blknum>\fR
+Show inode
+
+.TP
+\fIpwd\fR
+Print working directory
+
+.TP
+\fIls\fR <blknum>
+List directory
+
+.TP
+\fIcat\fR \fI<blknum>\fR \fI[outfile]\fR
+Prints or concatenates file to stdout/outfile
+
+.TP
+\fIdump\fR \fI<blknum>\fR \fI<outfile>\fR
+Dumps file to outfile
+
+.TP
+\fInodes\fR
+List of nodes
+
+.TP
+\fIpublish\fR
+Publish blocks
+
+.TP
+\fIvote\fR
+Vote blocks
+
+.TP
+\fIlogdump\fR \fI<nodenum>\fR
+Prints journal file for the node
+
+.TP
+\fIhelp, ?\fR
+This information
+
+.TP
+\fIquit, q\fR
+Exit the program
+
+.SH "BUGS"
+Stuff.
+
+.SH "SEE ALSO"
+.BR ocfs(5)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2002, 2004 Oracle Corporation
Modified: trunk/ocfs2/mkfs.ocfs2/Makefile
===================================================================
--- trunk/ocfs2/mkfs.ocfs2/Makefile 2004-08-03 02:16:02 UTC (rev 191)
+++ trunk/ocfs2/mkfs.ocfs2/Makefile 2004-08-06 19:53:49 UTC (rev 192)
@@ -62,8 +62,10 @@
# && $(LN_S) mkfs.ocfs.8 mkfs.ocfs2.8 \
# && $(LN_S) tuneocfs.8 resizeocfs.8
-DIST_FILES = $(VERSION_FILES) $(VERSION_SRC) mkfs2.c #mkfs.ocfs2.8.in
+MANS = mkfs.ocfs2.8
+DIST_FILES = $(VERSION_FILES) $(VERSION_SRC) mkfs2.c mkfs.ocfs2.8.in
+
mkfs.ocfs2: mkfs.o
$(LINK) $(LIBOCFS2_LIBS) $(COM_ERR_LIBS)
Added: trunk/ocfs2/mkfs.ocfs2/mkfs.ocfs2.8.in
===================================================================
--- trunk/ocfs2/mkfs.ocfs2/mkfs.ocfs2.8.in 2004-08-03 02:16:02 UTC (rev 191)
+++ trunk/ocfs2/mkfs.ocfs2/mkfs.ocfs2.8.in 2004-08-06 19:53:49 UTC (rev 192)
@@ -0,0 +1,52 @@
+.TH "mkfs.ocfs2" "8" "July 2004" "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 ]
+.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).
+
+.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.
+
+.TP
+\fB\-L\fR \fIvolume\-label\fR
+\fIVolume\-label\fR is usefull when the LABEL option is used to mount the partitions.
+
+.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.
+
+.TP
+\fB\-q\fR
+Execute \fBmkfs.ocfs2\fR in quiet mode.
+
+.TP
+\fB\-v\fR
+Execute \fBmkfs.ocfs2\fR in verbose mode.
+
+.TP
+\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.
+
+.SH "SEE ALSO"
+.BR ocfs2(8)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2002, 2004 Oracle Corporation
More information about the Ocfs-tools-commits
mailing list