summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-get-property.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:54 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:54 +0000
commit66e4b69042cd3b44acd42f1fad2109180c1bc48b (patch)
tree8bd8e664ae856167566375357963062e8112f181 /Documentation/nvme-get-property.txt
parentReleasing debian version 2.5-1. (diff)
downloadnvme-cli-66e4b69042cd3b44acd42f1fad2109180c1bc48b.tar.xz
nvme-cli-66e4b69042cd3b44acd42f1fad2109180c1bc48b.zip
Merging upstream version 2.7.1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-get-property.txt')
-rw-r--r--Documentation/nvme-get-property.txt20
1 files changed, 13 insertions, 7 deletions
diff --git a/Documentation/nvme-get-property.txt b/Documentation/nvme-get-property.txt
index b2b7d29..601b8a4 100644
--- a/Documentation/nvme-get-property.txt
+++ b/Documentation/nvme-get-property.txt
@@ -9,25 +9,32 @@ for NVMe over Fabric
SYNOPSIS
--------
[verse]
-'nvme get-property' <device> [--offset=<offset> | -o <offset>]
- [--human-readable | -H ]
-
+'nvme get-property' <device> [--offset=<offset> | -O <offset>]
+ [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Reads and shows the defined NVMe controller property for NVMe over Fabric.
-
OPTIONS
-------
--o::
+-O::
--offset::
- The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20
+ The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20
-H::
--human-readable:
Show the fields packed in the property
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
@@ -37,7 +44,6 @@ EXAMPLES
# nvme get-property /dev/nvme0 --offset=0x0 --human-readable
------------
-
BUGS
----
Currently the CAP value is truncated to 32 bits due to a limitation in