summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-sanitize.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
commitfc67d3ad9a2903cc33e5cdaedaad51dd86a42236 (patch)
tree4ef72536a965fe220e71aea78b76b6bbbac2ed59 /Documentation/nvme-sanitize.1
parentAdding upstream version 2.5. (diff)
downloadnvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.tar.xz
nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.zip
Adding upstream version 2.7.1.upstream/2.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-sanitize.131
1 files changed, 22 insertions, 9 deletions
diff --git a/Documentation/nvme-sanitize.1 b/Documentation/nvme-sanitize.1
index 7a71f4f..793f2d1 100644
--- a/Documentation/nvme-sanitize.1
+++ b/Documentation/nvme-sanitize.1
@@ -2,12 +2,12 @@
.\" Title: nvme-sanitize
.\" 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\-SANITIZE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SANITIZE" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -32,13 +32,12 @@ nvme-sanitize \- Send NVMe Sanitize Command, return result
.SH "SYNOPSIS"
.sp
.nf
-\fInvme sanitize\fR <device> [\-\-no\-dealloc | \-d]
- [\-\-oipbp | \-i]
- [\-\-owpass=<overwrite\-pass\-count> | \-n <overwrite\-pass\-count>]
- [\-\-ause | \-u]
- [\-\-sanact=<action> | \-a <action>]
- [\-\-ovrpat=<overwrite\-pattern> | \-p <overwrite\-pattern>]
- [\-\-force]
+\fInvme sanitize\fR <device> [\-\-no\-dealloc | \-d] [\-\-oipbp | \-i]
+ [\-\-owpass=<overwrite\-pass\-count> | \-n <overwrite\-pass\-count>]
+ [\-\-ause | \-u] [\-\-sanact=<action> | \-a <action>]
+ [\-\-ovrpat=<overwrite\-pattern> | \-p <overwrite\-pattern>]
+ [\-\-force]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
@@ -127,6 +126,20 @@ Overwrite Pattern: This field is ignored unless the Sanitize Action field in Com
.RS 4
Ignore namespace is currently busy and performed the operation even though\&.
.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
.RS 4