From f1b7f77bc62d1cbacd7e6f69418154f192b7bf13 Mon Sep 17 00:00:00 2001 From: Keith Busch Date: Wed, 17 Jun 2020 09:58:38 -0700 Subject: [PATCH] add missing manpage to repo Signed-off-by: Keith Busch --- Documentation/nvme-zns-id-ctrl.1 | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/Documentation/nvme-zns-id-ctrl.1 b/Documentation/nvme-zns-id-ctrl.1 index fb91ffc..1715816 100644 --- a/Documentation/nvme-zns-id-ctrl.1 +++ b/Documentation/nvme-zns-id-ctrl.1 @@ -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 -.\" 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 [\-o | \-\-output\-format=] +\fInvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] + [\-o | \-\-output\-format=] + [\-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 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 , \-\-namespace\-id= +.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 , \-\-output\-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 -- 2.49.0