.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "DAXIO" "1" "2019-02-19" "PMDK - daxio version 1.4" "PMDK Programmer's Manual"
.hy
.\" Copyright 2014-2019, Intel Corporation
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\"     * Redistributions of source code must retain the above copyright
.\"       notice, this list of conditions and the following disclaimer.
.\"
.\"     * Redistributions in binary form must reproduce the above copyright
.\"       notice, this list of conditions and the following disclaimer in
.\"       the documentation and/or other materials provided with the
.\"       distribution.
.\"
.\"     * Neither the name of the copyright holder nor the names of its
.\"       contributors may be used to endorse or promote products derived
.\"       from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.SH NAME
.PP
\f[B]daxio\f[] \- Perform I/O on Device DAX devices or zero a Device DAX
device
.SH SYNOPSIS
.IP
.nf
\f[C]
$\ daxio\ [<options>]
\f[]
.fi
.SH DESCRIPTION
.PP
The daxio utility performs I/O on Device DAX devices or zero a Device
DAX device.
Since the standard I/O APIs (read/write) cannot be used with Device DAX,
data transfer is performed on a memory\-mapped device.
The \f[B]daxio\f[] may be used to dump Device DAX data to a file,
restore data from a backup copy, move/copy data to another device or to
erase data from a device.
.PP
There must be at least one Device DAX device involved either as the
input or output.
If input or output is not specified, it will default to stdin or stdout
respectively.
.PP
No length specified will default to input file/device length or to the
output file/device length, if input is a special char file or stdin.
.PP
For a Device DAX device, \f[B]daxio\f[] will attempt to clear bad blocks
within the range of writes before performing the I/O (it can be turned
off using the `\[en]clear\-bad\-blocks=no' option).
.SH OPTIONS
.PP
\f[C]\-i,\ \-\-input\f[] Input device or file to read from.
.PP
\f[C]\-o,\ \-\-output\f[] Output device or file to write to.
.PP
\f[C]\-z,\ \-\-zero\f[] Zero the output device for \f[I]len\f[] size, or
the entire device if no length was provided.
The output device must be a Device DAX device.
.PP
\f[C]\-b,\ \-\-clear\-bad\-blocks=<yes|no>\f[] Clear bad blocks within
the range of writes before performing the I/O (default: yes).
.PP
\f[C]\-l,\ \-\-len\f[] The length in bytes to perform the I/O.
To make passing in size easier for kibi, mebi, gibi, and tebi bytes,
\f[I]len\f[] may include unit suffix.
The \f[I]len\f[] format must be compliant with the format specified in
IEC 80000\-13, IEEE 1541 or the Metric Interchange Format.
These standards accept SI units with obligatory B \- kB, MB, GB, \&...
(multiplier by 1000) suffixes, and IEC units with optional \[lq]iB\[rq]
\- KiB, MiB, GiB, \&..., K, M, G, \&... (multiplier by 1024) suffixes.
.PP
\f[C]\-s,\ \-\-seek\f[] The number of bytes to skip over on the output
before performing a write.
The same suffixes are accepted as for \f[I]len\f[].
.PP
\f[C]\-k,\ \-\-skip\f[] The number of bytes to skip over on the input
before performing a read.
The same suffixes are accepted as for \f[I]len\f[].
.PP
\f[C]\-V,\ \-\-version\f[]
.PP
Prints the version of \f[B]daxio\f[].
.PP
\f[C]\-h,\ \-\-help\f[]
.PP
Prints synopsis and list of options.
.SH EXAMPLE
.IP
.nf
\f[C]
#\ daxio\ \-\-zero\ /dev/dax1.0

#\ daxio\ \-\-input=/dev/dax1.0\ \-\-output=/home/myfile\ \-\-len=2M\ \-\-seek=4096

#\ cat\ /dev/zero\ |\ daxio\ \-\-output=/dev/dax1.0

#\ daxio\ \-\-input=/dev/zero\ \-\-output=/dev/dax1.0\ \-\-skip=4096
\f[]
.fi
.SH SEE ALSO
.PP
\f[B]daxctl\f[](1), \f[B]ndctl\f[](1) and \f[B]<http://pmem.io>\f[]