[Ocfs2-tools-commits] mmatsuna commits r691 - in trunk: mounted.ocfs2 o2cb_ctl ocfs2cdsl tunefs.ocfs2

Fri Mar 18 18:54:11 CST 2005

Author: mmatsuna
Date: 2005-03-18 18:54:09 -0600 (Fri, 18 Mar 2005)
New Revision: 691

Added:
   trunk/mounted.ocfs2/mounted.ocfs2.8.in
   trunk/o2cb_ctl/o2cb_ctl.8.in
   trunk/ocfs2cdsl/ocfs2cdsl.8.in
   trunk/tunefs.ocfs2/tunefs.ocfs2.8.in
Log:
Added the following man pages files :
ocfs2cdsl/ocfs2cdsl.8.in
mounted.ocfs2/mounted.ocfs2.8.in
tunefs.ocfs2/tunefs.ocfs2.8.in
o2cb_ctl/o2cb_ctl.8.in


Added: trunk/mounted.ocfs2/mounted.ocfs2.8.in
===================================================================

--- trunk/mounted.ocfs2/mounted.ocfs2.8.in	2005-03-19 00:35:53 UTC (rev 690)
+++ trunk/mounted.ocfs2/mounted.ocfs2.8.in	2005-03-19 00:54:09 UTC (rev 691)
@@ -0,0 +1,28 @@
+.TH "mounted.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.SH "NAME"
+mounted.ocfs2 \- detect and print nodes that have an OCFS2 partition mounted.
+.SH "SYNOPSIS"
+\fBmounted.ocfs2\fR [\fB\-d\fR] [\fB\-f\fR] \fIdevice\fR
+.SH "DESCRIPTION"
+.PP 
+\fBmounted.ocfs2\fR is used to verify if there are nodes that have a specific OCFS2 \fIdevice\fR mounted.
+.SH "OPTIONS"
+.TP
+\fB\-d\fR
+Perform a quick detection of the \fIdevice\fR. With this option, only the label and uuid will be displayed.
+
+.TP
+\fB\-f\fR
+Perform a full detection of the \fIdevice\fR. With this option, the node name will be displayed in addition to the label and uuid.
+
+.SH "BUGS"
+Stuff.
+
+.SH "SEE ALSO"
+.BR ocfs2(8)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2002, 2004 Oracle Corporation

Added: trunk/o2cb_ctl/o2cb_ctl.8.in
===================================================================
--- trunk/o2cb_ctl/o2cb_ctl.8.in	2005-03-19 00:35:53 UTC (rev 690)
+++ trunk/o2cb_ctl/o2cb_ctl.8.in	2005-03-19 00:54:09 UTC (rev 691)
@@ -0,0 +1,113 @@
+.TH "o2cb_ctl" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.SH "NAME"
+o2cb_ctl \- Control program for the OCFS2 Cluster Software.
+.SH "SYNOPSIS"
+.B o2cb_ctl 
+\fB\-C\fR \fB\-n\fR \fIobject\fR \fB\-t\fR type\fR [\fB\-i\fR] [\fB\-a\fR \fIattribute\fR ]
+.br
+.B o2cb_ctl 
+\fB\-D\fR \fB\-n\fR \fIobject\fR [\fB\-u\fR]
+.br
+.B o2cb_ctl 
+\fB\-I\fR [\fB\-o\|\-z\fR] \fB\-l\fR \fImanager\fR> [\fB\-n\fR \fIobject\fR>] [\fB\-t\fR \fItype\fR] [\fB\-a\fR \fIattribute\fR]
+.br
+.B o2cb_ctl 
+\fB\-H\fR [\fB\-n\fR \fIobject\fR] [\fB\-t\fR \fItype\fR>] [\fB\-a\fR \fIattribute\fR>] 
+.br
+.B o2cb_ctl 
+\fB\-h\fR
+.br
+.B o2cb_ctl 
+\fB\-V\fR
+
+.SH "DESCRIPTION"
+.PP 
+\fBo2cb_ctl\fR is the control program for he OCFS2 Cluster Software. Oracle strongly recommends users to make use of \fIocfs2console\fR. \fBo2cb_ctl\fR is used to configure, modify and start the OCFS2 Cluster Software (file \fI/etc/cluster.conf\fR). One should be careful when configuring the cluster to make sure all nodes have the exact same copy of the file \fI/etc/cluster.conf\fR or the cluster will not work properly.
+
+.SH "OPTIONS"
+
+.TP
+\fB\-C\fR
+Create a new OCFS2 Cluster Configuration.
+
+.TP
+\fB\-D\fR
+Delete an existing OCFS2 Cluster Configuration.
+
+.TP
+\fB\-I\fR
+Print information about OCFS2 Cluster Configuration.
+
+.TP
+\fB\-H\fR
+Change an existing OCFS2 Cluster Configuration.
+
+.TP
+\fB\-h\fR
+Displays help and exit.
+
+.TP
+\fB\-V\fR
+Print version and exit.
+
+.SH "OTHER OPTIONS"
+
+.TP
+\fB\-a\fR \fI<attribute>\fR
+\fI<attribute>\fR is in format "parameter=value", where the parameter is a valid parameter that can be set in the file \fI/etc/cluster.conf\fR.
+
+.TP
+\fB\-i\fR
+Valid only with \fB\-C\fR. When creating something (\fInode\fR or \fIcluster\fR), it will also install it in the live cluster. If the parameter is not specified, then only update the \fI/etc/cluster.conf\fR.
+
+.TP
+\fB\-n\fR \fIobject\fR
+\fIobject\fR is usually the node name or cluster name. In the \fI/etc/cluster.conf\fR file, it would be the value of the name parameter for any of the sections (\fIcluster\fR or \fInode\fR).
+
+.TP
+\fB\-o\fR
+Valid only with \fB\-I\fR. Using this parameter, if one asks o2cb_ctl to list all nodes, it will output it in a format suitable for shell parsing.
+
+.TP
+\fB\-t\fR \fItype\fR
+\fItype\fR can be cluster, node or heartbeat.
+
+.TP
+\fB\-u\fR
+Valid only with \fB\-D\fR. When deleting something (\fInode\fR or \fIcluster\fR), it will also remove it from the live cluster. If the parameter is not specified, then only update the \fI/etc/cluster.conf\fR.
+
+.TP
+\fB\-z\fR
+Valid only with \fB\-I\fR. This is the default. If one asks o2cb_ctl to list all nodes, it will give a verbose listing.
+
+.SH "EXAMPLES"
+
+.HP
+In the cluster "mycluster", create the node "node5":
+
+o2cb_ctl -C -n node5 -t node -a number=5 -a ip_address=139.185.118.5 -a ip_port=7777 \\
+.br
+-a cluster=mycluster
+
+.TP
+To query the IP address of node5:
+
+o2cb_ctl -I -n node5 -a ip_address
+
+.TP
+To change the IP address of node5:
+
+o2cb_ctl -H -n node5 -a ip_address=130.35.68.5
+
+
+.SH "BUGS"
+Stuff.
+
+.SH "SEE ALSO"
+.BR ocfs2(8)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2002, 2004 Oracle Corporation

Added: trunk/ocfs2cdsl/ocfs2cdsl.8.in
===================================================================
--- trunk/ocfs2cdsl/ocfs2cdsl.8.in	2005-03-19 00:35:53 UTC (rev 690)
+++ trunk/ocfs2cdsl/ocfs2cdsl.8.in	2005-03-19 00:54:09 UTC (rev 691)
@@ -0,0 +1,57 @@
+.TH "ocfs2cdsl" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.SH "NAME"
+ocfs2cdsl \- Create context dependent symbolic link (CDSL).
+.SH "SYNOPSIS"
+\fBocfs2cdsl\fR [\fB-cfnqvV\fR] [\fB\-t\fR \fIhostname|mach|os|nodenum\fR] [\fIfilename\fR]
+.SH "DESCRIPTION"
+.PP 
+\fBocfs2cdsl\fR is used to create context dependent symbolic link for \fIfilename\fR (file or directory) for a node. A CDSL \fIfilename\fR will have its own image for a specific node, but a common name in the OCFS2. 
+
+.SH "OPTIONS"
+
+.TP
+\fB\-t\fR \fIhostname|mach|os|nodenum\fR
+\fIhostname|mach|os|nodenum\fR - One of these options should be specified in order to create the CDSL. As for information, \fIhostname\fR would be the same as the output of "uname -n", \fImach\fR would be the output of "uname -m", \fIos\fR would the the output of "uname -o" and \fInodenum\fR would be the global node number for the hostname in the \fI/etc/cluster.conf\fR file.
+
+.TP
+\fB\-c\fR
+During the creation of the CDSL, if the file does exist, the data will be copied to the new location.
+
+.TP
+\fB\-f\fR
+Force the execution of the command.
+
+.TP
+\fB\-n\fR
+Will perform a check of all options and motions, but will not perform any change on disk.
+
+.TP
+\fB\-q\fR
+Execute \fBocfs2cdsl\fR in quiet mode.
+
+.TP
+\fB\-v\fR
+Execute \fBocfs2cdsl\fR in verbose mode.
+
+.TP
+\fB\-V\fR
+Print version and exit.
+
+.SH "EXAMPLE"
+
+If one wants to have a shared ORACLE_HOME installed on an OCFS2 partition, and wants to have node specific configuration \fIfilename\fR in the same shared ORACLE_HOME, one can have the \fIfilename\fR created by ocfs2cdsl. A good example would be the directory $ORACLE_HOME/network/agent. Node1 could have its own view of the directory, which is different from Node2 view, but having the exact same full pathname.
+
+ocfs2cdsl -c -t hostname $ORACLE_HOME/network/agent
+.TP
+In the example above, a CDSL directoy will be created and the contents of the \fIagent\fR directoy will copied to the new location. If the same is to be executed on all nodes, and assuming that no changes are made to the directory, each one of the nodes would have the exact same view of the \fIagent\fR directory. In case of change in the \fIagent\fR directory after the creation of the CDSL, only the node performing the change would be able to see it. All other nodes would still have the same initial view of the \fIagent\fR directory.
+.SH "BUGS"
+Stuff.
+
+.SH "SEE ALSO"
+.BR ocfs2(8)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2002, 2004 Oracle Corporation

Added: trunk/tunefs.ocfs2/tunefs.ocfs2.8.in
===================================================================
--- trunk/tunefs.ocfs2/tunefs.ocfs2.8.in	2005-03-19 00:35:53 UTC (rev 690)
+++ trunk/tunefs.ocfs2/tunefs.ocfs2.8.in	2005-03-19 00:54:09 UTC (rev 691)
@@ -0,0 +1,48 @@
+.TH "tunefs.ocfs2" "8" "March 2005" "Version @VERSION@" "OCFS2 Manual Pages"
+.SH "NAME"
+tunefs.ocfs2 \- Change OCFS2 partition parameters.
+.SH "SYNOPSIS"
+\fBtunefs.ocfs2\fR [\fB\-L\fR \fIvolume-label\fR] [\fB\-n\fR \fInumber-of-nodes\fR] [\fB\-j\fR \fIjournal-size\fR] [\fB\-S\fR \fIvolume-size\fR] [\fB\-qvV\fR] \fIdevice\fR
+.SH "DESCRIPTION"
+.PP 
+\fBtunefs.ocfs2\fR is used to adjust OCFS2 file system parameters on disk. In order to prevent data loss, \fBtunefs.ocfs2\fR will not perform any action to a specified device if any node has it mounted. 
+.SH "OPTIONS"
+.TP
+\fB\-L\fR \fIvolume\-label\fR
+\fIvolume\-label\fR specifiy the new label name of a device. The maximum \fIvolume-label\fR lenght allowed is 64 bytes.
+
+.TP
+\fB\-n\fR \fInumber\-of\-nodes\fR
+\fInumber\-of\-nodes\fR specify the number of nodes that will be sharing a specific OCFS2 partition. The maximum value allowed for \fInumber\-of\-nodes\fR is 255. Note that one can increase the number of nodes, but not decrease it. Future versions may allow decrease of the number of nodes.
+
+.TP
+\fB\-j\fR \fIjournal\-size\fR
+\fIjournal\-size\fR specify the size of the OCFS2 journal used by the partition. Valid size values range from 4Mb to 500Mb. Note that one can increase the size of the OCFS2 journal, but not decrease it. Future versions may allow decrease of the OCFS2 journal size.
+
+.TP
+\fB\-S\fR \fIvolume\-size\fR 
+\fIvolume\-size\fR specify the new volume size of an OCFS2 partition. A partition should be physically extended prior to use this option.
+
+.TP
+\fB\-q\fR 
+Execute \fBtunefs.ocfs2\fR in quiet mode. 
+
+.TP
+\fB\-v\fR 
+Execute \fBtunefs.ocfs2\fR in verbose mode.
+
+.TP
+\fB\-V\fR 
+Show version and exit.
+
+.SH "BUGS"
+Stuff.
+
+.SH "SEE ALSO"
+.BR ocfs2(8)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2002, 2004 Oracle Corporation

