OS Manuals

/usr/bin/barman-wal-archive

Backup and Recovery Manager for PostgreSQL

From barman 3.20.1-r3 (enterprise-packages), captured 2026-11-08 by running barman-wal-archive --help (exit 0). permalink

Also provided by 1 other package version
usage: barman-wal-archive [-h] [-V] [-U USER] [--port PORT] [-c CONFIG] [-t] [--md5] [-z] [-j]
                          [--xz] [--snappy] [--zstd] [--lz4]
                          [--compression-level COMPRESSION_LEVEL] [-p PARALLEL]
                          [--prefetch-cache-dir PREFETCH_CACHE_DIR]
                          BARMAN_HOST SERVER_NAME WAL_PATH

This script will be used as an 'archive_command' based on the put-wal feature of Barman. A ssh
connection will be opened to the Barman host.

positional arguments:
  BARMAN_HOST           The host of the Barman server.
  SERVER_NAME           The server name configured in Barman from which WALs are taken.
  WAL_PATH              The value of the '%p' keyword (according to 'archive_command').

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -U USER, --user USER  The user used for the ssh connection to the Barman server. Defaults to
                        'barman'.
  --port PORT           The port used for the ssh connection to the Barman server.
  -c CONFIG, --config CONFIG
                        configuration file on the Barman server
  -t, --test            test both the connection and the configuration of the requested PostgreSQL
                        server in Barman for WAL retrieval. With this option, the 'wal_name'
                        mandatory argument is ignored.
  --md5                 Use MD5 as the hash algorithm to maintain compatibility between mismatched
                        client and server versions.
  -z, --gzip            gzip-compress the WAL file before sending it
  -j, --bzip2           bzip2-compress the WAL file before sending it
  --xz                  xz-compress the WAL file before sending it
  --snappy              snappy-compress the WAL file before sending it (requires optional python-
                        snappy library)
  --zstd                zstd-compress the WAL file before sending it (requires optional zstandard
                        library)
  --lz4                 lz4-compress the WAL file before sending it (requires optional lz4
                        library)
  --compression-level COMPRESSION_LEVEL
                        A compression level for the specified compression algorithm
  -p PARALLEL, --parallel PARALLEL
                        Specifies the maximum number of WALs to archive in parallel
  --prefetch-cache-dir PREFETCH_CACHE_DIR
                        Directory where to store cache metadata when using --parallel. Defaults to
                        '/tmp/barman-SERVER_NAME-COMPUTED_HASH'.
Options (14)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-V, --versionshow program's version number and exithelp
-U, --user USERThe user used for the ssh connection to the Barman server.help
--port PORTThe port used for the ssh connection to the Barman server.help
-t, --testtest both the connection and the configuration of the requested PostgreSQL server in Barman for WAL retrieval.help
--md5Use MD5 as the hash algorithm to maintain compatibility between mismatched client and server versions.help
-z, --gzipgzip-compress the WAL file before sending ithelp
-j, --bzip2bzip2-compress the WAL file before sending ithelp
--xzxz-compress the WAL file before sending ithelp
--snappysnappy-compress the WAL file before sending it (requires optional python- snappy library)help
--zstdzstd-compress the WAL file before sending it (requires optional zstandard library)help
--lz4lz4-compress the WAL file before sending it (requires optional lz4 library)help
--compression-level COMPRESSION_LEVELA compression level for the specified compression algorithmhelp
--prefetch-cache-dir PREFETCH_CACHE_DIRDirectory where to store cache metadata when using --parallel.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.