Whamcloud - gitweb
Added the remaining new lmc options and also corrected all the examples in lustre...
authorradhikav <radhikav>
Fri, 20 Dec 2002 08:57:51 +0000 (08:57 +0000)
committerradhikav <radhikav>
Fri, 20 Dec 2002 08:57:51 +0000 (08:57 +0000)
lustre/doc/lconf.lyx
lustre/doc/lctl.lyx
lustre/doc/lmc.lyx

index 60739c6..3bfecbd 100644 (file)
@@ -40,7 +40,6 @@ SYNOPSIS
 
 
 \series bold 
-\emph on 
 lconf\SpecialChar ~
 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
  [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
@@ -50,17 +49,10 @@ DESCRIPTION
 \layout Standard
 
 This program configures a node following directives in the <XML-config-file>.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --node\SpecialChar ~
-node_name
-\series default 
-\emph default 
- Specify a specific node to configure.
+node_name Specify a specific node to configure.
  By default, lconf will search for nodes with the local hostname and 'localhost'.
  When
 \emph on 
@@ -73,16 +65,9 @@ node_name
  is searched for.
  If a matching node is not found in the config, then lconf exits with an
  error.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---cleanup
-\series default 
-\emph default 
- Unconfigure a node.
+--cleanup Unconfigure a node.
  The same config and 
 \emph on 
 --node
@@ -90,96 +75,42 @@ node_name
  argument used for configuration needs to be used for cleanup as well.
  This will attempt to undo all of the configuration steps done by lconf,
  including unloading the kernel modules.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---noexec
-\series default 
-\emph default 
- Print, but don't execute, the steps lconf will perform.
+--noexec Print, but don't execute, the steps lconf will perform.
  This is useful for debugging a configuration, and when used with 
 \emph on 
 --node
 \emph default 
 , can be run on any host.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---gdb
-\series default 
-\emph default 
- Causes lconf to print a message and pause for 5 seconds after creating
+--gdb Causes lconf to print a message and pause for 5 seconds after creating
  a gdb module script and before doing any Lustre configuration (the gdb
  module script is always created, however).
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
---nosetup
-\series default 
-\emph default 
- Only load modules, do not configure devices or services.
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
---nomod
-\series default 
-\emph default 
- Only setup devices and services, do not load modules.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---noexec,-n
-\emph default 
-\series default 
-Don't do anything, but print what would happen.
-\layout List
-\labelwidthstring 00.00.0000
+--nosetup Only load modules, do not configure devices or services.
+\layout Description
 
+--nomod Only setup devices and services, do not load modules.
+\layout Description
 
-\series bold 
-\emph on 
---verbose,-v
-\series default 
-\emph default 
- Be verbose and show actions while going along.
-\layout List
-\labelwidthstring 00.00.0000
+--noexec,-n Don't do anything, but print what would happen.
+\layout Description
 
+--verbose,-v Be verbose and show actions while going along.
+\layout Description
 
-\series bold 
-\emph on 
--h,--help
-\series default 
-\emph default 
- Print help.
-\layout List
-\labelwidthstring 00.00.0000
+--reformat Reformat all the devices
+\layout Description
 
+-h,--help Print help.
+\layout Description
 
-\series bold 
-\emph on 
 --maxlevel\SpecialChar ~
-<level>
-\series default 
-\emph default 
- [NOT IMPLEMENTED] Perform configuration of devices and services up to level
- given.
+<level> [NOT IMPLEMENTED] Perform configuration of devices and
+ services up to level given.
  
 \emph on 
 level
index f6b1924..33b40b2 100644 (file)
@@ -40,16 +40,11 @@ SYNOPSIS
 
 
 \series bold 
-\emph on 
-\SpecialChar ~
-
-\newline 
 lctl 
 \layout Standard
 
 
 \series bold 
-\emph on 
 lctl\SpecialChar ~
 --device\SpecialChar ~
 <devno> <command\SpecialChar ~
@@ -58,7 +53,6 @@ lctl\SpecialChar ~
 
 
 \series bold 
-\emph on 
 lctl\SpecialChar ~
 --threads\SpecialChar ~
 <numthreads>\SpecialChar ~
@@ -166,39 +160,25 @@ command
 
 \emph default 
  
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---device
-\series default 
-\emph default 
- The device number to be used for the operation.
+--device The device number to be used for the operation.
  The value of devno is an integer, normally found by calling 
 \emph on 
 lctl name2dev 
 \emph default 
 on a device name.
  
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---threads
-\series default 
-\emph default 
- How many threads should be forked doing the command specified.
- The numthreads variable is a strictly positivie integer indicating how
- many threads should be started.
- Verbose can take values <XXXX>; 
+--threads How many threads should be forked doing the command specified.
+ The numthreads variable is a strictly positive integer indicating how many
+ threads should be started.
+ The 
 \emph on 
 devno 
 \emph default 
-is used as above.
+option is used as above.
 \layout LyX-Code
 
 \layout LyX-Code
@@ -208,33 +188,20 @@ is used as above.
 Network\SpecialChar ~
 Configuration
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 network\SpecialChar ~
-<tcp/elans/myrinet>
-\series default 
-\emph default 
- Indicate what kind of network applies for the configuration commands that
- follow.
-\layout List
-\labelwidthstring 00.00.0000
-
+<tcp/elans/myrinet> Indicate what kind of network applies for the
+ configuration commands that follow.
+\layout Description
 
-\series bold 
-\emph on 
 connect\SpecialChar ~
 [[<hostname>\SpecialChar ~
 <port>]\SpecialChar ~
 |\SpecialChar ~
 <elan\SpecialChar ~
-id>]
-\series default 
-\emph default 
- This will establish a connection to a remote network network 
+id>] This will establish a connection to
+ a remote network network 
 \emph on 
 id
 \emph default 
@@ -243,216 +210,105 @@ id
 id
 \emph default 
 .
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 disconnect\SpecialChar ~
-<nid>
-\series default 
-\emph default 
- Disconnect from a remote 
+<nid> Disconnect from a remote 
 \emph on 
 nid
 \emph default 
 .
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 mynid\SpecialChar ~
-[nid]
-\series default 
-\emph default 
- Informs the socknal of the local 
+[nid] Informs the socknal of the local 
 \emph on 
 nid
 \emph default 
 .
  It defaults to hostname for tcp networks and is automatically setup for
  elan/myrinet networks.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 add_uuid\SpecialChar ~
 <uuid>\SpecialChar ~
-<nid>
-\series default 
-\emph default 
- Associate a given UUID with an 
+<nid> Associate a given UUID with an 
 \emph on 
 nid.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 close_uuid\SpecialChar ~
-<uuid>
-\series default 
-\emph default 
- Disconnect a UUID.
-\layout List
-\labelwidthstring 00.00.0000
-
+<uuid> Disconnect a UUID.
+\layout Description
 
-\series bold 
-\emph on 
 del_uuid\SpecialChar ~
-<uuid>
-\series default 
-\emph default 
- Delete a UUID association.
-\layout List
-\labelwidthstring 00.00.0000
-
+<uuid> Delete a UUID association.
+\layout Description
 
-\series bold 
-\emph on 
 add_route\SpecialChar ~
 <gateway>\SpecialChar ~
 <target>\SpecialChar ~
-[target]
-\series default 
-\emph default 
- Add an entry to the routing table for the given target.
-\layout List
-\labelwidthstring 00.00.0000
-
+[target] Add an entry to the routing table for
+ the given target.
+\layout Description
 
-\series bold 
-\emph on 
 del_route\SpecialChar ~
-<target>
-\series default 
-\emph default 
- Delete an entry for the target from the routing table.
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
-route_list
-\series default 
-\emph default 
- Print the complete routing table.
-\layout List
-\labelwidthstring 00.00.0000
+<target> Delete an entry for the target from the routing table.
+\layout Description
 
+route_list Print the complete routing table.
+\layout Description
 
-\series bold 
-\emph on 
 recv_mem\SpecialChar ~
-[size]
-\series default 
-\emph default 
- Set the socket 
+[size] Set the socket 
 \emph on 
 receive
 \emph default 
  buffer size; if the size is omitted, the default size for the buffer is
  printed.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 send_mem\SpecialChar ~
-[size]
-\series default 
-\emph default 
- Set send buffer size for the socket; if size is omitted, the default size
- for the buffer is printed.
-\layout List
-\labelwidthstring 00.00.0000
-
+[size] Set send buffer size for the socket; if size is omitted,
+ the default size for the buffer is printed.
+\layout Description
 
-\series bold 
-\emph on 
 nagle\SpecialChar ~
-[on/off]
-\series default 
-\emph default 
- Enable/disable nagle; omitting the argument will cause the default value
- to be printed.
+[on/off] Enable/disable nagle; omitting the argument will cause the
+ default value to be printed.
 \end_deeper 
 \layout Description
 
 Device\SpecialChar ~
 Selection
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
-newdev
-\series default 
-\emph default 
- Create a new device.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
-name2dev
-\series default 
-\emph default 
- This command can be used to determine a device number for the given device
- name.
-\layout List
-\labelwidthstring 00.00.0000
+newdev Create a new device.
+\layout Description
 
+name2dev This command can be used to determine a device number for the given
+ device name.
+\layout Description
 
-\series bold 
-\emph on 
-device
-\series default 
-\emph default 
- This will select the specified OBD device.
+device This will select the specified OBD device.
   All other commands depend on the device being set.
  
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
-device_list
-\series default 
-\emph default 
- Show all the devices.
+device_list Show all the devices.
 \end_deeper 
 \layout Description
 
 Device\SpecialChar ~
 Configuration
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 attach\SpecialChar ~
 type\SpecialChar ~
 [name\SpecialChar ~
-[uuid]]
-\series default 
-\emph default 
+[uuid]] 
 \shape italic 
 \emph on 
 Attach
@@ -467,46 +323,21 @@ device
  command) and give that device a name and UUID.
   This allows us to identify the device for use later, and also tells us
  what type of device we will have.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 setup\SpecialChar ~
-<args...>
-\series default 
-\emph default 
- Type specific device setup commands.
+<args...> Type specific device setup commands.
  For obdfilter, a setup command tells the driver which block device it should
  use for storage and what type of filesystem is on that device.
  
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
-cleanup
-\series default 
-\emph default 
- Cleanup a previously setup device.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
-detach
-\series default 
-\emph default 
- Remove driver (and name and UUID) from the current device.
-\layout List
-\labelwidthstring 00.00.0000
+cleanup Cleanup a previously setup device.
+\layout Description
 
+detach Remove driver (and name and UUID) from the current device.
+\layout Description
 
-\series bold 
-\emph on 
 lov_setconfig\SpecialChar ~
 lov-uuid\SpecialChar ~
 default-stripe-count\SpecialChar ~
@@ -515,21 +346,11 @@ offset\SpecialChar ~
 pattern\SpecialChar ~
 UUID1\SpecialChar ~
 [U
-UID2...]
-\series default 
-\emph default 
- Write LOV configuration to an MDS device.
-\layout List
-\labelwidthstring 00.00.0000
-
+UID2...] Write LOV configuration to an MDS device.
+\layout Description
 
-\series bold 
-\emph on 
 lov_getconfig\SpecialChar ~
-lov-uuid
-\series default 
-\emph default 
- Read LOV configuration from an MDS device.
+lov-uuid Read LOV configuration from an MDS device.
  Returns default-stripe-count, default-stripe-size, offset, pattern, and
  a list of OST UUID's.
 \end_deeper 
@@ -538,73 +359,41 @@ lov-uuid
 Device\SpecialChar ~
 Operations
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 probe\SpecialChar ~
-[timeout]
-\series default 
-\emph default 
- Build a connection handle to a device.
+[timeout] Build a connection handle to a device.
  This command is used to suspend configuration until the lctl command has
  ensured that the MDS and OSC services are available.
  This is to avoid mount failures in a rebooting cluster.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 close
-\emph default 
+\emph on 
  
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 getattr\SpecialChar ~
-<objid>
-\series default 
-\emph default 
- Get attributes for an OST object 
+<objid> Get attributes for an OST object 
 \emph on 
 <objid>
 \emph default 
  .
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 setattr\SpecialChar ~
 <objid>\SpecialChar ~
-<mode>
-\series default 
-\emph default 
- Set mode attribute for OST object 
+<mode> Set mode attribute for OST object 
 \emph on 
 <objid>
 \emph default 
 .
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 create\SpecialChar ~
 [num\SpecialChar ~
 [mode\SpecialChar ~
-[verbose]]]
-\series default 
-\emph default 
- Create the specified number 
+[verbose]]] Create the specified number 
 \emph on 
 <num>
 \emph default 
@@ -613,30 +402,16 @@ create\SpecialChar ~
 <mode>
 \emph default 
 .
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 destroy\SpecialChar ~
-<objid>
-\series default 
-\emph default 
- Destroy an OST object.
-\layout List
-\labelwidthstring 00.00.0000
-
+<objid> Destroy an OST object.
+\layout Description
 
-\series bold 
-\emph on 
 test_getattr\SpecialChar ~
 <num>\SpecialChar ~
 [verbose\SpecialChar ~
-[[t]objid]]
-\series default 
-\emph default 
- Do 
+[[t]objid]] Do 
 \emph on 
 <num>
 \emph default 
@@ -653,21 +428,14 @@ getattrs
 objectid
 \emph default 
 +1 on each thread).
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 test_brw\SpecialChar ~
 [t]<num>\SpecialChar ~
 [write\SpecialChar ~
 [verbose\SpecialChar ~
 [npages\SpecialChar ~
-[[t]objid]]]]
-\series default 
-\emph default 
- Do 
+[[t]objid]]]] Do 
 \emph on 
 <num>
 \emph default 
@@ -688,57 +456,26 @@ writes
 <npages>
 \emph default 
  per I/O).
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
-test_ldlm
-\series default 
-\emph default 
- Perform lock manager test.
-\layout List
-\labelwidthstring 00.00.0000
+\layout Description
 
+test_ldlm Perform lock manager test.
+\layout Description
 
-\series bold 
-\emph on 
 ldlm_regress_start\SpecialChar ~
 %s\SpecialChar ~
 [numthreads\SpecialChar ~
 [refheld\SpecialChar ~
 [numres\SpecialChar ~
-[numext]]]]
-\series default 
-\emph default 
- Start lock manager stress test.
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
-ldlm_regress_stop
-\series default 
-\emph default 
- Stop lock manager stress test.
-\layout List
-\labelwidthstring 00.00.0000
-
+[numext]]]] Start lock manager
+ stress test.
+\layout Description
 
-\series bold 
-\emph on 
-dump_ldlm
-\series default 
-\emph default 
- Dump all lock manager state, this is very useful for debugging
-\layout List
-\labelwidthstring 00.00.0000
+ldlm_regress_stop Stop lock manager stress test.
+\layout Description
 
+dump_ldlm Dump all lock manager state, this is very useful for debugging
+\layout Description
 
-\series bold 
-\emph on 
 newconn\SpecialChar ~
 <olduuid>\SpecialChar ~
 [newuuid]
@@ -747,154 +484,77 @@ newconn\SpecialChar ~
 
 Debug
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 debug_kernel\SpecialChar ~
 [file]\SpecialChar ~
-[raw]
-\series default 
-\emph default 
- Get debug buffer and dump to a 
+[raw] Get debug buffer and dump to a 
 \emph on 
 fileusage
 \emph default 
 .
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 debug_file\SpecialChar ~
 <input>\SpecialChar ~
 [output]\SpecialChar ~
-[raw]
-\series default 
-\emph default 
- Read debug buffer from input and dump to 
+[raw] Read debug buffer from input and dump to
 \emph on 
 outputusage
 \emph default 
 .
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
-clear
-\series default 
-\emph default 
- Clear kernel debug buffer.
-\layout List
-\labelwidthstring 00.00.0000
+\layout Description
 
+clear Clear kernel debug buffer.
+\layout Description
 
-\series bold 
-\emph on 
 mark\SpecialChar ~
-<text>
-\series default 
-\emph default 
- Insert marker text in kernel debug buffer.
-\layout List
-\labelwidthstring 00.00.0000
-
+<text> Insert marker text in kernel debug buffer.
+\layout Description
 
-\series bold 
-\emph on 
 filter\SpecialChar ~
 <subsystem\SpecialChar ~
 id/debug\SpecialChar ~
-mask>
-\series default 
-\emph default 
- Filter message type from the kernel debug buffer.
-\layout List
-\labelwidthstring 00.00.0000
-
+mask> Filter message type from the kernel debug
+ buffer.
+\layout Description
 
-\series bold 
-\emph on 
 show\SpecialChar ~
 <subsystem\SpecialChar ~
 id/debug\SpecialChar ~
-mask>
-\series default 
-\emph default 
- Show specific type of messages.
-\layout List
-\labelwidthstring 00.00.0000
-
+mask> Show specific type of messages.
+\layout Description
 
-\series bold 
-\emph on 
 debug_list\SpecialChar ~
-<subs/types>
-\series default 
-\emph default 
- List all the subsystem and debug types.
-\layout List
-\labelwidthstring 00.00.0000
-
+<subs/types> List all the subsystem and debug types.
+\layout Description
 
-\series bold 
-\emph on 
-panic
-\series default 
-\emph default 
- Force the kernel to panic.
+panic Force the kernel to panic.
 \end_deeper 
 \layout Description
 
 Control
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
-help
-\series default 
-\emph default 
- Show a complete list of commands; 
+help Show a complete list of commands; 
 \emph on 
 help <command name>
 \emph default 
  can be used to get help on specific command.
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
-exit
-\series default 
-\emph default 
- Close the lctl session.
-\layout List
-\labelwidthstring 00.00.0000
+\layout Description
 
+exit Close the lctl session.
+\layout Description
 
-\series bold 
-\emph on 
-quit
-\series default 
-\emph default 
- Close the lctl session.
+quit Close the lctl session.
 \end_deeper 
 \layout Subsection
 
 EXAMPLES
 \layout Description
 
-
-\emph on 
 attach
 \layout LyX-Code
 
@@ -911,8 +571,6 @@ lctl > attach obdfilter OBDDEV OBDUUID
 
 \layout Description
 
-
-\emph on 
 connect
 \layout LyX-Code
 
@@ -931,8 +589,6 @@ lctl > connect
 
 \layout Description
 
-
-\emph on 
 getattr
 \layout LyX-Code
 
@@ -981,10 +637,8 @@ Finished (success)
 
 \layout Description
 
-
-\emph on 
 setup
-\emph default 
+\emph on 
  
 \layout LyX-Code
 
index d8032e1..02ac31e 100644 (file)
@@ -40,32 +40,52 @@ SYNOPSIS
 
 
 \series bold 
-\emph on 
 lmc [options] --add <objectype> [args] 
 \layout Standard
 
 
 \series bold 
-NOT IMPLEMENTED 
-\emph on 
--- lmc [options] --remove <objecttype> [args]
+lmc [options] --remove <objecttype> [args] -- [NOT IMPLEMENTED]
 \layout Standard
 
 
 \series bold 
-NOT IMPLEMENTED 
-\emph on 
--- lmc [options] --convert [args]
+lmc [options] --convert [args] -- [NOT IMPLEMENTED]
 \layout Subsection
 
 DESCRIPTION
 \layout Standard
 
-At present lmc, when invoked, adds configuration data to the config file.
- lmc will also be able to remove configuration data or convert its format.
- One generates a single config file for the cluster at present including,
- at the minimum, MDS's, mtpt's, and OST's and whatever those reference (e.g.
- nets and profiles).
+At present 
+\series bold 
+\emph on 
+lmc
+\series default 
+\emph default 
+, when invoked, adds configuration data to the config file.
+ In future, 
+\series bold 
+\emph on 
+lmc
+\series default 
+\emph default 
+ will also be able to remove configuration data or convert its format.
+ A Lustre cluster consists of several components - MDS's, mount-points,
+ OSTs, LOVs and whatever those reference (e.g nets and profiles).
+ A single configuration file would be generated for the complete cluster.
+ In the 
+\series bold 
+\emph on 
+lmc
+\series default 
+\emph default 
+ command line interface, each of these components is associated with an
+\emph on 
+objecttype
+\emph default 
+.
 \layout Standard
 
 The 
@@ -75,7 +95,35 @@ objecttype
  refers to a collection of related configuration entities and can be one
  of 
 \series bold 
-net, MDS, LOV, OST, mtpt, route, or oscref.
+net
+\series default 
+,
+\series bold 
+ MDS
+\series default 
+,
+\series bold 
+ LOV
+\series default 
+,
+\series bold 
+ OST
+\series default 
+,
+\series bold 
+ mtpt
+\series default 
+,
+\series bold 
+ route
+\series default 
+,
+\series bold 
+\series default 
+or
+\series bold 
+ echo_client.
  
 \series default 
 We describe the arguments required for the addition of each 
@@ -83,63 +131,39 @@ We describe the arguments required for the addition of each
 objecttype
 \emph default 
 .
- [NOT IMPLEMENTED] lmc can also remove items from or convert the format
- of configuration data.
 \layout Standard
 
 To generate configuration data associated with systems in a Lustre cluster:
-\layout List
-\labelwidthstring 00.00.0000
+\layout Description
 
 
-\series bold 
 \emph on 
---add\SpecialChar ~
-net
-\series default 
+-
 \emph default 
- Adds a network device descriptor for the given node, with parameters as
- indicated.
+-add\SpecialChar ~
+net Adds a network device descriptor for the given node, with parameters
+ as indicated.
 \begin_deeper 
 \layout Standard
 
 The arguments required are:
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --node\SpecialChar ~
-''node_name''
-\series default 
-\emph default 
- This will create a new node with the given name if not already present.
+''node_name'' This will create a new node with the given name if not
+ already present.
  This is also used to specify a specific node for other elements.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --nettype\SpecialChar ~
-<type>
-\series default 
-\emph default 
- This can be 
+<type> This can be 
 \series bold 
 tcp, elan, gm.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --nid\SpecialChar ~
-nid
-\series default 
-\emph default 
- The network 
+nid The network 
 \emph on 
 id
 \emph default 
@@ -151,324 +175,161 @@ host_name
 \emph default 
  is '*', then the local address while be substituted when the node is configured
  with lconf.
-\layout List
-\labelwidthstring 00.00.0000
-
-
-\series bold 
-\emph on 
---router
-\series default 
-\emph default 
- Optional flag to mark this node as a router
-\layout List
-\labelwidthstring 00.00.0000
+\layout Description
 
+--router Optional flag to mark this node as a router
+\layout Description
 
-\series bold 
-\emph on 
---profile
-\series default 
-\emph default 
- Optional flag to mark this node as a profile node.
+--profile Optional flag to mark this node as a profile node.
  This is automatically true if the the 
 \emph on 
 --nid
 \emph default 
  argument contains a '*'.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --port\SpecialChar ~
-[port]
-\series default 
-\emph default 
- Optional argument to indicate the tcp port.
+[port] Optional argument to indicate the tcp port.
  The default is 988.
  
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --tcpbuf\SpecialChar ~
-<size>
-\series default 
-\emph default 
- Optional argument.
+<size> Optional argument.
 \end_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --add\SpecialChar ~
 mds
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --mds\SpecialChar ~
-<mds_name>
-\series default 
-\emph default 
-\layout List
-\labelwidthstring 00.00.0000
-
+<mds_name> 
+\layout Description
 
-\series bold 
-\emph on 
 --dev\SpecialChar ~
-<pathname>
-\series default 
-\emph default 
- Path of device on local system.
+<pathname> Path of device on local system.
  If the is a file, then a loop device is created and used as the block device.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --size\SpecialChar ~
-<size>
-\series default 
-\emph default 
- Optional argument indicating the size of the device to be created (used
- typically for loop devices).
-\layout List
-\labelwidthstring 00.00.0000
-
+<size> Optional argument indicating the size of the device to be created
+ (used typically for loop devices).
+\layout Description
 
-\series bold 
-\emph on 
 --node\SpecialChar ~
-<nodename>
-\series default 
-\emph default 
- Adds an MDS to the specified node.
+<nodename> Adds an MDS to the specified node.
  This requires a 
 \emph on 
 --node
 \emph default 
  argument, and it must not be a profile node.
 \end_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --add\SpecialChar ~
-lov
-\series default 
-\emph default 
- Creates an LOV with the specified parameters.
+lov Creates an LOV with the specified parameters.
  The 
 \emph on 
 mds_name
 \emph default 
  must already exist in the descriptor.
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --lov_<name>
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --mds_<name>
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --stripe_sz\SpecialChar ~
 <size>
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --stripe_cnt\SpecialChar ~
 <count>
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --stripe_pattern\SpecialChar ~
-<pattern>
-\series default 
-\emph default 
- Pattern can be 0.
+<pattern> Pattern can be 0.
 \end_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --add\SpecialChar ~
-ost
-\series default 
-\emph default 
- Creates an OBD, OST, and OSC.
+ost Creates an OBD, OST, and OSC.
  The OST and OBD are created on the specified node.
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --obd\SpecialChar ~
-<name>
-\series default 
-\emph default 
- Assign a name to the OBD device.
-\layout List
-\labelwidthstring 00.00.0000
-
+<name> Assign a name to the OBD device.
+\layout Description
 
-\series bold 
-\emph on 
 --node\SpecialChar ~
-<nodename>
-\series default 
-\emph default 
- Node on which the OST service is run, can not be a profile node.
-\layout List
-\labelwidthstring 00.00.0000
-
+<nodename> Node on which the OST service is run, can not be a profile
+ node.
+\layout Description
 
-\series bold 
-\emph on 
 --dev\SpecialChar ~
-<pathname>
-\series default 
-\emph default 
- Path of device on local system.
+<pathname> Path of device on local system.
  If this is a file, then a loop device is created and used as the block
  device.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --size\SpecialChar ~
 [size]
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --lov\SpecialChar ~
-<name>
-\series default 
-\emph default 
- Name of LOV to which this OSC will be attached.
+<name> Name of LOV to which this OSC will be attached.
  
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
 --obduuid\SpecialChar ~
-UUID
-\series default 
- Specify the UUID of the OBD device.
+UUID Specify the UUID of the OBD device.
  The default value is 
 \emph on 
 OBD_nodename_UUID
 \emph default 
 .
 \end_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --add\SpecialChar ~
-mtpt
-\series default 
-\emph default 
- Creates a mount-point on the specified node.
+mtpt Creates a mount-point on the specified node.
  Either an LOV or OSC name can be used.
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --node\SpecialChar ~
-node
-\series default 
-\emph default 
- Node or profile node that will use the 
+node Node or profile node that will use the 
 \emph on 
 mtpt
 \emph default 
 .
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --path\SpecialChar ~
 /mnt/path\SpecialChar ~
 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --mds\SpecialChar ~
 mds_name 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --obd\SpecialChar ~
-lov_name|osc_name
+obd_name\SpecialChar ~
+|\SpecialChar ~
+--lov\SpecialChar ~
+lov_name
 \end_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --add\SpecialChar ~
-route
-\series default 
-\emph default 
- Creates a static route through a gateway to a specific 
+route Creates a static route through a gateway to a specific 
 \emph on 
 nid
 \emph default 
@@ -478,120 +339,52 @@ nid
 \emph default 
 's.
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --node\SpecialChar ~
-node
-\series default 
-\emph default 
- Node or profile node to add the route to.
-\layout List
-\labelwidthstring 00.00.0000
-
+node Node or profile node to add the route to.
+\layout Description
 
-\series bold 
-\emph on 
 --gw\SpecialChar ~
-nid
-\series default 
-\emph default 
- The 
+nid The 
 \emph on 
 nid
 \emph default 
  of the gateway (must be a local interface or a peer).
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --tgt\SpecialChar ~
-nid
-\series default 
-\emph default 
- For a specific route, this is the target 
+nid For a specific route, this is the target 
 \emph on 
 nid.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --lo\SpecialChar ~
-nid
-\series default 
-\emph default 
- For a range route, this is the lo value 
+nid For a range route, this is the lo value 
 \emph on 
 nid.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --hi\SpecialChar ~
-nid
-\series default 
-\emph default 
- For a range route, this is the hi value 
+nid For a range route, this is the hi value 
 \emph on 
 nid.
 \end_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --add\SpecialChar ~
-oscref
-\series default 
-\emph default 
- Adds an OSC reference to a node.
- This is only necessary when the the OSC will be used without a mount-point.
+echo-client Used for testing
 \begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --node\SpecialChar ~
-node 
-\series default 
-\emph default 
-Node or profile node to add the 
+node
 \emph on 
-oscref
-\emph default 
- to.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
---osc\SpecialChar ~
-osc_name
-\series default 
-\emph default 
- Name of the OSC to add a reference to.
- The 
-\emph on 
---add
-\emph default 
- OST command automatically creates the OSC, and the name will be 
-\emph on 
-OSC_<node>
-\emph default 
-, where node is the name of node the OST is on.
+--obd\SpecialChar ~
+obd_name 
 \end_deeper 
 \layout List
 \labelwidthstring 00.00.0000
@@ -599,32 +392,20 @@ OSC_<node>
 
 \series bold 
 Options
-\begin_deeper 
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --output\SpecialChar ~
-filename
-\series default 
-\emph default 
- Send output to the file.
+filename Send output to the file.
  If the file exists, it will be overwritten.
-\layout List
-\labelwidthstring 00.00.0000
-
+\layout Description
 
-\series bold 
-\emph on 
 --merge\SpecialChar ~
-filename 
-\series default 
+filename
+\emph on 
 \emph default 
 Add the new element to an existing file.
  
-\end_deeper 
 \layout Subsection
 
 EXAMPLES