- merge 0.7rc1 from b_devel to HEAD (20030612 merge point)

[fs/lustre-release.git] / lustre / doc / lmc.lyx

diff --git a/lustre/doc/lmc.lyx b/lustre/doc/lmc.lyx
index 2cbcdc0..7a90023 100644 (file)
--- a/lustre/doc/lmc.lyx
+++ b/lustre/doc/lmc.lyx
@@ -142,6 +142,44 @@ To generate configuration data associated with systems in a Lustre cluster:
 -
 \emph default 
 -add\SpecialChar ~
+node Adds a new node in the cluster configuration.
+ 
+\begin_deeper 
+\layout Standard
+
+The arguments required are:
+\layout Description
+
+--node\SpecialChar ~
+''node_name'' This will create a new node with the given name if not
+ already present.
+\layout Description
+
+--timeout\SpecialChar ~
+<num> Timeout before going into recovery
+\layout Description
+
+--lustre_upcall\SpecialChar ~
+<path> Set the location of the Lustre upcall scripts used
+ by the client for recovery
+\layout Description
+
+--portals_upcall\SpecialChar ~
+<path> Specify the location of the Portals upcall scripts
+ used by the client for recovery
+\layout Description
+
+--upcall\SpecialChar ~
+<path> Specify the location of both (Lustre and Portals) upcall
+ scripts used by the client for recovery
+\end_deeper 
+\layout Description
+
+
+\emph on 
+-
+\emph default 
+-add\SpecialChar ~
 net Adds a network device descriptor for the given node, with parameters
  as indicated.
 \begin_deeper 
@@ -159,7 +197,7 @@ The arguments required are:
 --nettype\SpecialChar ~
 <type> This can be 
 \series bold 
-tcp, elan, gm.
+tcp, elan, gm, scimac.
 \layout Description
 
 --nid\SpecialChar ~
@@ -193,6 +231,9 @@ client
  configuration.
 \layout Description
 
+--hostaddr addr
+\layout Description
+
 --router Optional flag to mark this node as a router
 \layout Description
 
@@ -210,13 +251,26 @@ profiles
 \layout Description
 
 --port\SpecialChar ~
-[port] Optional argument to indicate the tcp port.
+[port] Optional arguement to indicate the tcp port.
  The default is 988.
  
 \layout Description
 
 --tcpbuf\SpecialChar ~
-<size> Optional argument.
+<size> Optional arguement.
+ The default TCP buffer size is 1MB.
+\layout Description
+
+--irq_affinity\SpecialChar ~
+0|1 Optional arguement.
+ Default is 0.
+\layout Description
+
+--nid_exchange\SpecialChar ~
+0|1 Optional arguement since some OSTs might not have the
+ required support.
+ This is turned off by default, value of 1 will turn it ON.
+ 
 \end_deeper 
 \layout Description
 
@@ -225,6 +279,11 @@ mds
 \begin_deeper 
 \layout Description
 
+--node\SpecialChar ~
+<node\SpecialChar ~
+name> Name of the node on which the MDS resides
+\layout Description
+
 --mds\SpecialChar ~
 <mds_name> 
 \layout Description
@@ -235,8 +294,8 @@ mds
 \layout Description
 
 --size\SpecialChar ~
-<size> Optional argument indicating the size of the device to be created
- (used typically for loop devices).
+<size> Optional arguement indicating the size of the device to be
+ created (used typically for loop devices).
 \layout Description
 
 --node\SpecialChar ~
@@ -246,6 +305,23 @@ mds
 --node
 \emph default 
  argument, and it must not be a profile node.
+\layout Description
+
+--fstype\SpecialChar ~
+extN|ext3 Optional arguement used to specify the file system type.
+ Default is ext3.
+\layout Description
+
+--journal_size\SpecialChar ~
+<size> Optional arguement to specify the journal size for
+ the ext2/ext3 file system.
+ The size should be in the units expected by 
+\series bold 
+mkfs
+\series default 
+, so for ext3 it should be in MB.
+ If this is option is not used, the ext2/ext3 filesystem will be configured
+ with the default journal size.
 \end_deeper 
 \layout Description
 
@@ -272,11 +348,13 @@ mds_name
 \layout Description
 
 --stripe_cnt\SpecialChar ~
-<count>
+<count> A value of 0 for this means to stripe on all available
+ OSTs.
+ Default is 0.
 \layout Description
 
 --stripe_pattern\SpecialChar ~
-<pattern> Pattern can be 0.
+<pattern> Only Pattern 0 (RAID 0) is supported currently.
 \end_deeper 
 \layout Description
 
@@ -286,8 +364,8 @@ ost Creates an OBD, OST, and OSC.
 \begin_deeper 
 \layout Description
 
---obd\SpecialChar ~
-<name> Assign a name to the OBD device.
+--ost\SpecialChar ~
+<name> Assign a name to the OST device.
 \layout Description
 
 --node\SpecialChar ~
@@ -305,18 +383,36 @@ ost Creates an OBD, OST, and OSC.
 [size]
 \layout Description
 
+--osdtype\SpecialChar ~
+obdfilter|obdecho 
+\layout Description
+
 --lov\SpecialChar ~
-<name> Name of LOV to which this OSC will be attached.
+<name> Optional arguement.
+ Name of LOV to which this OSC will be attached.
  
 \layout Description
 
---obduuid\SpecialChar ~
-UUID Specify the UUID of the OBD device.
- The default value is 
-\emph on 
-OBD_nodename_UUID
-\emph default 
-.
+--ostuuid\SpecialChar ~
+UUID Specify the UUID of the OST device.
+ 
+\layout Description
+
+--fstype\SpecialChar ~
+extN|ext3 Optional arguement used to specify the file system type.
+ Default is ext3.
+\layout Description
+
+--journal_size\SpecialChar ~
+<size> Optional arguement to specify the journal size for
+ the ext2/ext3 file system.
+ The size should be in the units expected by 
+\series bold 
+mkfs
+\series default 
+, so for ext3 it should be in MB.
+ If this is option is not used, the ext2/ext3 filesystem will be configured
+ with the default journal size.
 \end_deeper 
 \layout Description
 
@@ -343,8 +439,8 @@ mtpt
 mds_name 
 \layout Description
 
---obd\SpecialChar ~
-obd_name\SpecialChar ~
+--ost\SpecialChar ~
+ost_name\SpecialChar ~
 |\SpecialChar ~
 --lov\SpecialChar ~
 lov_name
@@ -396,7 +492,8 @@ nid.
 \layout Description
 
 --add\SpecialChar ~
-echo-client Used for testing purpose only
+echo-client Used for testing purpose only.
+ 
 \begin_deeper 
 \layout Description