.\" Automatically generated by Pandoc 2.1.3

.\"

.TH "PMEMPOOL-DUMP" "1" "2018-07-18" "PMDK - pmem Tools version 1.4" "PMDK Programmer's Manual"

.hy

.\" Copyright 2014-2018, 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]pmempool\-dump\f[] \- dump user data from persistent memory pool

.SH SYNOPSIS

.IP

.nf

\f[C]

$\ pmempool\ dump\ [<options>]\ <file>

\f[]

.fi

.SH DESCRIPTION

.PP

The \f[B]pmempool\f[] invoked with \f[I]dump\f[] command dumps user data

from specified pool file.

The output format may be either binary or hexadecimal.

.PP

By default the output format is hexadecimal.

.PP

By default data is dumped to standard output.

It is possible to dump data to other file by specifying \f[B]\-o\f[]

option.

In this case data will be appended to this file.

.PP

Using \f[B]\-r\f[] option you can specify number of blocks/bytes/data

chunks using special text format.

See \f[B]RANGE\f[] section for details.

.SS Available options:

.PP

\f[C]\-b,\ \-\-binary\f[]

.PP

Dump data in binary format.

.PP

\f[C]\-r,\ \-\-range\ <range>\f[]

.PP

Range of pool file to dump.

This may be number of blocks for \f[B]blk\f[] pool type or either number

of bytes or number of data chunks for \f[B]log\f[] pool type.

.PP

\f[C]\-c,\ \-\-chunk\ <size>\f[]

.PP

Size of chunk for \f[B]log\f[] pool type.

See \f[B]pmemlog_walk\f[](3) in \f[B]libpmemlog\f[](7) for details.

.PP

\f[C]\-o,\ \-\-output\ <file>\f[]

.PP

Name of output file.

.PP

\f[C]\-h,\ \-\-help\f[]

.PP

Display help message and exit.

.SH RANGE

.PP

Using \f[B]\-r\f[], \f[B]\[en]range\f[] option it is possible to dump

only a range of user data.

This section describes valid format of \f[I]<range>\f[] string.

.PP

You can specify multiple ranges separated by commas.

.PP

\f[C]<first>\-<last>\f[]

.PP

All blocks/bytes/data chunks from \f[I]<first>\f[] to \f[I]<last>\f[]

will be dumped.

.PP

\f[C]\-<last>\f[]

.PP

All blocks/bytes/data chunks up to \f[I]<last>\f[] will be dumped.

.PP

\f[C]<first>\-\f[]

.PP

All blocks/bytes/data chunks starting from \f[I]<first>\f[] will be

dumped.

.PP

\f[C]<number>\f[]

.PP

Only \f[I]<number>\f[] block/byte/data chunk will be dumped.

.SH EXAMPLE

.IP

.nf

\f[C]

$\ pmempool\ dump\ pool.bin

\f[]

.fi

.PP

Dump user data from pool.bin file to standard output

.IP

.nf

\f[C]

$\ pmempool\ dump\ \-o\ output.bin\ \-r1,10\-100\ pool_blk.bin

\f[]

.fi

.PP

Dump block number 1 and blocks from 10 to 100 from pool_blk.bin

containing pmem blk pool to output.bin file

.IP

.nf

\f[C]

$\ pmempool\ dump\ \-r\ 1K\-2K\ pool.bin

\f[]

.fi

.PP

Dump data form 1K to 2K from pool.bin file.

.SH SEE ALSO

.PP

\f[B]pmempool\f[](1), \f[B]libpmemblk\f[](7), \f[B]libpmemlog\f[](7),

\f[B]libpmemobj\f[](7) and \f[B]<http://pmem.io>\f[]