[PATCH] blktrace/README: update to include description of new net parameters

[blktrace.git] / README

diff --git a/README b/README
index 5f79e366c3b67d8afde9fcf16f471c6b080b2227..72369668368df5375437d3ccba95c1767c2014f9 100644 (file)
--- a/README
+++ b/README
@@ -60,6 +60,10 @@ $ blktrace -d <dev> [ -r relay_path ] [ -o output ] [ -k ] [ -w time ]
 
        -b Sub buffer size in KiB.
        -n Number of sub buffers.
+       -l Run in network listen mode (blktrace server)
+       -h Run in network client mode, connecting to the given host
+       -p Network port to use (default 8462)
+       -s Make the network client use sendfile() to transfer data
        -V Print program version info.
 
 $ blkparse -i <input> [ -o <output> ] [ -b rb_batch ] [ -s ] [ -t ] [ -q ]
@@ -142,13 +146,16 @@ and blkparse:
 
 This has a small risk of displaying some traces a little out of sync, since
 it will do batch sorts of input events. Similarly, you can do traces over
-the network with eg netcat:
+the network. The network 'server' must run:
 
-% blktrace -d /dev/sda -o - | netcat parsehost portno
-% netcat -l -p portno tracehost | blkparse -i -
+% blktrace -l
+
+to listen to incoming blktrace connections, while the client should use
+
+% blktrace -d /dev/sda -h <server hostname>
+
+to connect and transfer data over the network.
 
-Which will send the traces from tracehost to parsehost over the network on
-the defined port number.
 
 Documentation
 -------------