.\" Automatically generated by Pandoc 2.1.3
.\"
.TH "PMEMPOOL" "1" "2018-10-06" "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\f[] \- Persistent Memory Pool Management Tool
.SH SYNOPSIS
.IP
.nf
\f[C]
$\ pmempool\ [\-\-help]\ [\-\-version]\ <command>\ [<args>]
\f[]
.fi
.SH DESCRIPTION
.PP
The \f[B]pmempool\f[] is a management tool for \f[I]Persistent
Memory\f[] pool files created by \f[B]PMDK\f[] libraries.
.PP
The main purpose of \f[B]pmempool\f[] is to provide a user with a set of
utilities for off\-line analysis and manipulation of pools created by
pmem libraries.
The pmempool is a generic command which consists of subcommands for
specific purposes.
Some of subcommands are required to work \f[I]without\f[] any impact on
processed pool, but some of them \f[I]may\f[] create a new or modify an
existing one.
.PP
The \f[B]pmempool\f[] may be useful for troubleshooting by system
administrators and for software developers who work on applications
based on \f[B]PMDK\f[].
The latter may find these tools useful for testing and debugging
purposes also.
.SH OPTIONS
.PP
\f[C]\-V,\ \-\-version\f[]
.PP
Prints the version of \f[B]pmempool\f[].
.PP
\f[C]\-h,\ \-\-help\f[]
.PP
Prints synopsis and list of commands.
.SH COMMANDS
.PP
Currently there is a following set of commands available:
.IP \[bu] 2
\f[B]pmempool\-info\f[](1) \- Prints information and statistics in
human\-readable format about specified pool.
.IP \[bu] 2
\f[B]pmempool\-check\f[](1) \- Checks pool's consistency and repairs
pool if it is not consistent.
.IP \[bu] 2
\f[B]pmempool\-create\f[](1) \- Creates a pool of specified type with
additional properties specific for this type of pool.
.IP \[bu] 2
\f[B]pmempool\-dump\f[](1) \- Dumps usable data from pool in hexadecimal
or binary format.
.IP \[bu] 2
\f[B]pmempool\-rm\f[](1) Removes pool file or all pool files listed in
pool set configuration file.
.IP \[bu] 2
\f[B]pmempool\-convert\f[](1) \- Updates the pool to the latest
available layout version.
.IP \[bu] 2
\f[B]pmempool\-sync\f[](1) \- Synchronizes replicas within a poolset.
.IP \[bu] 2
\f[B]pmempool\-transform\f[](1) \- Modifies internal structure of a
poolset.
.IP \[bu] 2
\f[B]pmempool\-feature\f[](1) \- Toggle or query a poolset features.
.PP
In order to get more information about specific \f[I]command\f[] you can
use \f[B]pmempool help .\f[]
.SH SEE ALSO
.PP
\f[B]libpmemblk\f[](7), \f[B]libpmemlog\f[](7), \f[B]libpmemobj\f[](7)
and \f[B]<http://pmem.io>\f[]