diff options
Diffstat (limited to '')
-rw-r--r-- | Documentation/nvme-zns-set-zone-desc.1 | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/Documentation/nvme-zns-set-zone-desc.1 b/Documentation/nvme-zns-set-zone-desc.1 new file mode 100644 index 0000000..a33b06a --- /dev/null +++ b/Documentation/nvme-zns-set-zone-desc.1 @@ -0,0 +1,82 @@ +'\" t +.\" Title: nvme-zns-set-zone-desc +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/20/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ZNS\-SET\-ZONE" "1" "10/20/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-set-zone-desc \- Set extended descriptor data for a zone +.SH "SYNOPSIS" +.sp +.nf +\fInvme zns setzone\-desc\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] + [\-\-start\-lba=<IONUM>, \-s <IONUM>] + [\-data=<FILE>, \-d <FILE>] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, issues the Zone Management Send command with the Set Zone Descriptor Extenions action\&. The input will default to stdin\&. Alternatively, the data may come from a file that can be specified\&. The data length will automatically be calculated from the zns identify namesapce\&. +.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 +\-s <lba>, \-\-start\-lba=<lba> +.RS 4 +The starting LBA of the zone to manage send\&. +.RE +.PP +\-d <FILE, \-data=<FILE> +.RS 4 +Optional file for data (default stdin) +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Write "hello world" into the zone descriptor for namespace 1\(cqs first zone (requires device supports a large enough zone extended data) +.sp +.if n \{\ +.RS 4 +.\} +.nf +# echo "hello world" | nvme zns set\-zone\-desc /dev/nvme0 \-n 1 \-s 0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli |