From 0afa8db95ae9ffd2c9ed928071d8a2cfceeea721 Mon Sep 17 00:00:00 2001
From: adilger <adilger>
Date: Sun, 3 Jul 2005 10:10:30 +0000
Subject: [PATCH] Branch b1_4 Merge updated docs from b_cray (b1_4-irrelevant
 bits removed).

---
 lustre/doc/lconf.8   |  35 +++++-
 lustre/doc/lconf.lyx |  77 ++++++++++++
 lustre/doc/lctl.8    | 105 +++++++++++++---
 lustre/doc/lctl.lyx  | 346 +++++++++++++++++++++++++++++++++++++++------------
 lustre/doc/lmc.1     |  65 +++++++++-
 lustre/doc/lmc.lyx   | 212 +++++++++++++++++++++++++++----
 6 files changed, 716 insertions(+), 124 deletions(-)

diff --git a/lustre/doc/lconf.8 b/lustre/doc/lconf.8
index aa16c34..a3e60f1 100644
--- a/lustre/doc/lconf.8
+++ b/lustre/doc/lconf.8
@@ -1,4 +1,4 @@
-.TH lconf 1 "2003 Oct 8" Lustre "configuration utilities"
+.TH lconf 1 "2004 Sep 16" Lustre "configuration utilities"
 .SH NAME
 lconf \- Lustre filesystem configuration utility
 .SH SYNOPSIS
@@ -14,12 +14,24 @@ lconf \- Lustre filesystem configuration utility
 The arguments that can be used for lconf are:
 .PP
 .TP
+--client_uuid <uuid> 
+The failed client (required for recovery).
+.TP
+--clientoptions <options> 
+Additional options for Lustre.
+.TP
 --config <arg> 
 Cluster configuration name used for LDAP query
 .TP
+--conn_uuid <uuid> 
+The failed connection (required for recovery).
+.TP
 --d|--cleanup 
 Unconfigure a node. The same config and --node 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.
 .TP
+--debug_path <path> 
+Path to save debug dumps.
+.TP
 --dump <file> 
 Dump the kernel debug log to the specified file before portals is unloaded during cleanup.
 .TP
@@ -68,6 +80,12 @@ Perform configuration of devices and services up to level given. level can take
 --minlevel <level> 
 Specify the minimum level of services to configure/cleanup. Default is 0.
 .TP
+--mkfsoptions <options> 
+Specify additional options for the mk*fs command line.
+.TP
+--mountfsoptions <options> 
+Specify additional options for mount fs command line. Mount options will be passed by this argument. For example, extents are to be enabled by adding ",extents" to the --mountfsoptions option. "errors=remount-ro" and "asyncdel" can also be added to it.
+.TP
 --node node_name 
 Specify a specific node to configure. By default, lconf will search for nodes with the local hostname and 'localhost'. When --node is used, only node_name is searched for. If a matching node is not found in the config, then lconf exits with an error.
 .TP
@@ -80,12 +98,24 @@ Only setup devices and services, do not load modules.
 --nosetup 
 Only load modules, do not configure devices or services.
 .TP
+--portals <path> 
+Specify portals source directory. If this is a relative path, then it is assumed to be relative to lustre.
+.TP
 --portals_upcall <path> 
 Specify the location of the Portals upcall scripts used by the client for recovery
 .TP
 --ptldebug debug-level 
 This options can be used to set the required debug level.
 .TP
+--record 
+Write config information on mds.
+.TP
+--record_log <arg> 
+Specify the name of config record log.
+.TP
+--record_device <arg> 
+Specify MDS device name that will record the config commands.
+.TP
 --recover <arg> 
 Recover a device.
 .TP
@@ -98,6 +128,9 @@ Select a particular node for a service
 --subsystem <arg> 
 Set the portals debug subsystem.
 .TP
+--tgt_uuid <uuid> 
+Specify the failed target (required for recovery).
+.TP
 --timeout <arg> 
 Set the recovery timeout period.
 .TP
diff --git a/lustre/doc/lconf.lyx b/lustre/doc/lconf.lyx
index 1c6d878..e00d94d 100644
--- a/lustre/doc/lconf.lyx
+++ b/lustre/doc/lconf.lyx
@@ -56,10 +56,22 @@ This program configures a node following directives in the <XML-config-file>.
  on an LDAP server that can be reached from all the cluster nodes.
 \layout Description
 
+--client_uuid\SpecialChar ~
+<uuid> The failed client (required for recovery).
+\layout Description
+
+--clientoptions\SpecialChar ~
+<options> Additional options for Lustre.
+\layout Description
+
 --config\SpecialChar ~
 <arg> Cluster configuration name used for LDAP query
 \layout Description
 
+--conn_uuid\SpecialChar ~
+<uuid> The failed connection (required for recovery).
+\layout Description
+
 --d|--cleanup Unconfigure a node.
  The same config and 
 \emph on 
@@ -70,6 +82,10 @@ This program configures a node following directives in the <XML-config-file>.
  including unloading the kernel modules.
 \layout Description
 
+--debug_path\SpecialChar ~
+<path> Path to save debug dumps.
+\layout Description
+
 --dump\SpecialChar ~
 <file> Dump the kernel debug log to the specified file before portals
  is unloaded during cleanup.
@@ -160,6 +176,43 @@ When used in conjunction with cleanup, services are torn down up to a certain
  Default is 0.
 \layout Description
 
+--mkfsoptions\SpecialChar ~
+<options> Specify additional options for the mk*fs command
+ line.
+\layout Description
+
+--mountfsoptions\SpecialChar ~
+<options> Specify additional options for mount fs command
+ line.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding 
+\begin_inset Quotes eld
+\end_inset 
+
+,extents
+\begin_inset Quotes erd
+\end_inset 
+
+ to the --mountfsoptions option.
+ 
+\begin_inset Quotes eld
+\end_inset 
+
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset 
+
+ and 
+\begin_inset Quotes eld
+\end_inset 
+
+asyncdel
+\begin_inset Quotes erd
+\end_inset 
+
+ can also be added to it.
+\layout Description
+
 --node\SpecialChar ~
 node_name Specify a specific node to configure.
  By default, lconf will search for nodes with the local hostname and 'localhost'.
@@ -190,6 +243,11 @@ node_name
 --nosetup Only load modules, do not configure devices or services.
 \layout Description
 
+--portals\SpecialChar ~
+<path> Specify portals source directory.
+ If this is a relative path, then it is assumed to be relative to lustre.
+\layout Description
+
 --portals_upcall\SpecialChar ~
 <path> Specify the location of the Portals upcall scripts
  used by the client for recovery
@@ -201,6 +259,18 @@ level This options can be used to set the required debug
  level.
 \layout Description
 
+--record Write config information on mds.
+\layout Description
+
+--record_log\SpecialChar ~
+<arg> Specify the name of config record log.
+\layout Description
+
+--record_device\SpecialChar ~
+<arg> Specify MDS device name that will record the config
+ commands.
+\layout Description
+
 --recover\SpecialChar ~
 <arg> Recover a device.
 \layout Description
@@ -213,10 +283,17 @@ level This options can be used to set the required debug
 <arg> Select a particular node for a service 
 \layout Description
 
+--single_socket Specify socknal option: only use one socket instead of bundle.
+\layout Description
+
 --subsystem\SpecialChar ~
 <arg> Set the portals debug subsystem.
 \layout Description
 
+--tgt_uuid\SpecialChar ~
+<uuid> Specify the failed target (required for recovery).
+\layout Description
+
 --timeout\SpecialChar ~
 <arg> Set the recovery timeout period.
 \layout Description
diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8
index 264fe27..58e5a80 100644
--- a/lustre/doc/lctl.8
+++ b/lustre/doc/lctl.8
@@ -35,18 +35,48 @@ To get a complete listing of available commands, type help at the lctl prompt.
 For non-interactive single-threaded use, one uses the second invocation, which runs command after connecting to the device. 
 
 .B Network Configuration
+.TP
+--net <tcp/elan/myrinet> <command> 
+Indicate the network type to be used for the operation.
 .TP 
 network <tcp/elans/myrinet> 
 Indicate what kind of network applies for the configuration commands that follow.
+.TP
+interface_list 
+Print the interface entries.
+.TP
+add_interface <ip> [netmask] 
+Add an interface entry.
+.TP
+del_interface [ip] 
+Delete an interface entry.
+.TP
+peer_list 
+Print the peer entries.
+.TP
+add_peer <nid> <host> <port> 
+Add a peer entry.
+.TP
+del_peer [<nid>] [<host>] [ks] 
+Remove a peer entry.
+.TP
+conn_list 
+Print all the connected remote nid.
 .TP 
 connect [[<hostname> <port>] | <elan id>] 
 This will establish a connection to a remote network network id given by the hostname/port combination, or the elan id.
 .TP 
 disconnect <nid> 
 Disconnect from a remote nid.
+.TP
+active_tx 
+This command should print active transmits, and it is only used for elan network type.
 .TP 
 mynid [nid] 
 Informs the socknal of the local nid. It defaults to hostname for tcp networks and is automatically setup for elan/myrinet networks.
+.TP
+shownid 
+Print the local NID.
 .TP 
 add_uuid <uuid> <nid> 
 Associate a given UUID with an nid.
@@ -62,32 +92,26 @@ Add an entry to the routing table for the given target.
 .TP 
 del_route <target> 
 Delete an entry for the target from the routing table.
+.TP
+set_route <gateway> <up/down> [<time>] 
+Enable/disable routes via the given gateway in the protals routing table. <time> is used to tell when a gateway comes back online.
 .TP 
 route_list 
 Print the complete routing table.
-.TP 
-recv_mem [size] 
-Set the socket receive buffer size; if the size is omitted, the default size for the buffer is printed.
-.TP 
-send_mem [size] 
-Set send buffer size for the socket; if size is omitted, the default size for the buffer is printed.
-.TP 
-nagle [on/off] 
-Enable/disable nagle; omitting the argument will cause the default value to be printed.
-.TP 
-fail nid|all [count] 
-Fail/restore communications. Ommiting tha count implies fail indefinitely, count of zero indicates that communication should be restored. A non-zero count indicates the number of portals messages to be dropped after which the communication is restored.
+.TP
+fail nid|_all_ [count] 
+Fail/restore communications. Omitting the count implies fail indefinitely, count of zero indicates that communication should be restored. A non-zero count indicates the number of portals messages to be dropped after which the communication is restored. The argument "nid" is used to specify the gateway, which is one peer of the communication.
 .PP
 .B Device Selection
 .TP 
 newdev 
 Create a new device.
 .TP 
-name2dev 
-This command can be used to determine a device number for the given device name.
-.TP 
 device 
 This will select the specified OBD device.  All other commands depend on the device being set. 
+.TP
+cfg_device <$name> 
+Set current device being configured to <$name>.
 .TP 
 device_list 
 Show all the devices.
@@ -114,6 +138,21 @@ Write LOV configuration to an MDS device.
 .TP 
 lov_getconfig 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.
+.TP
+record cfg-uuid-name 
+Record commands that follow in log.
+.TP
+endrecord 
+Stop recording.
+.TP
+parse config-uuid-name 
+Parse the log of recorded commands for this config.
+.TP
+dump_log config-uuid-name 
+Print log of recorded commands for this config to kernel debug log.
+.TP
+clear_log config-name 
+Delete current config log of recorded commands.
 .PP
 .B Device Operations
 .TP 
@@ -183,6 +222,33 @@ Set stripe info for an echo client
 .TP 
 unset_stripe <objid> 
 Unset stripe info for an echo client object.
+.TP
+del_mount_option profile 
+Delete a specified profile.
+.TP
+set_timeout <secs> 
+Set the timeout(obd_timeout) for server to wait before failing recovery.
+.TP
+set_lustre_upcall </full/path/to/upcall> 
+Set the lustre upcall(obd_lustre_upcall) via the lustre.upcall sysctl.
+.TP
+llog_catlist 
+List all catalog logs on current device.
+.TP
+llog_info <$logname|#oid#ogr#ogen> 
+Print log header information. 
+.TP
+llog_print <$logname|#oid#ogr#ogen> [from] [to] 
+Print log content information. It will print all records from index 1 by default.
+.TP
+llog_check <$logname|#oid#ogr#ogen> [from] [to] 
+Check log content information. It will check all records from index 1 by default.
+.TP
+llog_cancel <catalog id|catalog name> <log id> <index> 
+Cancel one record in log.
+.TP
+llog_remove <catalog id|catalog name> <log id> 
+Remove one log from catalog, erase it from disk.
 .PP
 .B Debug
 .TP 
@@ -209,9 +275,18 @@ Show specific type of messages.
 .TP 
 debug_list <subs/types> 
 List all the subsystem and debug types.
+.TP
+modules <path> 
+Provide gdb-friendly module information.
 .TP 
 panic 
 Force the kernel to panic.
+.TP
+lwt start/stop [file] 
+Light-weight tracing.
+.TP
+memhog <page count> [<gfp flags>] 
+Memory pressure testing.
 .PP
 .B Control
 .TP 
diff --git a/lustre/doc/lctl.lyx b/lustre/doc/lctl.lyx
index b921b40..087a2cd 100644
--- a/lustre/doc/lctl.lyx
+++ b/lustre/doc/lctl.lyx
@@ -1,5 +1,5 @@
-#LyX 1.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 220
+#LyX 1.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 221
 \textclass amsart-plain
 \language english
 \inputencoding auto
@@ -132,7 +132,7 @@ help
 \family default 
 \size default 
  at the lctl prompt.
-  To get basic help on the meaning and syntax of a command, type 
+ To get basic help on the meaning and syntax of a command, type 
 \family typewriter 
 \size small 
 help command
@@ -165,9 +165,9 @@ command
 --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 
+lctl device_list/dl
 \emph default 
-on a device name.
+.
  
 \layout Description
 
@@ -183,10 +183,10 @@ option is used as above.
 
 --ignore_errors\SpecialChar ~
 |\SpecialChar ~
-ignore_errors Ignore errors during script processing
+ignore_errors Ignore errors that occur during script processing.
 \layout Description
 
-dump Save ioctls to a file 
+dump Save ioctl buffer to file.
 \layout LyX-Code
 
 \layout Description
@@ -196,26 +196,86 @@ Configuration
 \begin_deeper 
 \layout Description
 
+--net\SpecialChar ~
+
+\series bold 
+<tcp/elan/myrinet>
+\series default 
+\SpecialChar ~
+
+\series bold 
+<command> 
+\series default 
+Indicate the network type to be used for the operation.
+\layout Description
+
 network\SpecialChar ~
 <tcp/elans/myrinet> Indicate what kind of network applies for the
  configuration commands that follow.
 \layout Description
 
+interface_list Print the interface entries.
+\layout Description
+
+add_interface\SpecialChar ~
+
+\series bold 
+<
+\series default 
+ip>\SpecialChar ~
+[netmask] Add an interface entry.
+\layout Description
+
+del_interface\SpecialChar ~
+[ip] Delete an interface entry.
+\layout Description
+
+peer_list Print the peer entries.
+\layout Description
+
+add_peer\SpecialChar ~
+
+\series bold 
+<
+\series default 
+nid>\SpecialChar ~
+
+\series bold 
+<
+\series default 
+host>\SpecialChar ~
+
+\series bold 
+<
+\series default 
+port> 
+\series bold 
+Add a peer entry.
+\layout Description
+
+del_peer\SpecialChar ~
+[
+\series bold 
+<
+\series default 
+nid>]\SpecialChar ~
+[
+\series bold 
+<
+\series default 
+host>]\SpecialChar ~
+[ks] Remove a peer entry.
+\layout Description
+
 connect\SpecialChar ~
-[[<hostname>\SpecialChar ~
-<port>]\SpecialChar ~
-|\SpecialChar ~
-<elan\SpecialChar ~
-id>] This will establish a connection to
- a remote network network 
-\emph on 
-id
-\emph default 
- given by the hostname/port combination, or the elan 
+<hostname>\SpecialChar ~
+<port>\SpecialChar ~
+[iIOC] This will establish a connection to a remote
+ network, network 
 \emph on 
 id
 \emph default 
-.
+ given by the hostname/port combination.
 \layout Description
 
 disconnect\SpecialChar ~
@@ -226,6 +286,10 @@ nid
 .
 \layout Description
 
+active_tx This command should print active transmits, and it is only used
+ for elan network type.
+\layout Description
+
 mynid\SpecialChar ~
 [nid] Informs the socknal of the local 
 \emph on 
@@ -236,15 +300,20 @@ nid
  elan/myrinet networks.
 \layout Description
 
+shownid Print the local NID.
+\layout Description
+
 add_uuid\SpecialChar ~
 <uuid>\SpecialChar ~
-<nid> Associate a given UUID with an 
+<nid>\SpecialChar ~
+<net_type> Associate a given UUID with an 
 \emph on 
 nid.
 \layout Description
 
 close_uuid\SpecialChar ~
-<uuid> Disconnect a UUID.
+<uuid>\SpecialChar ~
+<net_type> Disconnect a UUID.
 \layout Description
 
 del_uuid\SpecialChar ~
@@ -254,43 +323,52 @@ del_uuid\SpecialChar ~
 add_route\SpecialChar ~
 <gateway>\SpecialChar ~
 <target>\SpecialChar ~
-[target] Add an entry to the routing table for
- the given target.
+[<target>] Add an entry to the portals routing
+ table for the given target.
+ The arguments should be nid.
+ If only one <target> is provided, this command should only add the route
+ for this target.
+ But, if both of the <target>s are provides, this command should add the
+ route for all the target in the range specified by the two targets(from
+ low nid to high nid).
 \layout Description
 
 del_route\SpecialChar ~
-<target> Delete an entry for the target from the routing table.
-\layout Description
-
-route_list Print the complete routing table.
-\layout Description
-
-recv_mem\SpecialChar ~
-[size] Set the socket 
-\emph on 
-receive
-\emph default 
- buffer size; if the size is omitted, the default size for the buffer is
- printed.
+<gateway>\SpecialChar ~
+[<target>]\SpecialChar ~
+[<target>] Delete the route entry for the given
+ targets from the portals routing table.
+ The arguments should be nid.
+ 
 \layout Description
 
-send_mem\SpecialChar ~
-[size] Set send buffer size for the socket; if size is omitted,
- the default size for the buffer is printed.
+set_route\SpecialChar ~
+<gateway>\SpecialChar ~
+<up/down>\SpecialChar ~
+[<time>] Enable/disable routes via the given
+ gateway in the protals routing table.
+ <time> is used to tell when a gateway comes back online.
 \layout Description
 
-nagle\SpecialChar ~
-[on/off] Enable/disable nagle; omitting the argument will cause the
- default value to be printed.
+route_list Print the complete portals routing table.
 \layout Description
 
 fail\SpecialChar ~
-nid|all\SpecialChar ~
+nid|_all_\SpecialChar ~
 [count] Fail/restore communications.
- Ommiting tha count implies fail indefinitely, count of zero indicates that
+ Omitting the count implies fail indefinitely, count of zero indicates that
  communication should be restored.
  A non-zero count indicates the number of portals messages to be dropped
  after which the communication is restored.
+ The argument 
+\begin_inset Quotes eld
+\end_inset 
+
+nid
+\begin_inset Quotes erd
+\end_inset 
+
+ is used to specify the gateway, which is one peer of the communication.
 \end_deeper 
 \layout Description
 
@@ -302,18 +380,21 @@ Selection
 newdev Create a new device.
 \layout Description
 
-name2dev This command can be used to determine a device number for the given
- device name.
+device\SpecialChar ~
+<%name|$name|devno> This will select the specified OBD device.
+  All other commands depend on the device being set.
 \layout Description
 
-device This will select the specified OBD device.
-  All other commands depend on the device being set.
- 
+cfg_device\SpecialChar ~
+<$name> Set current device being configured to <$name>.
 \layout Description
 
 device_list Show all the devices.
 \layout Description
 
+dl The same as device_list.
+\layout Description
+
 lustre_build_version Print the Lustre build version.
 \end_deeper 
 \layout Description
@@ -350,27 +431,47 @@ setup\SpecialChar ~
  
 \layout Description
 
-cleanup Cleanup a previously setup device.
+cleanup\SpecialChar ~
+[force|failover] Cleanup a previously setup device.
 \layout Description
 
 detach Remove driver (and name and UUID) from the current device.
 \layout Description
 
-lov_setconfig\SpecialChar ~
+lov_setup\SpecialChar ~
 lov-uuid\SpecialChar ~
 stripe-count\SpecialChar ~
-default-stripe-size\SpecialChar ~
+stripe-size\SpecialChar ~
 offset\SpecialChar ~
 pattern\SpecialChar ~
 UUID1\SpecialChar ~
-[UUID2...]
- Write LOV configuration to an MDS device.
+[UUID2...] Write
+ LOV configuration to an MDS device.
 \layout Description
 
 lov_getconfig\SpecialChar ~
 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.
+ Returns stripe-count, stripe-size, offset, pattern, and a list of OST UUID's.
+\layout Description
+
+record\SpecialChar ~
+cfg-uuid-name Record commands that follow in log.
+\layout Description
+
+endrecord Stop recording
+\layout Description
+
+parse\SpecialChar ~
+config-uuid-name Parse the log of recorded commands for this config.
+\layout Description
+
+dump_log\SpecialChar ~
+config-uuid-name Print log of recorded commands for this config
+ to kernel debug log.
+\layout Description
+
+clear_log\SpecialChar ~
+config-name Delete current config log of recorded commands.
 \end_deeper 
 \layout Description
 
@@ -417,7 +518,9 @@ setattr\SpecialChar ~
 create\SpecialChar ~
 [num\SpecialChar ~
 [mode\SpecialChar ~
-[verbose]]] Create the specified number 
+[verbose\SpecialChar ~
+[lsm\SpecialChar ~
+data]]]] Create the specified number 
 \emph on 
 <num>
 \emph default 
@@ -493,11 +596,24 @@ writes
  per I/O).
 \layout Description
 
+get_stripe\SpecialChar ~
+objid Show stripe info for an echo client object.
+\layout Description
+
+set_stripe\SpecialChar ~
+<objid>[=width!count[@offset]\SpecialChar ~
+[:id:id....] Set stripe info for an echo
+ client object.
+\layout Description
+
+unset_stripe\SpecialChar ~
+<objid> Unset stripe info for an echo client object.
+\layout Description
+
 test_ldlm Perform lock manager test.
 \layout Description
 
 ldlm_regress_start\SpecialChar ~
-%s\SpecialChar ~
 [numthreads\SpecialChar ~
 [refheld\SpecialChar ~
 [numres\SpecialChar ~
@@ -508,48 +624,101 @@ ldlm_regress_start\SpecialChar ~
 ldlm_regress_stop Stop lock manager stress test.
 \layout Description
 
-dump_ldlm Dump all lock manager state, this is very useful for debugging
+dump_ldlm Dump all lock manager state, this is very useful for debugging.
 \layout Description
 
-activate Activate an import
+activate Activate an import.
 \layout Description
 
-deacttivate De-activate an import
+deactivate De-activate an import.
 \layout Description
 
 recover\SpecialChar ~
-<connection UUID> 
+[<connection\SpecialChar ~
+UUID>] Pass the information of the new target and initialize
+ the connection to this target.
+ 
 \layout Description
 
 lookup\SpecialChar ~
 <directory>\SpecialChar ~
-<file>
+<file> Print some information of the given file.
 \layout Description
 
-notransno Disable sending of committed transnumber updates
+notransno Disable sending of committed transnumber updates.
 \layout Description
 
-readonly Disable writes to the underlying device
+readonly Disable writes to the underlying device.
 \layout Description
 
-abort_recovery Abort recovery on MDS device
+abort_recovery Abort recovery on MDS device.
 \layout Description
 
-mount_option Dump mount options to a file
+start\SpecialChar ~
+<profilename> Setup mds/ost from the llog file.
 \layout Description
 
-get_stripe show stripe info for an echo client object.
+mount_option\SpecialChar ~
+profile\SpecialChar ~
+osc_name\SpecialChar ~
+[mdc_name] Add a new profile to lustre.
 \layout Description
 
-set_stripe\SpecialChar ~
-<objid>[\SpecialChar ~
-width!count[@offset]\SpecialChar ~
-[:id:id....] set stripe info for an echo
- client
+del_mount_option\SpecialChar ~
+profile Delete a specified profile.
 \layout Description
 
-unset_stripe\SpecialChar ~
-<objid> unset stripe info for an echo client object.
+set_timeout\SpecialChar ~
+<secs> Set the timeout(
+\emph on 
+obd_timeout
+\emph default 
+) for server to wait before failing recovery.
+\layout Description
+
+set_lustre_upcall\SpecialChar ~
+</full/path/to/upcall> Set the lustre upcall(obd_lustre_upcall)
+ via the lustre.upcall sysctl.
+\layout Description
+
+llog_catlist List all catalog logs on current device.
+\layout Description
+
+llog_info\SpecialChar ~
+<$logname|#oid#ogr#ogen> Print log header information.
+ 
+\layout Description
+
+llog_print\SpecialChar ~
+<$logname|#oid#ogr#ogen>\SpecialChar ~
+[from]\SpecialChar ~
+[to] Print log content information.
+ It will print all records from index 1 by default.
+\layout Description
+
+llog_check\SpecialChar ~
+<$logname|#oid#ogr#ogen>\SpecialChar ~
+[from]\SpecialChar ~
+[to] Check log content information.
+ It will check all records from index 1 by default.
+\layout Description
+
+llog_cancel\SpecialChar ~
+<catalog\SpecialChar ~
+id|catalog\SpecialChar ~
+name>\SpecialChar ~
+<log\SpecialChar ~
+id>\SpecialChar ~
+<index> Cancel one record in log.
+\layout Description
+
+llog_remove\SpecialChar ~
+<catalog\SpecialChar ~
+id|catalog\SpecialChar ~
+name>\SpecialChar ~
+<log\SpecialChar ~
+id> Remove one log from catalog, erase
+ it from disk.
 \end_deeper 
 \layout Description
 
@@ -557,25 +726,32 @@ Debug
 \begin_deeper 
 \layout Description
 
-debug_daemon debug daemon control and dump to a file
+debug_daemon\SpecialChar ~
+[start\SpecialChar ~
+file\SpecialChar ~
+<#MB>|stop|pause|continue] Debug daemon control and
+ dump to a file.
 \layout Description
 
 debug_kernel\SpecialChar ~
 [file]\SpecialChar ~
-[raw] Get Lustre debug buffer from kernel and dump to a 
+[raw] Get Lustre debug buffer from kernel and dump to a
 \emph on 
 file
 \emph default 
 .
 \layout Description
 
+dk The same as debug_kernel.
+\layout Description
+
 debug_file\SpecialChar ~
 <input>\SpecialChar ~
 [output]\SpecialChar ~
 Convert kernel-dumped debug log from binary to plain text format.
  
 \emph on 
-outputusage
+output
 \emph default 
 .
 \layout Description
@@ -604,7 +780,23 @@ debug_list\SpecialChar ~
 <subs/types> List all the subsystem and debug types.
 \layout Description
 
+modules\SpecialChar ~
+<path> Provide gdb-friendly module information.
+\layout Description
+
 panic Force the kernel to panic.
+\layout Description
+
+lwt\SpecialChar ~
+start/stop\SpecialChar ~
+[file] Light-weight tracing.
+\layout Description
+
+memhog\SpecialChar ~
+<page\SpecialChar ~
+count>\SpecialChar ~
+[<gfp\SpecialChar ~
+flags>] Memory pressure testing.
 \end_deeper 
 \layout Description
 
diff --git a/lustre/doc/lmc.1 b/lustre/doc/lmc.1
index accc973..f7253a4 100644
--- a/lustre/doc/lmc.1
+++ b/lustre/doc/lmc.1
@@ -1,4 +1,4 @@
-.TH lmc 1 "2003 Oct 8" Lustre "configuration utilities"
+.TH lmc 1 "2004 Sep 16" Lustre "configuration utilities"
 .SH NAME
 lmc \- Lustre configuration maker
 .SH SYNOPSIS
@@ -50,6 +50,12 @@ Specify the location of the Portals upcall scripts used by the client for recove
 .TP
 --upcall <path> 
 Specify the location of both (Lustre and Portals) upcall scripts used by the client for recovery.
+.TP
+--ptldebug <debug_level>
+Set the portals debug level.
+.TP
+--subsystem <subsystem_name>
+Specify which Lustre subsystems have debug output recorded in the log.
 .PP
 .B --add net 
 Adds a network device descriptor for the given node, with parameters as indicated.
@@ -64,7 +70,11 @@ This can be tcp, elan, or gm.
 --nid nid 
 The network id, e.g. ElanID or IP address as used by Portals. If nid is '*', then the local address of the interface with specified nettype is will be substituted when the node is configured with lconf. An nid of '*' should be used only for the generic client configuration.
 .TP
+--cluster_id id
+Specify the cluster ID.
+.TP
 --hostaddr addr
+Specify the host address, which will be transfered to the real host address by lconf.
 .TP
 --router 
 Optional flag to mark this node as a router.
@@ -92,10 +102,16 @@ Common name of the MDS.
 .TP
 --mdsuuid <uuid>
 Specify MDS uuid.
+.TP
+--failover
+Enable failover support on MDS.
 .TP 
 --dev <pathname> 
 Path of device on local system. If the is a file, then a loop device is created and used as the block device.
 .TP
+--backdev <pathname>
+Path of the device for backing storage on local system.
+.TP
 --size <size> 
 Optional argument indicating the size (in KB) of the device to be created (used typically for loop devices).
 .TP
@@ -105,6 +121,15 @@ Adds an MDS to the specified node. This requires a --node argument, and it must
 --fstype extN|ext3 
 Optional argument used to specify the file system type. Default is ext3.
 .TP
+--inode_size <size> 
+Specify new inode size for underlying ext3 file system.
+.TP
+--mkfsoptions <options> 
+Optional argument to mkfs.
+.TP
+--mountfsoptions <options> 
+Optional argument to mount fs. Mount options will be passed by this argument. For example, extents are to be enabled by adding ",extents" to the --mountfsoptions option. "errors=remount-ro" and "asyncdel" can also be added to it.
+.TP
 --journal_size <size> 
 Optional arguement to specify the journal size for the ext2/ext3 file system. The size should be in the units expected by mkfs, 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.
 .PP
@@ -135,7 +160,7 @@ Assign a name to the OST device.
 --node <nodename> 
 Node on which the OST service is run, can not be a profile node.
 .TP
---failover
+--failover 
 Enable failover support on OST.
 .TP
 --dev <pathname> 
@@ -156,6 +181,15 @@ Specify the UUID of the OST device.
 --fstype 
 extN|ext3 Optional arguement used to specify the file system type. Default is ext3.
 .TP
+--inode_size <size> 
+Specify new inode size for underlying ext3 file system.
+.TP
+--mkfsoptions <options> 
+Optional argument to mkfs.
+.TP
+--mountfsoptions <options> 
+Optional argument to mount fs. Mount options will be passed by this argument. For example, extents are to be enabled by adding ",extents" to the --mountfsoptions option. "errors=remount-ro" and "asyncdel" can also be added to it.
+.TP
 --journal_size <size> 
 Optional arguement to specify the journal size for the ext2/ext3 file system. The size should be in the units expected by mkfs, 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.
 .PP
@@ -180,14 +214,17 @@ Creates a static route through a gateway to a specific nid or a range of nid's.
 --node node 
 Node to add the route to.
 .TP
---router
+--router 
 Optional flag to mark a node as router.
 .TP
 --gw nid 
 The nid of the gateway (must be a local interface or a peer).
 .TP
---tgt nid 
-For a specific route, this is the target nid.
+--gateway_cluster_id id 
+Specify the id of the cluster, to which the gateway belongs.
+.TP
+--target_cluster_id id 
+Specify the id of the cluster, to which the target of the route belongs.
 .TP
 --lo nid 
 For a range route, this is the lo value nid.
@@ -210,7 +247,23 @@ Send output to the file. If the file exists, it will be overwritten.
 .TP
 --merge filename 
 Add the new element to an existing file. 
+.TP
+--reference 
+Print short reference for commands.
+.TP
+--verbose 
+Print system commands as they are run.
+.TP
+--batch filename 
+Used to execute lmc commands in batch mode.
 .SH EXAMPLES
-Real life examples are given in the Lustre-conf manual page.
+.TP
+.B lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp --hostaddr adev3-eth0 --port 988
+.TP
+.B lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp --hostaddr adev3-eth1 --port 989
+Used to add a Lustre node to a specified Lustre cluster through a network interface. In this example, Lustre node adev3 has been added to 2 Lustre clusters whose cluster_id are 0x1000 and 0x2000 separately through 2 network interface cards: adev3-eth0 and adev3-eth1. adev3 would listen in some specified port(s) to prepare for possible connection requests from nodes in these two clusters.
+.TP
+.B lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000 --target_cluster_id 0x1000 --lo 4 --hi 7
+Used to add a route entry for a Lustre node. Here Lustre node adev3 is told it has a new route entry that now it could send packets to Lustre nodes whose nids is from 4 to 7 with the help of Lustre gateway node whose nid is 5. Besides, Lustre gateway node is in cluster whose id is 0x1000 and target of the route belongs to cluster whose id is also 0x1000. The network in this route path is a tcp network.
 .SH BUGS
 None are known.
diff --git a/lustre/doc/lmc.lyx b/lustre/doc/lmc.lyx
index bb6ca2b..1107741 100644
--- a/lustre/doc/lmc.lyx
+++ b/lustre/doc/lmc.lyx
@@ -119,11 +119,7 @@ net
 \series default 
 ,
 \series bold 
- 
-\series default 
-or
-\series bold 
- echo_client.
+ echo_client, or cobd.
  
 \series default 
 We describe the arguments required for the addition of each 
@@ -172,6 +168,15 @@ The arguments required are:
 --upcall\SpecialChar ~
 <path> Specify the location of both (Lustre and Portals) upcall
  scripts used by the client for recovery
+\layout Description
+
+--ptldebug\SpecialChar ~
+<debug_level> Set the portals debug level.
+\layout Description
+
+--subsytem\SpecialChar ~
+<subsystem_name> Specify which Lustre subsystems have debug output
+ recorded in the log.
 \end_deeper 
 \layout Description
 
@@ -195,7 +200,7 @@ The arguments required are:
 \layout Description
 
 --nettype\SpecialChar ~
-<type> This can be 
+<type> Specify the network type.This can be 
 \series bold 
 tcp, elan, gm.
 \layout Description
@@ -231,7 +236,13 @@ client
  configuration.
 \layout Description
 
---hostaddr addr
+--cluster_id\SpecialChar ~
+id Specify the cluster ID.
+\layout Description
+
+--hostaddr\SpecialChar ~
+addr Specify the host address.
+ lconf will transfer it to the real host address.
 \layout Description
 
 --router Optional flag to mark this node as a router
@@ -272,7 +283,14 @@ name> Name of the node on which the MDS resides
 \layout Description
 
 --mds\SpecialChar ~
-<mds_name> 
+<mds_name> Specify MDS name.
+\layout Description
+
+--mdsuuid\SpecialChar ~
+<uuid> Specify MDS uuid.
+\layout Description
+
+--failover Enable failover support on MDS.
 \layout Description
 
 --dev\SpecialChar ~
@@ -299,6 +317,38 @@ extN|ext3 Optional argument used to specify the file system type.
  Default is ext3.
 \layout Description
 
+--inode_size\SpecialChar ~
+<size> Specify new inode size for underlying ext3 file system.
+\layout Description
+
+--mkfsoptions\SpecialChar ~
+<options> Optional argument to mkfs.
+\layout Description
+
+--mountfsoptions\SpecialChar ~
+<options> Optional argument to mount fs.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding ",extents" to the --mountfsopt
+ions option.
+ 
+\begin_inset Quotes eld
+\end_inset 
+
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset 
+
+ and 
+\begin_inset Quotes eld
+\end_inset 
+
+asyncdel
+\begin_inset Quotes erd
+\end_inset 
+
+ can also be added to it.
+\layout Description
+
 --journal_size\SpecialChar ~
 <size> Optional arguement to specify the journal size for
  the ext2/ext3 file system.
@@ -323,15 +373,15 @@ mds_name
 \layout Description
 
 --lov\SpecialChar ~
-<name>
+<name> Specify LOV name.
 \layout Description
 
 --mds\SpecialChar ~
-<name>
+<name> Specify the mds name.
 \layout Description
 
 --stripe_sz\SpecialChar ~
-<size>
+<size> Specify the stripe size in bytes.
 \layout Description
 
 --stripe_cnt\SpecialChar ~
@@ -360,6 +410,9 @@ ost Creates an OBD, OST, and OSC.
  node.
 \layout Description
 
+--failover Enable failover support on OST.
+\layout Description
+
 --dev\SpecialChar ~
 <pathname> Path of device on local system.
  If this is a file, then a loop device is created and used as the block
@@ -371,8 +424,8 @@ ost Creates an OBD, OST, and OSC.
  to be created (used typically for loop devices).
 \layout Description
 
---obdtype\SpecialChar ~
-obdfilter|obdecho 
+--osdtype\SpecialChar ~
+obdfilter|obdecho Specify the type of OSD.
 \layout Description
 
 --lov\SpecialChar ~
@@ -391,6 +444,38 @@ extN|ext3 Optional arguement used to specify the file system type.
  Default is ext3.
 \layout Description
 
+--inode_size\SpecialChar ~
+<size> Specify new inode size for underlying ext3 file system.
+\layout Description
+
+--mkfsoptions\SpecialChar ~
+<options> Optional argument to mkfs.
+\layout Description
+
+--mountfsoptions\SpecialChar ~
+<options> Optional argument to mount fs.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding ",extents" to the --mountfsopt
+ions option.
+ 
+\begin_inset Quotes eld
+\end_inset 
+
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset 
+
+ and 
+\begin_inset Quotes eld
+\end_inset 
+
+asyncdel
+\begin_inset Quotes erd
+\end_inset 
+
+ can also be added to it.
+\layout Description
+
 --journal_size\SpecialChar ~
 <size> Optional arguement to specify the journal size for
  the ext2/ext3 file system.
@@ -419,19 +504,23 @@ mtpt
 \layout Description
 
 --path\SpecialChar ~
-/mnt/path\SpecialChar ~
-
+/mnt/path Specify the mountpoint for Lustre.
 \layout Description
 
 --mds\SpecialChar ~
-mds_name 
+mds_name Specify the mds name, which will provide service for this
+ client.
 \layout Description
 
 --ost\SpecialChar ~
 ost_name\SpecialChar ~
 |\SpecialChar ~
 --lov\SpecialChar ~
-lov_name
+lov_name Specify the ost or lov, which will provide service
+ for this client.
+\layout Description
+
+--clientoptions Specify the options for Lustre, such as async.
 \end_deeper 
 \layout Description
 
@@ -452,6 +541,9 @@ nid
 node Node to add the route to.
 \layout Description
 
+--router Optional flag to mark a node as router.
+\layout Description
+
 --gw\SpecialChar ~
 nid The 
 \emph on 
@@ -460,10 +552,14 @@ nid
  of the gateway (must be a local interface or a peer).
 \layout Description
 
---tgt\SpecialChar ~
-nid For a specific route, this is the target 
-\emph on 
-nid.
+--gateway_cluster_id\SpecialChar ~
+id Specify the id of the cluster, to which the gateway
+ belongs.
+\layout Description
+
+--target_cluster_id\SpecialChar ~
+id Specify the id of the cluster, to which the target
+ of the route belongs.
 \layout Description
 
 --lo\SpecialChar ~
@@ -486,13 +582,27 @@ echo-client Used for testing purpose only.
 \layout Description
 
 --node\SpecialChar ~
-node
+nodename
 \emph on 
  
+\emph default 
+Node on which the echo-client resides.
+\end_deeper 
+\layout Description
+
+--add\SpecialChar ~
+mgmt Management/monitoring service.
+\begin_deeper 
+\layout Description
+
+--node\SpecialChar ~
+nodename
+\emph on 
+ 
+\emph default 
+Node on which the mgmt service resides.
 \layout Description
 
---obd\SpecialChar ~
-obd_name 
 \end_deeper 
 \layout List
 \labelwidthstring 00.00.0000
@@ -502,6 +612,16 @@ obd_name
 Options
 \layout Description
 
+--reference Print short reference for commands.
+\layout Description
+
+--verbose Print system commands as they are run.
+\layout Description
+
+--batch\SpecialChar ~
+filename Used to execute lmc commands in batch mode.
+\layout Description
+
 --output\SpecialChar ~
 filename Send output to the file.
  If the file exists, it will be overwritten.
@@ -517,9 +637,51 @@ Add the new element to an existing file.
 \layout Subsection
 
 EXAMPLES
+\layout Subsubsection
+
+--add net
+\layout Standard
+
+
+\series bold 
+lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp
+ --hostaddr adev3-eth0 --port 988
+\layout Standard
+
+
+\series bold 
+lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp
+ --hostaddr adev3-eth1 --port 989
+\series default 
+\emph on 
+ 
+\layout Standard
+
+Used to add a Lustre node to a specified Lustre cluster through a network
+ interface.
+ In this example, Lustre node adev3 has been added to 2 Lustre clusters
+ whose cluster_id are 0x1000 and 0x2000 separately through 2 network interface
+ cards: adev3-eth0 and adev3-eth1.
+ adev3 would listen in some specified port(s) to prepare for possible connection
+ requests from nodes in these two clusters.
+\layout Subsubsection
+
+--add route
+\layout Standard
+
+
+\series bold 
+lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000
+ --target_cluster_id 0x1000 --lo 4 --hi 7
 \layout Standard
 
-Real life examples are given in the Lustre-conf manual page.
+Used to add a route entry for a Lustre node.
+ Here Lustre node adev3 is told it has a new route entry that now it could
+ send packets to Lustre nodes whose nids is from 4 to 7 with the help of
+ Lustre gateway node whose nid is 5.
+ Besides, Lustre gateway node is in cluster whose id is 0x1000 and target
+ of the route belongs to cluster whose id is also 0x1000.
+ The network in this route path is a tcp network.
 \layout Subsection
 
 BUGS
-- 
1.8.3.1