[PATCH] Cleaned up old LVM/MD references, cleaned up btt/README.

[blktrace.git] / btt / README

diff --git a/btt/README b/btt/README
index 23eac049f928e2ad7f82b8f4c30df5e78f4c5c8e..41ecdc40f1ae590880ac387a14e5ceead0d0374a 100644 (file)
--- a/btt/README
+++ b/btt/README
@@ -6,37 +6,48 @@ Alan D. Brunelle (initial version)
 Usage
 -----
 
-$ btt -i <input file> (-l | -m) [-d <range delta>] [-D <devices...>]
-      [-e <executables...>] [-h] [-M map information] [-o <output file>]
-      [-v] [-V]
+Usage: btt
+       [ -d <seconds>     | --range-delta=<seconds> ]
+       [ -D <dev;...>     | --devices=<dev;...> ]
+       [ -e <exe,...>     | --exes=<exe,...>  ]
+       [ -h               | --help ]
+       [ -i <input name>  | --input-file=<input name> ]
+       [ -I <output name> | --iostat=<output name> ]
+       [ -M <dev map>     | --dev-maps=<dev map>
+       [ -o <output name> | --output-file=<output name> ]
+       [ -s <output name> | --seeks=<output name> ]
+       [ -S <interval>    | --iostat-interval=<interval> ]
+       [ -V               | --version ]
+       [ -v               | --verbose ]
 
-You are required to:
+You are required to specify an input file (-i)
 
-o  Specify an input file (-i)
-
-o  Specify MD (-m) or LVM2/DM (-l) devices present (If no software RAID
-   devices, use -m.) This is a workaround for issues between LVM2 and MD
-   remap events that needs to be cleaned up. [DM devices are not working
-   as of right now, always specify -m for individual disks and/or MD
-   devices.]
-
-The -d argument allows you to specify the granularity which dtermines
+The -d option allows you to specify the granularity which determines
 "activity" with regard to the .dat files -- this specific the time
 (in seconds) that must elapse without a particular event occuring to
 signify inactivity. The larger the number, the fewer ranges output --
 the default is 0.1 seconds.
 
-The -D argument supplies the devices which should be looked at when
+The -D option supplies the devices which should be looked at when
 analyzing the input. This is a ":" separated list of devices, devices are
 specified by a mjr,mnr tuple (e.g.: -D "8,0:8,8" specifies two devices
 with major 8 and minor 0 and 8 respectively).
 
-The -e argument supplies the list of executables that will have I/Os
+The -e option supplies the list of executables that will have I/Os
 analyzed.
 
-The -M argument takes in a file generated by the provided script
+The -I option directs btt to output iostat-like data to the specified
+file.  Refer to the iostat (sysstat) documentation for details on the
+data columns. The -S option specifies the interval to use between data
+output, it defaults to once per second.
+
+The -M option takes in a file generated by the provided script
 (gen_disk_info.py), and allows for better output of device names.
 
+The -s option instructs btt to output seek data, the argument provided
+is the basis for file names output. There are two files per device,
+read seeks and write seeks.
+
 Overview
 --------
 
@@ -54,4 +65,4 @@ The list is called linux-btrace@vger.kernel.org, subscribe by sending
 a mail to majordomo@vger.kernel.org with 'subscribe linux-btrace' in
 the mail body.
 
-2006-05-17, Alan D. Brunelle <alan.brunelle@hp.com>
+2006-09_18, Alan D. Brunelle <alan.brunelle@hp.com>