.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "PMEMPOOL-CHECK" "1" "2019-02-19" "PMDK - pmem Tools 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]pmempool\-check\f[] \- check and repair persistent memory pool
.SH SYNOPSIS
.IP
.nf
\f[C]
$\ pmempool\ check\ [<options>]\ <file>
\f[]
.fi
.SH DESCRIPTION
.PP
The \f[B]pmempool\f[] invoked with \f[I]check\f[] command checks
consistency of a given pool file.
If the pool file is consistent \f[B]pmempool\f[] exits with 0 value.
If the pool file is not consistent non\-zero error code is returned.
.PP
In case of any errors, the proper message is printed.
The verbosity level may be increased using \f[B]\-v\f[] option.
The output messages may be also suppressed using \f[B]\-q\f[] option.
.PP
It is possible to try to fix encountered problems using \f[B]\-r\f[]
option.
In order to be sure this will not corrupt your data you can either
create backup of the pool file using \f[B]\-b\f[] option or just print
what would be fixed without modifying original pool using \f[B]\-N\f[]
option.
.RS
.PP
NOTE: Currently, checking the consistency of a \f[I]pmemobj\f[] pool is
\f[B]not\f[] supported.
.RE
.SS Available options:
.PP
\f[C]\-r,\ \-\-repair\f[]
.PP
Try to repair a pool file if possible.
.PP
\f[C]\-y,\ \-\-yes\f[]
.PP
Answer yes on all questions.
.PP
\f[C]\-N,\ \-\-no\-exec\f[]
.PP
Don't execute, just show what would be done.
Not supported on Device DAX.
.PP
\f[C]\-b,\ \-\-backup\ <file>\f[]
.PP
Create backup of a pool file before executing.
Terminate if it is \f[I]not\f[] possible to create a backup file.
This option requires \f[B]\-r\f[] option.
.PP
\f[C]\-a,\ \-\-advanced\f[]
.PP
Perform advanced repairs.
This option enables more aggressive steps in attempts to repair a pool.
This option requires \f[C]\-r,\ \-\-repair\f[].
.PP
\f[C]\-q,\ \-\-quiet\f[]
.PP
Be quiet and don't print any messages.
.PP
\f[C]\-v,\ \-\-verbose\f[]
.PP
Be more verbose.
.PP
\f[C]\-h,\ \-\-help\f[]
.PP
Display help message and exit.
.SH EXAMPLE
.IP
.nf
\f[C]
$\ pmempool\ check\ pool.bin
\f[]
.fi
.PP
Check consistency of \[lq]pool.bin\[rq] pool file
.IP
.nf
\f[C]
$\ pmempool\ check\ \-\-repair\ \-\-backup\ pool.bin.backup\ pool.bin
\f[]
.fi
.PP
Check consistency of \[lq]pool.bin\[rq] pool file, create backup and
repair if necessary.
.IP
.nf
\f[C]
$\ pmempool\ check\ \-rvN\ pool.bin
\f[]
.fi
.PP
Check consistency of \[lq]pool.bin\[rq] pool file, print what would be
repaired with increased verbosity level.
.SH SEE ALSO
.PP
\f[B]pmempool\f[](1), \f[B]libpmemblk\f[](7), \f[B]libpmemlog\f[](7),
\f[B]libpmemobj\f[](7), \f[B]libpmempool\f[](7) and
\f[B]<http://pmem.io>\f[]