.\" Automatically generated by Pandoc 2.10.1
.\"
.TH "BARMAN-WAL-ARCHIVE" "1" "November 5, 2020" "Barman User manuals" "Version 2.12"
.hy
.SH NAME
.PP
barman-wal-archive - \f[C]archive_command\f[R] based on Barman\[aq]s
put-wal
.SH SYNOPSIS
.PP
barman-wal-archive [\f[I]OPTIONS\f[R]] \f[I]BARMAN_HOST\f[R]
\f[I]SERVER_NAME\f[R] \f[I]WAL_PATH\f[R]
.SH DESCRIPTION
.PP
This script can be used in the \f[C]archive_command\f[R] of a PostgreSQL
server to ship WAL files to a Barman host using the \[aq]put-wal\[aq]
command (introduced in Barman 2.6).
An SSH connection will be opened to the Barman host.
\f[C]barman-wal-archive\f[R] allows the integration of Barman in
PostgreSQL clusters for better business continuity results.
.PP
This script and Barman are administration tools for disaster recovery of
PostgreSQL servers written in Python and maintained by 2ndQuadrant.
.SH POSITIONAL ARGUMENTS
.TP
BARMAN_HOST
the host of the Barman server.
.TP
SERVER_NAME
the server name configured in Barman from which WALs are taken.
.TP
WAL_PATH
the value of the \[aq]%p\[aq] keyword (according to
\[aq]archive_command\[aq]).
.SH OPTIONS
.TP
-h, --help
show a help message and exit
.TP
-V, --version
show program\[aq]s version number and exit
.TP
-U \f[I]USER\f[R], --user \f[I]USER\f[R]
the user used for the ssh connection to the Barman server.
Defaults to \[aq]barman\[aq].
.TP
-c \f[I]CONFIG\f[R], --config \f[I]CONFIG\f[R]
configuration file on the Barman server
.TP
-t, --test
test both the connection and the configuration of the requested
PostgreSQL server in Barman for WAL retrieval.
With this option, the \[aq]WAL_PATH\[aq] mandatory argument is ignored.
.SH EXIT STATUS
.TP
0
Success
.TP
Not zero
Failure
.SH SEE ALSO
.PP
\f[C]barman\f[R] (1), \f[C]barman\f[R] (5).
.SH BUGS
.PP
Barman has been extensively tested, and is currently being used in
several production environments.
However, we cannot exclude the presence of bugs.
.PP
Any bug can be reported via the Github issue tracker.
.SH RESOURCES
.IP \[bu] 2
Homepage: <http://www.pgbarman.org/>
.IP \[bu] 2
Documentation: <http://docs.pgbarman.org/>
.IP \[bu] 2
Professional support: <http://www.2ndQuadrant.com/>
.SH COPYING
.PP
Barman is the property of 2ndQuadrant Limited and its code is
distributed under GNU General Public License v3.
.PP
Copyright (C) 2011-2020 2ndQuadrant Ltd - <http://www.2ndQuadrant.com/>.
.SH AUTHORS
2ndQuadrant <http://www.2ndQuadrant.com>.