summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-io-mgmt-recv.1
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-io-mgmt-recv.1')
-rw-r--r--Documentation/nvme-io-mgmt-recv.172
1 files changed, 72 insertions, 0 deletions
diff --git a/Documentation/nvme-io-mgmt-recv.1 b/Documentation/nvme-io-mgmt-recv.1
new file mode 100644
index 0000000..076220a
--- /dev/null
+++ b/Documentation/nvme-io-mgmt-recv.1
@@ -0,0 +1,72 @@
+'\" t
+.\" Title: nvme-io-mgmt-recv
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 01/30/2023
+.\" Manual: NVMe Manual
+.\" Source: NVMe
+.\" Language: English
+.\"
+.TH "NVME\-IO\-MGMT\-RECV" "1" "01/30/2023" "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-io-mgmt-recv \- I/O Management Receive command
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme io\-mgmt\-recv\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
+ [\-\-mos=<NUM> | \-s <NUM>]
+ [\-\-mo=<NUM> | \-m <NUM>]
+ [\-\-data=<FILE> | \-d <FILE>]
+ [\-\-data\-len=<NUM> | \-l <NUM>]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the I/O Management Receive command with the requested management operation (mo) and management operation specific parameter (mos)\&. This is the generic interface provided for forward compatibility as new operations are added that this program isn\(cqt aware of at the time of its development\&. As such, this is a generic command that does not do any additional decoding for specific types of data received\&. This will only report the data as a hex dump, or binary\&.
+.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
+\-d <FILE>, \-\-data=<FILE>
+.RS 4
+File to write received data into\&. If unspecified, received data will be hex dumped to the standard output stream\&.
+.RE
+.PP
+\-l <NUM>, \-\-data\-len=<NUM>
+.RS 4
+Received data buffer length
+.RE
+.PP
+\-m <NUM>, \-\-mo <NUM>
+.RS 4
+Management Operation to perform\&.
+.RE
+.PP
+\-s <NUM>, \-\-mos=<NUM>
+.RS 4
+Management Operation Specific parameter\&.
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli