]> www.infradead.org Git - users/hch/nvme-cli.git/commitdiff
add missing manpage to repo
authorKeith Busch <kbusch@kernel.org>
Wed, 17 Jun 2020 16:58:38 +0000 (09:58 -0700)
committerKeith Busch <kbusch@kernel.org>
Wed, 17 Jun 2020 16:58:38 +0000 (09:58 -0700)
Signed-off-by: Keith Busch <kbusch@kernel.org>
Documentation/nvme-zns-id-ctrl.1

index fb91ffc27aedda549b442725bf1640c7e91163a0..1715816425a056df7706f199c8458d1492ad0a8a 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-zns-id-ctrl
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 06/16/2020
+.\"      Date: 06/17/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ZNS\-ID\-CTRL" "1" "06/16/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-ID\-CTRL" "1" "06/17/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,17 +32,29 @@ nvme-zns-id-ctrl \- Send NVMe Zoned Command Set Identify Controller, return resu
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme zns id\-ctrl\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme zns id\-ctrl\fR <device>  [\-\-namespace\-id=<NUM> | \-n <NUM>]
+                             [\-o <fmt> | \-\-output\-format=<fmt>]
+                             [\-v | \-\-verbose]
 .fi
 .SH "DESCRIPTION"
 .sp
-For the NVMe device given, sends the zoned command set\(cqs identify controller command and provides the result and returned structure\&.
+For the NVMe device given, sends the zoned command set\(cqs identify namepsace command and provides the result and returned structure\&.
 .sp
 The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
 .sp
 On success, the data structure returned by the device will be decoded and displayed in one of several ways\&.
 .SH "OPTIONS"
 .PP
+\-n <NUM>, \-\-namespace\-id=<NUM>
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
+.PP
 \-o <format>, \-\-output\-format=<format>
 .RS 4
 Set the reporting format to
@@ -66,7 +78,7 @@ Has the program interpret the returned buffer and display the known fields in a
 .RS 4
 .\}
 .nf
-# nvme zns id\-ctrl /dev/nvme0
+# nvme zns id\-ns /dev/nvme0 \-n 1
 .fi
 .if n \{\
 .RE
@@ -81,13 +93,13 @@ Has the program interpret the returned buffer and display the known fields in a
 .sp -1
 .IP \(bu 2.3
 .\}
-Show the output in json format
+Show the output in json format with extra details
 .sp
 .if n \{\
 .RS 4
 .\}
 .nf
-# nvme zns id\-ctrl /dev/nvme0 \-o json
+# nvme zns id\-ctrl /dev/nvme0 \-o json \-v
 .fi
 .if n \{\
 .RE