summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-lnvm-id-ns.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-lnvm-id-ns.188
1 files changed, 88 insertions, 0 deletions
diff --git a/Documentation/nvme-lnvm-id-ns.1 b/Documentation/nvme-lnvm-id-ns.1
new file mode 100644
index 0000000..22efa51
--- /dev/null
+++ b/Documentation/nvme-lnvm-id-ns.1
@@ -0,0 +1,88 @@
+'\" t
+.\" Title: nvme-lnvm-id-ns
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 04/24/2020
+.\" Manual: NVMe Manual
+.\" Source: NVMe
+.\" Language: English
+.\"
+.TH "NVME\-LNVM\-ID\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nvme-lnvm-id-ns \- Identify Geometry for LightNVM NVMe device
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme lnvm\-id\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-force | \-f]
+ [\-\-raw\-binary | \-b]
+ [\-\-human\-readable | \-H]
+.fi
+.SH "DESCRIPTION"
+.sp
+Send an Identify Geometry command to the given LightNVM device, returns properties of the specified namespace in either human\-readable or binary format\&.
+.SH "OPTIONS"
+.PP
+\-\-namespace\-id=<nsid>, \-n <nsid>
+.RS 4
+Retrieve the geometry from the selected namespace\&.
+.RE
+.PP
+\-\-force, \-f
+.RS 4
+Try to read the data and assume it is a LightNVM device
+.RE
+.PP
+\-\-raw\-binary, \-b
+.RS 4
+Output the raw output
+.RE
+.PP
+\-\-human\-readable, \-H
+.RS 4
+Output the status in human readable format
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Retrieve the geometry from nvme0
+.RE
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme lnvm\-id\-ns /dev/nvme0 \-n 1
+.fi
+.if n \{\
+.RE
+.\}
+.SH "NVME"
+.sp
+Part of the nvme\-user suite