From d3f14b341f24e28a453c02a99c7072d2bd39b86a Mon Sep 17 00:00:00 2001
From: wangchao <wangchao>
Date: Thu, 16 Sep 2004 04:20:01 +0000
Subject: [PATCH] b=4575 update the manual for lmc, lconf and lctl

---
 lustre/doc/lconf.8   |  35 +++++++++++++++-
 lustre/doc/lconf.lyx |   4 ++
 lustre/doc/lctl.8    | 114 +++++++++++++++++++++++++++++++++++++++++++-------
 lustre/doc/lctl.lyx  | 114 +++++++++++++++++++++++++-------------------------
 lustre/doc/lmc.1     | 116 ++++++++++++++++++++++++++++++++++++++++++++++-----
 lustre/doc/lmc.lyx   |  25 +++++++++++
 6 files changed, 325 insertions(+), 83 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 a7d8b62..e00d94d 100644
--- a/lustre/doc/lconf.lyx
+++ b/lustre/doc/lconf.lyx
@@ -60,6 +60,10 @@ This program configures a node following directives in the <XML-config-file>.
 <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
diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8
index 1e112dd..55652c0 100644
--- a/lustre/doc/lctl.8
+++ b/lustre/doc/lctl.8
@@ -35,18 +35,57 @@ 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
+autoconn_list 
+Print autoconnect entries.
+.TP
+add_autoconn nid ipaddr port [ise] 
+Add an autoconnect entry.
+.TP
+del_autoconn [<nid>] [<host>] [ks] 
+Remove an autoconnect 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 +101,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 +147,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 +231,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 +284,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 f3ea478..268dc3b 100644
--- a/lustre/doc/lctl.lyx
+++ b/lustre/doc/lctl.lyx
@@ -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
@@ -214,6 +214,59 @@ network\SpecialChar ~
  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
+
 autoconn_list Print autoconnect entries.
 \layout Description
 
@@ -347,61 +400,6 @@ set_route\SpecialChar ~
 route_list Print the complete portals routing table.
 \layout Description
 
-recv_mem\SpecialChar ~
-[size] Set the buffer size for socket 
-\emph on 
-receive
-\emph default 
- buffer(that is, assign 
-\begin_inset Quotes eld
-\end_inset 
-
-size
-\begin_inset Quotes erd
-\end_inset 
-
- to g_socket_rxmem).
- If the argument of 
-\begin_inset Quotes eld
-\end_inset 
-
-size
-\begin_inset Quotes erd
-\end_inset 
-
- is omitted, this command should print the default size for the buffer.
-\layout Description
-
-send_mem\SpecialChar ~
-[size] Set the buffer size for socket 
-\emph on 
-send
-\emph default 
- buffer(that is, assign 
-\begin_inset Quotes eld
-\end_inset 
-
-size
-\begin_inset Quotes erd
-\end_inset 
-
- to g_socket_txmem).
- If the argument of 
-\begin_inset Quotes eld
-\end_inset 
-
-size
-\begin_inset Quotes erd
-\end_inset 
-
- is omitted, this command should print the default size for the buffer.
-\layout Description
-
-nagle\SpecialChar ~
-[on/off] Enable/disable nagle; omitting the argument will cause the
- current nagle setting to be reported.
-\layout Description
-
 fail\SpecialChar ~
 nid|_all_\SpecialChar ~
 [count] Fail/restore communications.
@@ -703,6 +701,10 @@ readonly Disable writes to the underlying device.
 abort_recovery Abort recovery on MDS device.
 \layout Description
 
+start\SpecialChar ~
+<profilename> Setup mds/ost from the llog file.
+\layout Description
+
 mount_option\SpecialChar ~
 profile\SpecialChar ~
 osc_name\SpecialChar ~
diff --git a/lustre/doc/lmc.1 b/lustre/doc/lmc.1
index 28f51ad..3e2d19b 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
@@ -40,16 +40,22 @@ The arguements required are:
 This will create a new node with the given name if not already present.
 .TP
 --timeout <num>
-Timeout before going into recovery
+Timeout before going into recovery.
 .TP
 --lustre_upcall <path> 
-Set the location of the Lustre upcall scripts used by the client for recovery
+Set the location of the Lustre upcall scripts used by the client for recovery.
 .TP
 --portals_upcall <path> 
-Specify the location of the Portals upcall scripts used by the client for recovery
+Specify the location of the Portals upcall scripts used by the client for recovery.
 .TP
 --upcall <path> 
-Specify the location of both (Lustre and Portals) upcall scripts used by the client for recovery
+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,10 +70,14 @@ 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
+Optional flag to mark this node as a router.
 .TP
 --port [port] 
 Optional arguement to indicate the tcp port. The default is 988. 
@@ -82,17 +92,26 @@ Optional arguement. Default is 0.
 Optional arguement since some OSTs might not have the required support. This is turned off by default, value of 1 will turn it ON. 
 .PP
 .B --add mds
-Specify the MDS configuration
+Specify the MDS configuration:
 .TP
 --node <node name> 
-Name of the node on which the MDS resides
+Name of the node on which the MDS resides.
 .TP
 --mds <mds_name> 
-Common name of the MDS
+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
@@ -102,6 +121,21 @@ 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
+--backfstype ext3|tmpfs 
+Specify the backing filesystem type.
+.TP
+--nspath 
+Local mount point of server namespace.
+.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
@@ -132,9 +166,15 @@ 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 
+Enable failover support on OST.
+.TP
 --dev <pathname> 
 Path of device on local system. If this 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
@@ -150,6 +190,21 @@ Specify the UUID of the OST device.
 --fstype 
 extN|ext3 Optional arguement used to specify the file system type. Default is ext3.
 .TP
+--backfstype ext3|tmpfs 
+Optional argument to specify the backing filesystem type.
+.TP
+--inode_size <size> 
+Specify new inode size for underlying ext3 file system.
+.TP
+--nspath 
+Local mount point of server namespace.
+.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
@@ -167,6 +222,9 @@ MDS name
 .TP
 --ost ost_name | --lov lov_name
 OST or LOV name as specified earlier in the configuration
+.TP
+--clientoptions options
+Specify the options for Lustre, such as async.
 .PP
 .B --add route 
 Creates a static route through a gateway to a specific nid or a range of nid's.
@@ -174,11 +232,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 
+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.
@@ -193,6 +257,27 @@ Used for testing purpose only.
 Name of the node that echo client should run on,
 .TP
 --obd obd_name 
+.PP
+.B --add mgmt 
+Management/monitoring service.
+.TP
+--node nodename 
+Node on which the mgmt service resides.
+.TP
+--mgmt <mgmt_service_name> 
+Specify management/monitoring service name.
+.PP
+.B --add cobd 
+Create the cobd on the specified node.
+.TP
+--node nodename 
+Node on which the cobd resides.
+.TP
+--cache_obd obd_name 
+Specify the cache device for the cache obd system.
+.TP
+--real_obd obd_name 
+Specify the real device for the cache obd system.
 .SH OPTIONS
 One of the following options should be specified.
 .TP 12
@@ -201,6 +286,15 @@ 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.
 .SH BUGS
diff --git a/lustre/doc/lmc.lyx b/lustre/doc/lmc.lyx
index 5a73e06..f8b018d 100644
--- a/lustre/doc/lmc.lyx
+++ b/lustre/doc/lmc.lyx
@@ -286,6 +286,10 @@ name> Name of the node on which the MDS resides
 <mds_name> Specify MDS name.
 \layout Description
 
+--mdsuuid\SpecialChar ~
+<uuid> Specify MDS uuid.
+\layout Description
+
 --failover Enable failover support on MDS.
 \layout Description
 
@@ -538,6 +542,9 @@ ost_name\SpecialChar ~
 --lov\SpecialChar ~
 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
 
@@ -605,6 +612,24 @@ nodename
 \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
+
+--mgmt\SpecialChar ~
+<mgmt_service_name> Specify management/monitoring service name.
+\end_deeper 
 \layout List
 \labelwidthstring 00.00.0000
 
-- 
1.8.3.1