From: Gollu Appalanaidu Date: Tue, 6 Jul 2021 20:08:23 +0000 (+0530) Subject: nvme: add verify command man page X-Git-Tag: v1.15~28 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=aa0b47ea91a6ae166df74beaafc415426f1439e1;p=users%2Fsagi%2Fnvme-cli.git nvme: add verify command man page Signed-off-by: Gollu Appalanaidu --- diff --git a/Documentation/nvme-verify.1 b/Documentation/nvme-verify.1 new file mode 100644 index 00000000..94126213 --- /dev/null +++ b/Documentation/nvme-verify.1 @@ -0,0 +1,139 @@ +'\" t +.\" Title: nvme-verify +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 07/07/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-VERIFY" "1" "07/07/2021" "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-verify \- Send an NVMe Verify command, return results +.SH "SYNOPSIS" +.sp +.nf +\fInvme\-verify\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-block= | \-s ] + [\-\-block\-count= | \-c ] + [\-\-limited\-retry | \-l] + [\-\-force\-unit\-access | \-f] + [\-\-prinfo= | \-p ] + [\-\-ref\-tag= | \-r ] + [\-\-app\-tag\-mask= | \-m ] + [\-\-app\-tag= | \-a ] +.fi +.SH "DESCRIPTION" +.sp +The Verify command verifies the integrity of the stored information by reading data and metadata\&. +.SH "OPTIONS" +.PP +\-\-namespace\-id=, \-n +.RS 4 +Namespace ID use in the command\&. +.RE +.PP +\-\-start\-block=, \-s +.RS 4 +Start block address\&. +.RE +.PP +\-\-block\-count=, \-c +.RS 4 +Number of logical blocks to Verify\&. +.RE +.PP +\-\-limited\-retry, \-l +.RS 4 +Sets the limited retry flag\&. +.RE +.PP +\-\-force\-unit\-access, \-f +.RS 4 +Set the force\-unit access flag\&. +.RE +.PP +\-\-prinfo=, \-p +.RS 4 +Protection Information field definition\&. +.TS +allbox tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +Bit +T}:T{ +Description +T} +T{ +3 +T}:T{ +PRACT: Protection Information Action\&. When set to 1, PI is stripped/inserted on read/write when the block format\(cqs metadata size is 8\&. When set to 0, metadata is passes\&. +T} +T{ +2:0 +T}:T{ +PRCHK: Protection Information Check: +T} +T{ +2 +T}:T{ +Set to 1 enables checking the guard tag +T} +T{ +1 +T}:T{ +Set to 1 enables checking the application tag +T} +T{ +0 +T}:T{ +Set to 1 enables checking the reference tag +T} +.TE +.sp 1 +.RE +.PP +\-\-ref\-tag=, \-r +.RS 4 +Optional reftag when used with protection information\&. +.RE +.PP +\-\-app\-tag\-mask=, \-m +.RS 4 +Optional application tag mask when used with protection information\&. +.RE +.PP +\-\-app\-tag=, \-a +.RS 4 +Optional application tag when used with protection information\&. +.RE +.SH "EXAMPLES" +.sp +No examples yet\&. +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-verify.html b/Documentation/nvme-verify.html new file mode 100644 index 00000000..53feb4ba --- /dev/null +++ b/Documentation/nvme-verify.html @@ -0,0 +1,936 @@ + + + + + + +nvme-verify(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme-verify <device> [--namespace-id=<nsid> | -n <nsid>]
+            [--start-block=<slba> | -s <slba>]
+            [--block-count=<nlb> | -c <nlb>]
+            [--limited-retry | -l]
+            [--force-unit-access | -f]
+            [--prinfo=<prinfo> | -p <prinfo>]
+            [--ref-tag=<reftag> | -r <reftag>]
+            [--app-tag-mask=<appmask> | -m <appmask>]
+            [--app-tag=<apptag> | -a <apptag>]
+
+
+
+
+
+

DESCRIPTION

+
+

The Verify command verifies the integrity of the stored information by +reading data and metadata.

+
+
+
+

OPTIONS

+
+
+
+--namespace-id=<nsid> +
+
+-n <nsid> +
+
+

+ Namespace ID use in the command. +

+
+
+--start-block=<slba> +
+
+-s <slba> +
+
+

+ Start block address. +

+
+
+--block-count=<nlb> +
+
+-c <nlb> +
+
+

+ Number of logical blocks to Verify. +

+
+
+--limited-retry +
+
+-l +
+
+

+ Sets the limited retry flag. +

+
+
+--force-unit-access +
+
+-f +
+
+

+ Set the force-unit access flag. +

+
+
+--prinfo=<prinfo> +
+
+-p <prinfo> +
+
+

+ Protection Information field definition. +

+
+ +++ + + + + + + + + + + + + + + + + + + + + + + + + + +

Bit

Description

3

PRACT: Protection Information Action. When set to 1, PI is stripped/inserted +on read/write when the block format’s metadata size is 8. When set to 0, +metadata is passes.

2:0

PRCHK: Protection Information Check:

2

Set to 1 enables checking the guard tag

1

Set to 1 enables checking the application tag

0

Set to 1 enables checking the reference tag

+
+
+
+--ref-tag=<reftag> +
+
+-r <reftag> +
+
+

+ Optional reftag when used with protection information. +

+
+
+--app-tag-mask=<appmask> +
+
+-m <appmask> +
+
+

+ Optional application tag mask when used with protection information. +

+
+
+--app-tag=<apptag> +
+
+-a <apptag> +
+
+

+ Optional application tag when used with protection information. +

+
+
+
+
+
+

EXAMPLES

+
+

No examples yet.

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-verify.txt b/Documentation/nvme-verify.txt new file mode 100644 index 00000000..80d69430 --- /dev/null +++ b/Documentation/nvme-verify.txt @@ -0,0 +1,82 @@ +nvme-verify(1) +============== + +NAME +---- +nvme-verify - Send an NVMe Verify command, return results + +SYNOPSIS +-------- +[verse] +'nvme-verify' [--namespace-id= | -n ] + [--start-block= | -s ] + [--block-count= | -c ] + [--limited-retry | -l] + [--force-unit-access | -f] + [--prinfo= | -p ] + [--ref-tag= | -r ] + [--app-tag-mask= | -m ] + [--app-tag= | -a ] + +DESCRIPTION +----------- +The Verify command verifies the integrity of the stored information by +reading data and metadata. + +OPTIONS +------- +--namespace-id=:: +-n :: + Namespace ID use in the command. + +--start-block=:: +-s :: + Start block address. + +--block-count=:: +-c :: + Number of logical blocks to Verify. + +--limited-retry:: +-l:: + Sets the limited retry flag. + +--force-unit-access:: +-f:: + Set the force-unit access flag. + +--prinfo=:: +-p :: + Protection Information field definition. ++ +[] +|================= +|Bit|Description +|3|PRACT: Protection Information Action. When set to 1, PI is stripped/inserted +on read/write when the block format's metadata size is 8. When set to 0, +metadata is passes. +|2:0|PRCHK: Protection Information Check: +|2|Set to 1 enables checking the guard tag +|1|Set to 1 enables checking the application tag +|0|Set to 1 enables checking the reference tag +|================= + +--ref-tag=:: +-r :: + Optional reftag when used with protection information. + +--app-tag-mask=:: +-m :: + Optional application tag mask when used with protection information. + +--app-tag=:: +-a :: + Optional application tag when used with protection information. + +EXAMPLES +-------- +No examples yet. + +NVME +---- +Part of the nvme-user suite