.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "PMEMPOOL-RM" "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\-rm\f[] \- remove a persistent memory pool
.SH SYNOPSIS
.IP
.nf
\f[C]
$\ pmempool\ rm\ [<options>]\ <file>..
\f[]
.fi
.SH DESCRIPTION
.PP
The \f[B]pmempool rm\f[] command removes each specified file.
If the specified file is a pool set file, all pool files (single\-file
pool or part files) and remote replicas are removed.
By default the \f[B]pmempool rm\f[] does not remove pool set files.
All local and remote pool files are removed using \f[B]unlink\f[](3)
call, except the pools created on \f[B]device dax\f[] which are zeroed
instead.
If specified file does not exist, the remote pool is broken or not
accessible, the \f[B]pmempool rm\f[] command terminates with an error
code.
By default it prompts before removing \f[I]write\-protected\f[] local
files.
See \f[B]REMOTE REPLICATION\f[] section for more details about support
for remote pools.
See \f[B]EXAMPLES\f[] section for example usage of the \f[I]rm\f[]
command.
.SS Available options:
.PP
\f[C]\-h,\ \-\-help\f[]
.PP
Print help message
.PP
\f[C]\-v,\ \-\-verbose\f[]
.PP
Be verbose and print all removing files.
.PP
\f[C]\-s,\ \-\-only\-pools\f[]
.PP
Remove only pool files and do not remove pool set files (default
behaviour).
.PP
\f[C]\-a,\ \-\-all\f[]
.PP
Remove all pool set files \- local and remote.
.PP
\f[C]\-l,\ \-\-local\f[]
.PP
Remove local pool set files.
.PP
\f[C]\-r,\ \-\-remote\f[]
.PP
Remove remote pool set files.
.PP
\f[C]\-f,\ \-\-force\f[]
.PP
Remove all specified files, ignore nonexistent files, never prompt.
.PP
\f[C]\-i,\ \-\-interactive\f[]
.PP
Prompt before removing every single file or remote pool.
.SH REMOTE REPLICATION
.PP
A remote pool is removed using \f[B]rpmem_remove\f[](3) function if
\f[B]librpmem\f[](7) library is available.
If a pool set file contains remote replication but \f[B]librpmem\f[](7)
is not available, the \f[B]pmempool rm\f[] command terminates with an
error code, unless the \f[B]\-f, \[en]force\f[] option is specified.
.SH EXAMPLE
.IP
.nf
\f[C]
$\ pmempool\ rm\ pool.obj\ pool.blk
\f[]
.fi
.PP
Remove specified pool files.
.IP
.nf
\f[C]
$\ pmempool\ rm\ pool.set
\f[]
.fi
.PP
Remove all pool files from the \[lq]pool.set\[rq], do not remove
\f[I]pool.set\f[] itself.
.IP
.nf
\f[C]
$\ pmempool\ rm\ \-a\ pool.set
\f[]
.fi
.PP
Remove all pool files from the \[lq]pool.set\[rq], remove the local pool
set file and all remote pool set files.
.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]librpmem\f[](7) and
\f[B]<http://pmem.io>\f[]