diff options
Diffstat (limited to 'Documentation/nvme-wdc-namespace-resize.1')
| -rw-r--r-- | Documentation/nvme-wdc-namespace-resize.1 | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-namespace-resize.1 b/Documentation/nvme-wdc-namespace-resize.1 new file mode 100644 index 0000000..ea0235a --- /dev/null +++ b/Documentation/nvme-wdc-namespace-resize.1 @@ -0,0 +1,115 @@ +'\" t +.\" Title: nvme-wdc-namespace-resize +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 04/24/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-NAMESPACE" "1" "04/24/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-wdc-namespace-resize \- Resizes the device\*(Aqs namespace\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc namespace\-resize\fR <device> [\-\-nsid=<NAMSPACE ID>, \-n <NAMSPACE ID>] [\-\-op_option=<OP OPTION>, \-o <OP OPTION>] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported by the device\&. +.sp +The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.SH "OPTIONS" +.PP +\-n <NAMSPACE ID>, \-\-namespace\-id=<NAMSPACE_ID> +.RS 4 +Namespace ID; ID of the namespace to resize +.RE +.PP +\-o <OP OPTION>, \-\-op\-option=<OP OPTION> +.RS 4 +Overprovisioning Option; defaults to 0xF +.sp +.if n \{\ +.RS 4 +.\} +.nf +Valid Values: +0x1 \- 7% of Original TNVMCAP reported value +0x2 \- 28% of Original TNVMCAP reported value +0x3 \- 50% of Original TNVMCAP reported value +0xF \- 0% of Original TNVMCAP reported value (original config) +All other values \- reserved +.fi +.if n \{\ +.RE +.\} +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Resizes namespace 1 to 50% of the orginal TNVMCAP reported value: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc namespace\-resize /dev/nvme0 \-n 1 \-o 3 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Resizes namespace 2 to 7% of the orginal TNVMCAP reported value: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc namespace\-resize /dev/nvme0 \-\-namespace\-id=2 \-\-op\-option=1 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. |