.\" Automatically generated by Pandoc 2.10.1
.\"
.TH "PMEMPOOL-CHECK" "1" "2020-10-28" "PMDK - pmem Tools version 1.4" "PMDK Programmer's Manual"
.hy
.\" SPDX-License-Identifier: BSD-3-Clause
.\" Copyright 2016-2018, Intel Corporation
.SH NAME
.PP
\f[B]pmempool-check\f[R] - check and repair persistent memory pool
.SH SYNOPSIS
.IP
.nf
\f[C]
$ pmempool check [<options>] <file>
\f[R]
.fi
.SH DESCRIPTION
.PP
The \f[B]pmempool\f[R] invoked with \f[I]check\f[R] command checks
consistency of a given pool file.
If the pool file is consistent \f[B]pmempool\f[R] 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[R] option.
The output messages may be also suppressed using \f[B]-q\f[R] option.
.PP
It is possible to try to fix encountered problems using \f[B]-r\f[R]
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[R] option or just print
what would be fixed without modifying original pool using \f[B]-N\f[R]
option.
.RS
.PP
NOTE: Currently, checking the consistency of a \f[I]pmemobj\f[R] pool is
\f[B]not\f[R] supported.
.RE
.SS Available options:
.PP
\f[C]-r, --repair\f[R]
.PP
Try to repair a pool file if possible.
.PP
\f[C]-y, --yes\f[R]
.PP
Answer yes on all questions.
.PP
\f[C]-d, --dry-run\f[R]
.PP
Don\[cq]t execute, just show what would be done.
Not supported on Device DAX.
.PP
\f[C]-N, --no-exec\f[R]
.PP
Deprecated alias for \f[C]dry-run\f[R].
.PP
\f[C]-b, --backup <file>\f[R]
.PP
Create backup of a pool file before executing.
Terminate if it is \f[I]not\f[R] possible to create a backup file.
This option requires \f[B]-r\f[R] option.
.PP
\f[C]-a, --advanced\f[R]
.PP
Perform advanced repairs.
This option enables more aggressive steps in attempts to repair a pool.
This option requires \f[C]-r, --repair\f[R].
.PP
\f[C]-q, --quiet\f[R]
.PP
Be quiet and don\[cq]t print any messages.
.PP
\f[C]-v, --verbose\f[R]
.PP
Be more verbose.
.PP
\f[C]-h, --help\f[R]
.PP
Display help message and exit.
.SH EXAMPLE
.IP
.nf
\f[C]
$ pmempool check pool.bin
\f[R]
.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[R]
.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[R]
.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[R](1), \f[B]libpmemblk\f[R](7), \f[B]libpmemlog\f[R](7),
\f[B]libpmemobj\f[R](7), \f[B]libpmempool\f[R](7) and
\f[B]<https://pmem.io>\f[R]