diff options
Diffstat (limited to 'Documentation/nvme-write-uncor.1')
-rw-r--r-- | Documentation/nvme-write-uncor.1 | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/Documentation/nvme-write-uncor.1 b/Documentation/nvme-write-uncor.1 new file mode 100644 index 0000000..1523285 --- /dev/null +++ b/Documentation/nvme-write-uncor.1 @@ -0,0 +1,90 @@ +'\" t +.\" Title: nvme-uncor +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 02/14/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-UNCOR" "1" "02/14/2024" "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-write-uncor \- Send an NVMe write uncorrectable command, return results +.SH "SYNOPSIS" +.sp +.nf +\fInvme\-write\-uncor\fR <device> [\-\-start\-block=<slba> | \-s <slba>] + [\-\-block\-count=<nlb> | \-c <nlb>] + [\-\-namespace\-id=<nsid> | \-n <nsid>] + [\-\-dir\-type=<dtype> | \-T <dtype>] + [\-\-dir\-spec=<dspec> | \-S <dspec>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] +.fi +.SH "DESCRIPTION" +.sp +The Write Uncorrectable command is used to invalidate a range of logical blocks\&. +.SH "OPTIONS" +.PP +\-s <slba>, \-\-start\-block=<slba> +.RS 4 +Start block\&. +.RE +.PP +\-c, \-\-block\-count=<nlb> +.RS 4 +Number of logical blocks to write uncorrectable\&. +.RE +.PP +\-n <nsid>, \-\-namespace\-id=<nsid> +.RS 4 +Namespace ID use in the command\&. +.RE +.PP +\-T <dtype>, \-\-dir\-type=<dtype> +.RS 4 +Directive type +.RE +.PP +\-S <dspec>, \-\-dir\-spec=<dspec> +.RS 4 +Directive specific +.RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR +or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE +.SH "EXAMPLES" +.sp +No examples yet\&. +.SH "NVME" +.sp +Part of the nvme\-user suite |