From 554a6142aa8fb21855b2d160041c6d84d64c65fd Mon Sep 17 00:00:00 2001
From: wangchao <wangchao>
Date: Thu, 22 Jul 2004 06:07:20 +0000
Subject: [PATCH] b=3362 r=braam update lctl.lyx

---
 lustre/doc/lctl.lyx | 367 ++++++++++++++++++++++++++++++++++++--------
 1 file changed, 302 insertions(+), 65 deletions(-)

diff --git a/lustre/doc/lctl.lyx b/lustre/doc/lctl.lyx
index b3f3f3e672..f3ea478851 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
@@ -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,80 @@ 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
 
+autoconn_list Print autoconnect entries.
+\layout Description
+
+add_autoconn\SpecialChar ~
+
+\series bold 
+nid
+\series default 
+\SpecialChar ~
+
+\series bold 
+ipaddr
+\series default 
+\SpecialChar ~
+
+\series bold 
+port
+\series default 
+\SpecialChar ~
+
+\series bold 
+[ise]
+\series default 
+ Add an autoconnect entry.
+\layout Description
+
+del_autoconn\SpecialChar ~
+
+\series bold 
+[<nid>]
+\series default 
+\SpecialChar ~
+
+\series bold 
+[<host>]
+\series default 
+\SpecialChar ~
+
+\series bold 
+[ks]
+\series default 
+ Remove an autoconnect entry.
+\layout Description
+
+conn_list Print all the connected remote nid.
+\layout Description
+
 connect\SpecialChar ~
-[[<hostname>\SpecialChar ~
-<port>]\SpecialChar ~
-|\SpecialChar ~
-<elan\SpecialChar ~
-id>] This will establish a connection to
- a remote network network 
+<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, or the elan 
-\emph on 
-id
-\emph default 
-.
+ given by the hostname/port combination.
 \layout Description
 
 disconnect\SpecialChar ~
@@ -226,6 +280,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 +294,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 +317,107 @@ 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.
+<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
+
+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
 
-route_list Print the complete routing table.
+route_list Print the complete portals routing table.
 \layout Description
 
 recv_mem\SpecialChar ~
-[size] Set the socket 
+[size] Set the buffer size for socket 
 \emph on 
 receive
 \emph default 
- buffer size; if the size is omitted, the default size for the buffer is
- printed.
+ 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 send buffer size for the socket; if size is omitted,
- the default size for the buffer is printed.
+[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
- default value to be printed.
+ current nagle setting to be reported.
 \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 +429,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 +480,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 +567,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 +645,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 +673,97 @@ 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
+mount_option\SpecialChar ~
+profile\SpecialChar ~
+osc_name\SpecialChar ~
+[mdc_name] Add a new profile to lustre.
 \layout Description
 
-get_stripe show stripe info for an echo client object.
+del_mount_option\SpecialChar ~
+profile Delete a specified profile.
 \layout Description
 
-set_stripe\SpecialChar ~
-<objid>[\SpecialChar ~
-width!count[@offset]\SpecialChar ~
-[:id:id....] set stripe info for an echo
- client
+set_timeout\SpecialChar ~
+<secs> Set the timeout(
+\emph on 
+obd_timeout
+\emph default 
+) for server to wait before failing recovery.
 \layout Description
 
-unset_stripe\SpecialChar ~
-<objid> unset stripe info for an echo client object.
+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 +771,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 debug buffer and dump to a 
 \emph on 
-fileusage
+file
 \emph default 
 .
 \layout Description
 
+dk The same as debug_kernel.
+\layout Description
+
 debug_file\SpecialChar ~
 <input>\SpecialChar ~
 [output]\SpecialChar ~
 [raw] Read debug buffer from input and dump to
  
 \emph on 
-outputusage
+output
 \emph default 
 .
 \layout Description
@@ -604,7 +825,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
 
-- 
GitLab