'\" t
.\" Title: nvme-write
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1
.\" Date: 11/15/2016
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-WRITE" "1" "11/15/2016" "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-write \- Send an NVMe write command, provide results
.SH "SYNOPSIS"
.sp
.nf
\fInvme\-write\fR [\-\-start\-block= | \-s ]
[\-\-block\-count= | \-c ]
[\-\-data\-size= | \-z ]
[\-\-metadata\-size= | \-y ]
[\-\-data= | \-d ]
[\-\-metadata= | \-M ]
[\-\-prinfo= | \-p ]
[\-\-ref\-tag= | \-r ]
[\-\-app\-tag\-mask= | \-m ]
[\-\-app\-tag= | \-a ]
[\-\-limited\-retry | \-l]
[\-\-latency | \-t]
[\-\-force\-unit\-access | \-f]
.fi
.SH "DESCRIPTION"
.sp
The Write command writes the logical blocks specified by the command to the medium from the data data buffer provided\&. Will use stdin by default if you don\(cqt provide a file\&.
.SH "OPTIONS"
.PP
\-\-start\-block=, \-s
.RS 4
Start block\&.
.RE
.PP
\-\-block\-count, \-c
.RS 4
The number of blocks to transfer\&. This is a zeroes based value to align with the kernel\(cqs use of this field\&. (ie\&. 0 means transfer 1 block)\&.
.RE
.PP
\-\-block\-count=, \-c
.RS 4
Number of logical blocks to write\&.
.RE
.PP
\-\-data\-size=, \-z
.RS 4
Size of data, in bytes\&.
.RE
.PP
\-\-metadata\-size=, \-y
.RS 4
Size of metadata in bytes\&.
.RE
.PP
\-\-data=, \-d
.RS 4
Data file\&. If none provided, contents are sent from STDIN\&.
.RE
.PP
\-\-metadata=, \-M
.RS 4
Metadata file, if necessary\&.
.RE
.PP
\-\-prinfo=, \-p
.RS 4
Protection Information field defintion\&.
.TS
allbox tab(:);
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt.
T{
Bit
T}:T{
Description
T}
T{
3
T}:T{
PRACT: Protection Information Action\&. When set to 1, PI is stripped/inserted on read/write when the block format\(cqs metadata size is 8\&. When set to 0, metadata is passes\&.
T}
T{
2:0
T}:T{
PRCHK: Protection Information Check:
T}
T{
2
T}:T{
Set to 1 enables checking the guard tag
T}
T{
1
T}:T{
Set to 1 enables checking the application tag
T}
T{
0
T}:T{
Set to 1 enables checking the reference tag
T}
.TE
.sp 1
.RE
.PP
\-\-ref\-tag=, \-r
.RS 4
Optional reftag when used with protection information\&.
.RE
.PP
\-\-app\-tag\-mask=, \-m
.RS 4
Optional application tag mask when used with protection information\&.
.RE
.PP
\-\-app\-tag=, \-a
.RS 4
Optional application tag when used with protection information\&.
.RE
.PP
\-\-limited\-retry, \-l
.RS 4
Sets the limited retry flag\&.
.RE
.PP
\-\-force\-unit\-access, \-f
.RS 4
Set the force\-unit access flag\&.
.RE
.PP
\-\-latency, \-t
.RS 4
Print out the latency the IOCTL took (in us)\&.
.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
.SH "NVME"
.sp
Part of the nvme\-user suite