Persistent Memory Development Kit

This is src/tools/daxio/README.

This file contains the high-level description of daxio utility.

The main purpose of daxio is to perform 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 daxio may be used to dump Device DAX data to a file, restore data from
a backup copy, or move/copy data to another device.

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.

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.

For a Device DAX device, daxio will attempts to clear badblocks within range
of writes before performing the I/O.

3. Source code
--------------

The source code of daxio is located in daxio directory.

By default daxio is installed in $(DESTDIR)/usr/bin directory.
You can change it by passing $(TOOLSDIR) variable to "make install".
For example, the following command will install daxio in ~/bin directory:
	$ make install DESTDIR=~ TOOLSDIR=/bin

See the top-level README file for detailed information about building and
installation.

4. Packaging
------------

The daxio utility is provided in separate packages. Both rpm and dpkg
packages are built automatically with other packages.

See the top-level README file for detailed information about building packages.

5. Versioning
-------------

The versioning of daxio utility is the same as all PMDK libraries.