From 6721ff7027341a24679d6050a25ff07beff31408 Mon Sep 17 00:00:00 2001 From: Keith Busch Date: Thu, 18 Jun 2020 02:13:43 +0900 Subject: [PATCH] fix manpage name Signed-off-by: Keith Busch --- Documentation/nvme-zns-id-ns.1 | 110 +++++++++++++++++++++++++++++++ Documentation/nvme-zns-id-ns.txt | 10 +-- 2 files changed, 115 insertions(+), 5 deletions(-) create mode 100644 Documentation/nvme-zns-id-ns.1 diff --git a/Documentation/nvme-zns-id-ns.1 b/Documentation/nvme-zns-id-ns.1 new file mode 100644 index 0000000..11a199d --- /dev/null +++ b/Documentation/nvme-zns-id-ns.1 @@ -0,0 +1,110 @@ +'\" t +.\" Title: nvme-zns-id-ns +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 06/18/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-ID\-NS" "1" "06/18/2020" "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-zns-id-ns \- Send NVMe Zoned Command Set Identify Controller, return result and structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns id\-ns\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 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 +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program interpret the returned buffer and display the known fields in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns id\-ns /dev/nvme0 \-n 1 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Show the output in json format with extra details +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme zns id\-ns /dev/nvme0 \-o json \-v +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-zns-id-ns.txt b/Documentation/nvme-zns-id-ns.txt index 3c7d51b..a95d975 100644 --- a/Documentation/nvme-zns-id-ns.txt +++ b/Documentation/nvme-zns-id-ns.txt @@ -1,15 +1,15 @@ -nvme-zns-id-ctrl(1) -=================== +nvme-zns-id-ns(1) +================= NAME ---- -nvme-zns-id-ctrl - Send NVMe Zoned Command Set Identify Controller, return +nvme-zns-id-ns - Send NVMe Zoned Command Set Identify Controller, return result and structure SYNOPSIS -------- [verse] -'nvme zns id-ctrl' [--namespace-id= | -n ] +'nvme zns id-ns' [--namespace-id= | -n ] [-o | --output-format=] [-v | --verbose] @@ -54,7 +54,7 @@ fields in a human readable format: * Show the output in json format with extra details + ------------ -# nvme zns id-ctrl /dev/nvme0 -o json -v +# nvme zns id-ns /dev/nvme0 -o json -v ------------ NVME -- 2.49.0