LU-13117 libcfs: fix to match right key in cfs_get_environ()

[fs/lustre-release.git] / lustre / doc / lst.8

diff --git a/lustre/doc/lst.8 b/lustre/doc/lst.8
index a34bcd9..eda9eed 100644 (file)
--- a/lustre/doc/lst.8
+++ b/lustre/doc/lst.8
@@ -1,8 +1,10 @@
-.TH lst 1 "Jul 7, 2008" Lustre "utilities"
+.TH lst 8 "2017 Jan 12" Lustre "configuration utilities"

 .SH NAME
 lst \- Start the Lustre LNET Self-test
 .SH SYNOPSIS
 .B "lst"
 .SH NAME
 lst \- Start the Lustre LNET Self-test
 .SH SYNOPSIS
 .B "lst"

+.br
+.B "lst --list-commands"

 .SH DESCRIPTION
 LNET self-test helps site administrators confirm that Lustre
 Networking (LNET) has been properly installed and configured.
 .SH DESCRIPTION
 LNET self-test helps site administrators confirm that Lustre
 Networking (LNET) has been properly installed and configured.


@@ -26,6 +28,10 @@ These individual point-to-point tests are instantiated according to the
 test type, source group, target group and distribution specified when the
 test is added to the test batch.
 .LP
 test type, source group, target group and distribution specified when the
 test is added to the test batch.
 .LP

+.SH OPTIONS
+.TP
+.B --list-commands
+Output a list of the commands supported by the lst utility

 .SH MODULES
 To run LNET self-test, load these modules: libcfs, lnet, lnet_selftest
 and any one of the klnds (i.e, ksocklnd, ko2iblnd...).
 .SH MODULES
 To run LNET self-test, load these modules: libcfs, lnet, lnet_selftest
 and any one of the klnds (i.e, ksocklnd, ko2iblnd...).


@@ -36,27 +42,15 @@ There are two types of nodes for LNET self-test: the console node and
 test nodes. Both node types require all previously-specified modules
 to be loaded. (The userspace test node does not require these modules.)
 .LP
 test nodes. Both node types require all previously-specified modules
 to be loaded. (The userspace test node does not require these modules.)
 .LP

-Test nodes can be in either kernel or userspace.  A console user can
-invite a kernel test node to join the test session by running
-.I "lst add_group NID",
-but the user cannot actively add a userspace test node to the
-test-session.  However, the console user can passively accept a test
-node to the test session while the test node runs lstclient to connect
-to the console.
-.SH UTILITIES
-LNET self-test has two user utilities, lst and lstclient.
+A console user can invite a test node to join the test session by running
+lst add_group \fINID\fR.

 .LP
 .LP

+.SH UTILITIES

 .B lst
 is the user interface for the self-test console (run on console node).
 It provides a list of commands to control the entire test system,
 such as create session, create test groups, etc.
 .LP
 .B lst
 is the user interface for the self-test console (run on console node).
 It provides a list of commands to control the entire test system,
 such as create session, create test groups, etc.
 .LP

-.B lstclient
-is the userspace self-test program, which is linked with userspace
-LNDs and LNET. A user can use lstclient to join a self-test session:
-.nf
-lstclient -sesid CONSOLE_NID group NAME
-.fi

 .SH EXAMPLE SCRIPT
 Below is a sample LNET self-test script which simulates the traffic
 pattern of a set of Lustre servers on a TCP network, accessed by Lustre
 .SH EXAMPLE SCRIPT
 Below is a sample LNET self-test script which simulates the traffic
 pattern of a set of Lustre servers on a TCP network, accessed by Lustre


@@ -78,7 +72,7 @@ lst add_test --batch bulk_rw --from writers --to servers \
 # start running
 lst run bulk_rw
 # display server stats for 30 seconds
 # start running
 lst run bulk_rw
 # display server stats for 30 seconds

-lst stat servers & sleep 30; kill $?
+lst stat servers & sleep 30; kill $!

 # tear down
 lst end_session
 .fi
 # tear down
 lst end_session
 .fi