summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-write-zeroes.1
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-write-zeroes.1')
-rw-r--r--Documentation/nvme-write-zeroes.149
1 files changed, 31 insertions, 18 deletions
diff --git a/Documentation/nvme-write-zeroes.1 b/Documentation/nvme-write-zeroes.1
index 0ec2964..6c8f5c4 100644
--- a/Documentation/nvme-write-zeroes.1
+++ b/Documentation/nvme-write-zeroes.1
@@ -2,12 +2,12 @@
.\" Title: nvme-write-zeroes
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/21/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WRITE\-ZEROES" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WRITE\-ZEROES" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -37,32 +37,31 @@ nvme-write-zeroes \- Send an NVMe write zeroes command, return results
[\-\-ref\-tag=<reftag> | \-r <reftag>]
[\-\-prinfo=<prinfo> | \-p <prinfo>]
[\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
- [\-\-app\-tag=<apptag> | \-a <apptag>]
- [\-\-deac | \-d]
- [\-\-limited\-retry | \-l]
- [\-\-force\-unit\-access | \-f]
+ [\-\-app\-tag=<apptag> | \-a <apptag>] [\-\-deac | \-d]
+ [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f]
[\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-storage\-tag<storage\-tag> | \-S <storage\-tag>]
[\-\-storage\-tag\-check<storage\-tag\-check> | \-C <storage\-tag\-check>]
[\-\-dir\-type=<dtype> | \-T <dtype>]
[\-\-dir\-spec=<dspec> | \-D <dspec>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Write Zeroes command is used to set a range of logical blocks to 0\&.
.SH "OPTIONS"
.PP
-\-\-start\-block=<slba>, \-s <slba>
+\-s <slba>, \-\-start\-block=<slba>
.RS 4
Start block\&.
.RE
.PP
-\-\-block\-count=<nlb>, \-c <nlb>
+\-c <nlb>, \-\-block\-count=<nlb>
.RS 4
Number of logical blocks to write zeroes\&.
.RE
.PP
-\-\-prinfo=<prinfo>, \-p <prinfo>
+\-p <prinfo>, \-\-prinfo=<prinfo>
.RS 4
Protection Information field definition\&.
.TS
@@ -107,47 +106,47 @@ T}
.sp 1
.RE
.PP
-\-\-ref\-tag=<reftag>, \-r <reftag>
+\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
Optional reftag when used with protection information\&.
.RE
.PP
-\-\-app\-tag\-mask=<appmask>, \-m <appmask>
+\-m <appmask>, \-\-app\-tag\-mask=<appmask>
.RS 4
Optional application tag mask when used with protection information\&.
.RE
.PP
-\-\-app\-tag=<apptag>, \-a <apptag>
+\-a <apptag>, \-\-app\-tag=<apptag>
.RS 4
Optional application tag when used with protection information\&.
.RE
.PP
-\-\-limited\-retry, \-l
+\-l, \-\-limited\-retry
.RS 4
Sets the limited retry flag\&.
.RE
.PP
-\-\-deac, \-d
+\-d, \-\-deac
.RS 4
Sets the DEAC bit, requesting controller deallocate the logical blocks\&.
.RE
.PP
-\-\-force\-unit\-access, \-f
+\-f, \-\-force\-unit\-access
.RS 4
Set the force\-unit access flag\&.
.RE
.PP
-\-\-namespace\-id=<nsid>, \-n <nsid>
+\-n <nsid>, \-\-namespace\-id=<nsid>
.RS 4
Namespace ID use in the command\&.
.RE
.PP
-\-\-storage\-tag=<storage\-tag>, \-S <storage\-tag>
+\-S <storage\-tag>, \-\-storage\-tag=<storage\-tag>
.RS 4
Variable Sized Logical Block Storage Tag(LBST)\&.
.RE
.PP
-\-\-storage\-tag\-check=<storage\-tag\-check>, \-C <storage\-tag\-check>
+\-C <storage\-tag\-check>, \-\-storage\-tag\-check=<storage\-tag\-check>
.RS 4
This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&.
.RE
@@ -161,6 +160,20 @@ Directive type
.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\&.