summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-set-property.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-set-property.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/Documentation/nvme-set-property.txt b/Documentation/nvme-set-property.txt
new file mode 100644
index 0000000..22a513c
--- /dev/null
+++ b/Documentation/nvme-set-property.txt
@@ -0,0 +1,45 @@
+nvme-set-property(1)
+====================
+
+NAME
+----
+nvme-set-property - Writes and shows the defined NVMe controller property
+for NVMe over Fabric
+
+SYNOPSIS
+--------
+[verse]
+'nvme set-property' <device> [--offset=<offset> | -O <offset>]
+ [--value=<val> | -V <val>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Writes and shows the defined NVMe controller property for NVMe over Fabric.
+
+OPTIONS
+-------
+-O::
+--offset::
+ The offset of the property.
+
+-V::
+--value:
+ The value of the property to be set.
+
+-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
+--------
+No examples (yet).
+
+NVME
+----
+Part of the nvme-user suite