diff options
Diffstat (limited to 'Documentation/nvme-create-ns.1')
| -rw-r--r-- | Documentation/nvme-create-ns.1 | 54 |
1 files changed, 40 insertions, 14 deletions
diff --git a/Documentation/nvme-create-ns.1 b/Documentation/nvme-create-ns.1 index 96cb562..4e191fc 100644 --- a/Documentation/nvme-create-ns.1 +++ b/Documentation/nvme-create-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-create-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 11/02/2022 +.\" Date: 01/30/2023 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CREATE\-NS" "1" "11/02/2022" "NVMe" "NVMe Manual" +.TH "NVME\-CREATE\-NS" "1" "01/30/2023" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -43,19 +43,15 @@ nvme-create-ns \- Send NVMe Namespace management command to create namespace, re [\-\-lbstm=<lbstm> | \-l <lbstm>] [\-\-block\-size=<block\-size> | \-b <block\-size>] [\-\-timeout=<timeout> | \-t <timeout>] -DESCRIPTION + [\-\-nsze\-si=<nsze\-si> | \-S <nsze\-si>] + [\-\-ncap\-si=<ncap\-si> | \-C <ncap\-si>] .fi +.SH "DESCRIPTION" .sp -.nf -For the NVMe device given, sends a namespace management command to create -the namespace with the requested settings\&. On success, the namespace -identifier assigned by the controller is returned\&. - -The <device> parameter is mandatory and may be either the NVMe character -device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. - -OPTIONS -.fi +For the NVMe device given, sends a namespace management command to create the namespace with the requested settings\&. On success, the namespace identifier assigned by the controller is returned\&. +.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)\&. +.SH "OPTIONS" .PP \-s, \-\-nsze .RS 4 @@ -106,9 +102,39 @@ Logical Block Storage Tag Mask for end\-to\-end protection\&. .RS 4 Target block size the new namespace should be formatted as\&. Potential FLBAS values will be values will be scanned and the lowest numbered will be selected for the create\-ns operation\&. Conflicts with \-\-flbas argument\&. .RE +.PP +\-S, \-\-nsze\-si +.RS 4 +The namespace size (NSZE) in standard SI units\&. The value SI suffixed is divided by the namespace LBA size to set as NSZE\&. If the value not suffixed it is set as same with the nsze option\&. +.RE +.PP +\-C, \-\-ncap\-si +.RS 4 +The namespace capacity (NCAP) in standard SI units\&. The value SI suffixed is divided by the namespace LBA size to set as NCAP\&. If the value not suffixed it is set as same with the ncap option\&. +.RE .SH "EXAMPLES" .sp -No examples provided yet\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Create a namespace: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme create\-ns /dev/nvme0 \-\-nsze 11995709440 \-\-ncap 1199570940 \-\-flbas 0 \-\-dps 0 \-\-nmic 0 +# nvme create\-ns /dev/nvme0 \-\-nsze\-si 6\&.14T \-\-ncap 1199570940 \-\-flbas 0 \-\-dps 0 \-\-nmic 0 +.fi +.if n \{\ +.RE +.\} +.RE .SH "NVME" .sp Part of the nvme\-user suite |