summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-lnvm-id-ns.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-lnvm-id-ns.txt49
1 files changed, 49 insertions, 0 deletions
diff --git a/Documentation/nvme-lnvm-id-ns.txt b/Documentation/nvme-lnvm-id-ns.txt
new file mode 100644
index 0000000..1a3565f
--- /dev/null
+++ b/Documentation/nvme-lnvm-id-ns.txt
@@ -0,0 +1,49 @@
+nvme-lnvm-id-ns(1)
+==================
+
+NAME
+----
+nvme-lnvm-id-ns - Identify Geometry for LightNVM NVMe device
+
+SYNOPSIS
+--------
+[verse]
+'nvme lnvm-id-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--force | -f]
+ [--raw-binary | -b]
+ [--human-readable | -H]
+
+DESCRIPTION
+-----------
+Send an Identify Geometry command to the given LightNVM device, returns
+properties of the specified namespace in either human-readable or binary
+format.
+
+OPTIONS
+-------
+--namespace-id=<nsid>::
+-n <nsid>::
+ Retrieve the geometry from the selected namespace.
+
+--force::
+-f::
+ Try to read the data and assume it is a LightNVM device
+
+--raw-binary::
+-b::
+ Output the raw output
+
+--human-readable::
+-H::
+ Output the status in human readable format
+
+EXAMPLES
+--------
+* Retrieve the geometry from nvme0
+------------
+# nvme lnvm-id-ns /dev/nvme0 -n 1
+------------
+
+NVME
+----
+Part of the nvme-user suite