]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
update passthrough documentation
authorKeith Busch <kbusch@kernel.org>
Fri, 7 Jan 2022 17:08:55 +0000 (09:08 -0800)
committerKeith Busch <kbusch@kernel.org>
Fri, 7 Jan 2022 17:28:52 +0000 (09:28 -0800)
Adding the metadata file parameter.

Signed-off-by: Keith Busch <kbusch@kernel.org>
Documentation/nvme-io-passthru.txt

index 5a16698e09ca5e1bf9f932968a1b6e2c6bd33fe4..ba0904cf6414e64325bdd00cbdd618614dab3bda 100644 (file)
@@ -18,6 +18,7 @@ SYNOPSIS
                [--metadata-len=<len> | -m <len>]
                [--read | -r ] [--write | -w]
                [--input-file=<file> | -i <file>]
+               [--metadata=<file> | -M <file>]
                [--timeout=<to> | -t <to>]
                [--show-command | -s]
                [--dry-run | -d]
@@ -73,8 +74,16 @@ OPTIONS
 -i <file>::
 --input-file=<file>::
        If the command is a data-out (write) command, use this file
-       to fill the buffer sent to the device. If no file is given,
-       assumed to use STDIN.
+       to fill the buffer sent to the device. If no file is given, assumed to
+       use STDIN. If the command is a data-in (read) command, the data
+       returned from the device will be saved here.
+
+-M <file>::
+--metadata=<file>::
+       If the command is a data-out (write) command, use this file
+       to fill the metadata buffer sent to the device. If no file is given,
+       assumed to use STDIN. If the command is a data-in (read) command, the
+       metadata returned from the device will be saved here.
 
 -l <data-len>::
 --data-len=<data-len>::