From 820b7a452a8b1b9765e74459190cb733c840a851 Mon Sep 17 00:00:00 2001 From: Andre Date: Thu, 21 Nov 2024 13:39:48 -0300 Subject: [PATCH] Version set to 3.12.0 Signed-off-by: Andre --- barman/version.py | 2 +- docs/_build/man/barman-archive-wal.1 | 8 +- docs/_build/man/barman-backup.1 | 15 +- docs/_build/man/barman-check-backup.1 | 15 +- docs/_build/man/barman-check.1 | 15 +- docs/_build/man/barman-cloud-backup-delete.1 | 10 +- docs/_build/man/barman-cloud-backup-keep.1 | 10 +- docs/_build/man/barman-cloud-backup-list.1 | 10 +- docs/_build/man/barman-cloud-backup-show.1 | 10 +- docs/_build/man/barman-cloud-backup.1 | 8 +- .../man/barman-cloud-check-wal-archive.1 | 10 +- docs/_build/man/barman-cloud-restore.1 | 10 +- docs/_build/man/barman-cloud-wal-archive.1 | 12 +- docs/_build/man/barman-cloud-wal-restore.1 | 12 +- docs/_build/man/barman-config-switch.1 | 8 +- docs/_build/man/barman-config-update.1 | 8 +- docs/_build/man/barman-cron.1 | 8 +- docs/_build/man/barman-delete.1 | 15 +- docs/_build/man/barman-diagnose.1 | 10 +- docs/_build/man/barman-generate-manifest.1 | 15 +- docs/_build/man/barman-get-wal.1 | 31 +- docs/_build/man/barman-keep.1 | 15 +- docs/_build/man/barman-list-files.1 | 15 +- docs/_build/man/barman-list-servers.1 | 8 +- docs/_build/man/barman-list_backups.1 | 15 +- .../man/barman-lock-directory-cleanup.1 | 8 +- docs/_build/man/barman-put-wal.1 | 8 +- docs/_build/man/barman-rebuild-xlogdb.1 | 15 +- docs/_build/man/barman-receive-wal.1 | 10 +- docs/_build/man/barman-replication-status.1 | 15 +- docs/_build/man/barman-restore.1 | 35 +- docs/_build/man/barman-show-backup.1 | 15 +- docs/_build/man/barman-show-servers.1 | 15 +- docs/_build/man/barman-status.1 | 15 +- docs/_build/man/barman-switch-wal.1 | 10 +- docs/_build/man/barman-switch-xlog.1 | 2 +- docs/_build/man/barman-sync-backup.1 | 15 +- docs/_build/man/barman-sync-info.1 | 10 +- docs/_build/man/barman-sync-wals.1 | 8 +- docs/_build/man/barman-verify-backup.1 | 15 +- docs/_build/man/barman-verify.1 | 2 +- docs/_build/man/barman-wal-archive.1 | 14 +- docs/_build/man/barman-wal-restore.1 | 27 +- docs/_build/man/barman.1 | 333 +++++++----------- docs/_build/man/barman.5 | 115 +++--- 45 files changed, 423 insertions(+), 559 deletions(-) diff --git a/barman/version.py b/barman/version.py index a0430c656..9ae4d82f5 100644 --- a/barman/version.py +++ b/barman/version.py @@ -20,4 +20,4 @@ This module contains the current Barman version. """ -__version__ = "3.11.1" +__version__ = "3.12.0" diff --git a/docs/_build/man/barman-archive-wal.1 b/docs/_build/man/barman-archive-wal.1 index c5e364092..e71d32863 100644 --- a/docs/_build/man/barman-archive-wal.1 +++ b/docs/_build/man/barman-archive-wal.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-ARCHIVE-WAL" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-ARCHIVE-WAL" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-archive-wal \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX archive\-wal SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-backup.1 b/docs/_build/man/barman-backup.1 index c4335bb1e..2bfd084f2 100644 --- a/docs/_build/man/barman-backup.1 +++ b/docs/_build/man/barman-backup.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,15 +28,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-BACKUP" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-BACKUP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-backup \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX backup [ \-\-bwlimit KBPS ] [ \-\-incremental BACKUP_ID ] @@ -55,8 +55,7 @@ backup [ { \-\-wait | \-w } ] [ \-\-wait\-timeout SECONDS ] SERVER_NAME [ ... ] -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -176,9 +175,8 @@ before timing out. .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -190,7 +188,6 @@ T{ T} T{ All available servers T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-check-backup.1 b/docs/_build/man/barman-check-backup.1 index 9d8156cf3..7eb82aff6 100644 --- a/docs/_build/man/barman-check-backup.1 +++ b/docs/_build/man/barman-check-backup.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CHECK-BACKUP" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CHECK-BACKUP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-check-backup \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX check\-backup SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -59,9 +58,8 @@ Id of the backup in barman catalog. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -92,7 +90,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-check.1 b/docs/_build/man/barman-check.1 index ea0b39c32..c34ce0544 100644 --- a/docs/_build/man/barman-check.1 +++ b/docs/_build/man/barman-check.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CHECK" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CHECK" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-check \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX check [ \-\-nagios ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -60,9 +59,8 @@ Nagios plugin compatible output. .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -74,7 +72,6 @@ T{ T} T{ All available servers T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-cloud-backup-delete.1 b/docs/_build/man/barman-cloud-backup-delete.1 index 021c44c04..188e4e5d3 100644 --- a/docs/_build/man/barman-cloud-backup-delete.1 +++ b/docs/_build/man/barman-cloud-backup-delete.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-BACKUP-DELETE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-BACKUP-DELETE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-backup-delete \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-backup-delete \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-backup\-delete [ { \-V | \-\-version } ] [ \-\-help ] @@ -54,8 +53,7 @@ barman\-cloud\-backup\-delete [ \-\-azure\-credential { azure\-cli | managed\-identity } ] [\-\-batch\-size DELETE_BATCH_SIZE] SOURCE_URL SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -104,7 +102,7 @@ Name of the server that holds the backup to be deleted. .TP .B \fBSOURCE_URL\fP URL of the cloud source, such as a bucket in AWS S3. For example: -\fIs3://bucket/path/to/folder\fP\&. +\fBs3://bucket/path/to/folder\fP\&. .TP .B \fB\-V\fP / \fB\-\-version\fP Show version and exit. diff --git a/docs/_build/man/barman-cloud-backup-keep.1 b/docs/_build/man/barman-cloud-backup-keep.1 index d4af74d73..5690f3fa4 100644 --- a/docs/_build/man/barman-cloud-backup-keep.1 +++ b/docs/_build/man/barman-cloud-backup-keep.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-BACKUP-KEEP" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-BACKUP-KEEP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-backup-keep \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-backup-keep \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-backup\-keep [ { \-V | \-\-version } ] [ \-\-help ] @@ -52,8 +51,7 @@ barman\-cloud\-backup\-keep [ { \-s | \-\-status } ] [ \-\-target { full | standalone } ] SOURCE_URL SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -81,7 +79,7 @@ Name of the server that holds the backup to be kept. .TP .B \fBSOURCE_URL\fP URL of the cloud source, such as a bucket in AWS S3. For example: -\fIs3://bucket/path/to/folder\fP\&. +\fBs3://bucket/path/to/folder\fP\&. .TP .B \fBBACKUP_ID\fP The ID of the backup to be kept. diff --git a/docs/_build/man/barman-cloud-backup-list.1 b/docs/_build/man/barman-cloud-backup-list.1 index a1aa8414d..ee5095dc5 100644 --- a/docs/_build/man/barman-cloud-backup-list.1 +++ b/docs/_build/man/barman-cloud-backup-list.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-BACKUP-LIST" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-BACKUP-LIST" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-backup-list \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-backup-list \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-backup\-list [ { \-V | \-\-version } ] [ \-\-help ] @@ -50,8 +49,7 @@ barman\-cloud\-backup\-list [ \-\-azure\-credential { azure\-cli | managed\-identity } ] [ \-\-format ] SOURCE_URL SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -75,7 +73,7 @@ Name of the server that holds the backup to be listed. .TP .B \fBSOURCE_URL\fP URL of the cloud source, such as a bucket in AWS S3. For example: -\fIs3://bucket/path/to/folder\fP\&. +\fBs3://bucket/path/to/folder\fP\&. .TP .B \fB\-V\fP / \fB\-\-version\fP Show version and exit. diff --git a/docs/_build/man/barman-cloud-backup-show.1 b/docs/_build/man/barman-cloud-backup-show.1 index 312a3e445..2b0fab017 100644 --- a/docs/_build/man/barman-cloud-backup-show.1 +++ b/docs/_build/man/barman-cloud-backup-show.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-BACKUP-SHOW" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-BACKUP-SHOW" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-backup-show \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-backup-show \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-backup\-show [ { \-V | \-\-version } ] [ \-\-help ] @@ -50,8 +49,7 @@ barman\-cloud\-backup\-show [ \-\-azure\-credential { azure\-cli | managed\-identity } ] [ \-\-format ] SOURCE_URL SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -77,7 +75,7 @@ Name of the server that holds the backup to be displayed. .TP .B \fBSOURCE_URL\fP URL of the cloud source, such as a bucket in AWS S3. For example: -\fIs3://bucket/path/to/folder\fP\&. +\fBs3://bucket/path/to/folder\fP\&. .TP .B \fB\-V\fP / \fB\-\-version\fP Show version and exit. diff --git a/docs/_build/man/barman-cloud-backup.1 b/docs/_build/man/barman-cloud-backup.1 index ebfd0c7ef..3848a2eab 100644 --- a/docs/_build/man/barman-cloud-backup.1 +++ b/docs/_build/man/barman-cloud-backup.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-BACKUP" "1" "Nov 11, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-BACKUP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-backup \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-backup \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-backup [ { \-V | \-\-version } ] [ \-\-help ] @@ -78,8 +77,7 @@ barman\-cloud\-backup [ \-\-kms\-key\-name KMS_KEY_NAME ] [ \-\-gcp\-zone GCP_ZONE ] DESTINATION_URL SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp diff --git a/docs/_build/man/barman-cloud-check-wal-archive.1 b/docs/_build/man/barman-cloud-check-wal-archive.1 index 5e78353a9..139bff105 100644 --- a/docs/_build/man/barman-cloud-check-wal-archive.1 +++ b/docs/_build/man/barman-cloud-check-wal-archive.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-CHECK-WAL-ARCHIVE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-CHECK-WAL-ARCHIVE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-check-wal-archive \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-check-wal-archive \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-check\-wal\-archive [ { \-V | \-\-version } ] [ \-\-help ] @@ -50,8 +49,7 @@ barman\-cloud\-check\-wal\-archive [ \-\-azure\-credential { azure\-cli | managed\-identity } ] [ \-\-timeline TIMELINE ] DESTINATION_URL SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -75,7 +73,7 @@ For GCP, only authentication with \fBGOOGLE_APPLICATION_CREDENTIALS\fP env is su Name of the server that needs to be checked. .TP .B \fBDESTINATION_URL\fP -URL of the cloud destination, such as a bucket in AWS S3. For example: \fIs3://bucket/path/to/folder\fP\&. +URL of the cloud destination, such as a bucket in AWS S3. For example: \fBs3://bucket/path/to/folder\fP\&. .TP .B \fB\-V\fP / \fB\-\-version\fP Show version and exit. diff --git a/docs/_build/man/barman-cloud-restore.1 b/docs/_build/man/barman-cloud-restore.1 index b92d3b2a9..1ff14e144 100644 --- a/docs/_build/man/barman-cloud-restore.1 +++ b/docs/_build/man/barman-cloud-restore.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-RESTORE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-RESTORE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-restore \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-restore \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-restore [ { \-V | \-\-version } ] [ \-\-help ] @@ -54,8 +53,7 @@ barman\-cloud\-restore [ \-\-azure\-resource\-group AZURE_RESOURCE_GROUP ] [ \-\-tablespace NAME:LOCATION ] SOURCE_URL SERVER_NAME BACKUP_ID RECOVERY_DESTINATION -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -81,7 +79,7 @@ Name of the server that holds the backup to be restored. .TP .B \fBSOURCE_URL\fP URL of the cloud source, such as a bucket in AWS S3. For example: -\fIs3://bucket/path/to/folder\fP\&. +\fBs3://bucket/path/to/folder\fP\&. .TP .B \fBBACKUP_ID\fP The ID of the backup to be restored. diff --git a/docs/_build/man/barman-cloud-wal-archive.1 b/docs/_build/man/barman-cloud-wal-archive.1 index 579bb3531..fadfd5d98 100644 --- a/docs/_build/man/barman-cloud-wal-archive.1 +++ b/docs/_build/man/barman-cloud-wal-archive.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-WAL-ARCHIVE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-WAL-ARCHIVE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-wal-archive \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-wal-archive \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-wal\-archive [ { \-V | \-\-version } ] [ \-\-help ] @@ -61,15 +60,14 @@ barman\-cloud\-wal\-archive [ \-\-max\-single\-put\-size MAX_SINGLE_PUT_SIZE ] [ \-\-kms\-key\-name KMS_KEY_NAME ] DESTINATION_URL SERVER_NAME [ WAL_PATH ] -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp \fBDescription\fP .sp The \fBbarman\-cloud\-wal\-archive\fP command is designed to be used in the -\fBarchive_command\fP of a PostgreSQL server to directly ship WAL files to cloud storage. +\fBarchive_command\fP of a Postgres server to directly ship WAL files to cloud storage. .sp \fBNOTE:\fP .INDENT 0.0 @@ -98,7 +96,7 @@ For GCP, only authentication with \fBGOOGLE_APPLICATION_CREDENTIALS\fP env is su Name of the server that will have the WALs archived. .TP .B \fBDESTINATION_URL\fP -URL of the cloud destination, such as a bucket in AWS S3. For example: \fIs3://bucket/path/to/folder\fP\&. +URL of the cloud destination, such as a bucket in AWS S3. For example: \fBs3://bucket/path/to/folder\fP\&. .TP .B \fBWAL_PATH\fP The value of the \(aq%p\(aq keyword (according to \fBarchive_command\fP). diff --git a/docs/_build/man/barman-cloud-wal-restore.1 b/docs/_build/man/barman-cloud-wal-restore.1 index 4dcd5cb18..1a2e81361 100644 --- a/docs/_build/man/barman-cloud-wal-restore.1 +++ b/docs/_build/man/barman-cloud-wal-restore.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CLOUD-WAL-RESTORE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CLOUD-WAL-RESTORE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cloud-wal-restore \- Barman-cloud Commands .sp @@ -35,8 +35,7 @@ barman-cloud-wal-restore \- Barman-cloud Commands .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-cloud\-wal\-restore [ { \-V | \-\-version } ] [ \-\-help ] @@ -50,15 +49,14 @@ barman\-cloud\-wal\-restore [ \-\-azure\-credential { azure\-cli | managed\-identity } ] [ \-\-no\-partial ] DESTINATION_URL SERVER_NAME WAL_NAME WAL_DEST -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp \fBDescription\fP .sp The \fBbarman\-cloud\-wal\-restore\fP script functions as the \fBrestore_command\fP for -retrieving WAL files from cloud storage and placing them directly into a PostgreSQL +retrieving WAL files from cloud storage and placing them directly into a Postgres standby server, bypassing the Barman server. .sp This script is used to download WAL files that were previously archived with the @@ -90,7 +88,7 @@ For GCP, only authentication with \fBGOOGLE_APPLICATION_CREDENTIALS\fP env is su Name of the server that will have WALs restored. .TP .B \fBDESTINATION_URL\fP -URL of the cloud destination, such as a bucket in AWS S3. For example: \fIs3://bucket/path/to/folder\fP\&. +URL of the cloud destination, such as a bucket in AWS S3. For example: \fBs3://bucket/path/to/folder\fP\&. .TP .B \fBWAL_NAME\fP The value of the \(aq%f\(aq keyword (according to \fBrestore_command\fP). diff --git a/docs/_build/man/barman-config-switch.1 b/docs/_build/man/barman-config-switch.1 index 67204fbe7..447c31e67 100644 --- a/docs/_build/man/barman-config-switch.1 +++ b/docs/_build/man/barman-config-switch.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CONFIG-SWITCH" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CONFIG-SWITCH" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-config-switch \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX config\-switch SERVER_NAME { \-\-reset | MODEL_NAME } -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-config-update.1 b/docs/_build/man/barman-config-update.1 index 1a436ec45..9be5f605c 100644 --- a/docs/_build/man/barman-config-update.1 +++ b/docs/_build/man/barman-config-update.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CONFIG-UPDATE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CONFIG-UPDATE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-config-update \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX config\-update STRING -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-cron.1 b/docs/_build/man/barman-cron.1 index fbf921921..a1dd322dd 100644 --- a/docs/_build/man/barman-cron.1 +++ b/docs/_build/man/barman-cron.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-CRON" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-CRON" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-cron \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX cron [ \-\-keep\-descriptors ] -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-delete.1 b/docs/_build/man/barman-delete.1 index 928253b85..828b633e5 100644 --- a/docs/_build/man/barman-delete.1 +++ b/docs/_build/man/barman-delete.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-DELETE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-DELETE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-delete \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX delete SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -57,9 +56,8 @@ Id of the backup in barman catalog. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -90,7 +88,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-diagnose.1 b/docs/_build/man/barman-diagnose.1 index 0b69d02ce..76d94919f 100644 --- a/docs/_build/man/barman-diagnose.1 +++ b/docs/_build/man/barman-diagnose.1 @@ -27,24 +27,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-DIAGNOSE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-DIAGNOSE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-diagnose \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX diagnose -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp Display diagnostic information about the Barman node, which is the server where Barman -is installed, as well as all configured PostgreSQL servers. This includes details such as +is installed, as well as all configured Postgres servers. This includes details such as global configuration, SSH version, Python version, rsync version, the current configuration and status of all servers, and many more. .SH AUTHOR diff --git a/docs/_build/man/barman-generate-manifest.1 b/docs/_build/man/barman-generate-manifest.1 index 5c9f7d17a..2d9702112 100644 --- a/docs/_build/man/barman-generate-manifest.1 +++ b/docs/_build/man/barman-generate-manifest.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-GENERATE-MANIFEST" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-GENERATE-MANIFEST" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-generate-manifest \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX generate\-manifest SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -58,9 +57,8 @@ Id of the backup in barman catalog. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -91,7 +89,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-get-wal.1 b/docs/_build/man/barman-get-wal.1 index 65e54bdb9..66b65a1b5 100644 --- a/docs/_build/man/barman-get-wal.1 +++ b/docs/_build/man/barman-get-wal.1 @@ -27,15 +27,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-GET-WAL" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-GET-WAL" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-get-wal \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX get\-wal [ \-j ] [ \-o OUTPUT_DIRECTORY ] @@ -44,8 +43,7 @@ get\-wal [ { \-t | \-\-test } ] [ \-z ] SERVER_NAME WAL_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -61,9 +59,16 @@ Name of the server in barman node .B \fBWAL_NAME\fP Id of the backup in barman catalog. .TP -.B \fB\-j\fP +.B \fB\-j\fP / \fB\-\-bzip2\fP Output will be compressed using bzip2. .TP +.B \fB\-z\fP / \fB\-\-gzip\fP +Output will be compressed using gzip. +.TP +.B \fB\-\-keep\-compression\fP +Do not uncompress the file content. The output will be the original compressed +file. +.TP .B \fB\-o\fP Destination directory where barman will store the WAL file. .TP @@ -77,12 +82,18 @@ per row. Additionally, collect partial WAL files (.partial). .TP .B \fB\-t\fP / \fB\-\-test\fP -Test both the connection and configuration of the specified PostgreSQL server in +Test both the connection and configuration of the specified Postgres server in Barman for WAL retrieval. When this option is used, the required \fBWAL_NAME\fP argument is disregarded. -.TP -.B \fB\-z\fP -Output will be compressed using gzip. +.UNINDENT +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +\fB\-z\fP / \fB\-\-gzip\fP and \fB\-j\fP / \fB\-\-bzip2\fP options are deprecated and will be +removed in the future. For WAL compression, please make sure to enable it directly +on the Barman server via the \fBcompression\fP configuration option. +.UNINDENT .UNINDENT .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-keep.1 b/docs/_build/man/barman-keep.1 index 3aa79a93e..82e537f72 100644 --- a/docs/_build/man/barman-keep.1 +++ b/docs/_build/man/barman-keep.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,20 +28,18 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-KEEP" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-KEEP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-keep \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX keep { \-\-release | \-\-status | \-\-target { full | standalone } } SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -84,9 +83,8 @@ backup\(aqs consistency. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -117,7 +115,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-list-files.1 b/docs/_build/man/barman-list-files.1 index 4100013ee..73cea5bde 100644 --- a/docs/_build/man/barman-list-files.1 +++ b/docs/_build/man/barman-list-files.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,20 +28,18 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-LIST-FILES" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-LIST-FILES" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-list-files \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX list\-files [ \-\-target { data | full | standalone | wal } ] SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -74,9 +73,8 @@ specified base backup is the most recent one available). .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -107,7 +105,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-list-servers.1 b/docs/_build/man/barman-list-servers.1 index c866d5a19..4ce524396 100644 --- a/docs/_build/man/barman-list-servers.1 +++ b/docs/_build/man/barman-list-servers.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-LIST-SERVERS" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-LIST-SERVERS" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-list-servers \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX list\-servers [ \-\-minimal ] -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-list_backups.1 b/docs/_build/man/barman-list_backups.1 index b6771dfe9..6cd6b2de9 100644 --- a/docs/_build/man/barman-list_backups.1 +++ b/docs/_build/man/barman-list_backups.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-LIST_BACKUPS" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-LIST_BACKUPS" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-list_backups \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX list\-backups SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -56,9 +55,8 @@ Name of the server in barman node .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -70,7 +68,6 @@ T{ T} T{ All available servers T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-lock-directory-cleanup.1 b/docs/_build/man/barman-lock-directory-cleanup.1 index 157a1beda..02b7bd4e2 100644 --- a/docs/_build/man/barman-lock-directory-cleanup.1 +++ b/docs/_build/man/barman-lock-directory-cleanup.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-LOCK-DIRECTORY-CLEANUP" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-LOCK-DIRECTORY-CLEANUP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-lock-directory-cleanup \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX lock\-directory\-cleanup -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-put-wal.1 b/docs/_build/man/barman-put-wal.1 index 47017bf8e..278a93302 100644 --- a/docs/_build/man/barman-put-wal.1 +++ b/docs/_build/man/barman-put-wal.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-PUT-WAL" "1" "Nov 7, 2024" "3.11" "Barman" +.TH "BARMAN-PUT-WAL" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-put-wal \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX put\-wal [ { \-t | \-\-test } ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-rebuild-xlogdb.1 b/docs/_build/man/barman-rebuild-xlogdb.1 index 2b99a87ff..53ec3da31 100644 --- a/docs/_build/man/barman-rebuild-xlogdb.1 +++ b/docs/_build/man/barman-rebuild-xlogdb.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-REBUILD-XLOGDB" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-REBUILD-XLOGDB" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-rebuild-xlogdb \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX rebuild\-xlogdb SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -56,9 +55,8 @@ Name of the server in barman node. .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -70,7 +68,6 @@ T{ T} T{ All available servers T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-receive-wal.1 b/docs/_build/man/barman-receive-wal.1 index 775b7c25f..05d493a70 100644 --- a/docs/_build/man/barman-receive-wal.1 +++ b/docs/_build/man/barman-receive-wal.1 @@ -27,29 +27,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-RECEIVE-WAL" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-RECEIVE-WAL" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-receive-wal \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX receive\-wal [ \-\-create\-slot ] [ \-\-drop\-slot ] [ \-\-reset ] [ \-\-stop ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp Initiate the streaming of transaction logs for a server. This process uses -\fBpg_receivewal\fP or \fBpg_receivexlog\fP to receive WAL files from PostgreSQL servers via +\fBpg_receivewal\fP or \fBpg_receivexlog\fP to receive WAL files from Postgres servers via the streaming protocol. .SH PARAMETERS .INDENT 0.0 diff --git a/docs/_build/man/barman-replication-status.1 b/docs/_build/man/barman-replication-status.1 index 79f95b06d..b0d61adab 100644 --- a/docs/_build/man/barman-replication-status.1 +++ b/docs/_build/man/barman-replication-status.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,22 +28,20 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-REPLICATION-STATUS" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-REPLICATION-STATUS" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-replication-status \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX replication\-status [ \-\-minimal ] [ \-\-source { backup\-host | wal\-host } ] [ \-\-target { hot\-standby | wal\-streamer | all } ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -85,9 +84,8 @@ The possible values are: .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -99,7 +97,6 @@ T{ T} T{ All available servers T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-restore.1 b/docs/_build/man/barman-restore.1 index f79bf43ba..9e61a1ad5 100644 --- a/docs/_build/man/barman-restore.1 +++ b/docs/_build/man/barman-restore.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,15 +28,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-RESTORE" "1" "Oct 11, 2024" "3.11" "Barman" +.TH "BARMAN-RESTORE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-restore \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX restore [ \-\-aws\-region AWS_REGION } ] [ \-\-azure\-resource\-group AZURE_RESOURCE_GRP ] @@ -65,8 +65,7 @@ restore [ \-\-target\-tli TLI ] [ \-\-target\-xid XID ] SERVER_NAME BACKUP_ID DESTINATION_DIR -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -113,7 +112,7 @@ This option allows you to override the \fBgcp_zone\fP value in the Barman configuration. .TP .B \fB\-\-get\-wal\fP / \fB\-\-no\-get\-wal\fP -Enable/disable usage of \fBget\-wal\fP for WAL fetching during restoration. Default is based on +Enable/disable usage of \fBget\-wal\fP for WAL fetching during recovery. Default is based on \fBrecovery_options\fP setting. .TP .B \fB\-j\fP / \fB\-\-jobs\fP @@ -198,42 +197,41 @@ requires defining a target along with one of these actions. The possible values \fBpause\fP: Once recovery target is reached, the server is started in pause state, allowing users to inspect the instance .IP \(bu 2 -\fBpromote\fP: Once recovery target is reached, the server will exit the restore +\fBpromote\fP: Once recovery target is reached, the server will exit the recovery operation and is promoted as a master. .IP \(bu 2 \fBshutdown\fP: Once recovery target is reached, the server is shut down. .UNINDENT .TP .B \fB\-\-target\-immediate\fP -Restore is completed when a consistent state is reached (end of the base backup). +Recovery is completed when a consistent state is reached (end of the base backup). .TP .B \fB\-\-target\-lsn\fP -Restore to the specified LSN (Log Sequence Number). Requires Postgres 10 or above. +Recover to the specified LSN (Log Sequence Number). Requires Postgres 10 or above. .TP .B \fB\-\-target\-name\fP -Restore to the specified name of a restore point previously created with the +Recover to the specified name of a restore point previously created with the \fBpg_create_restore_point(name)\fP\&. .TP .B \fB\-\-target\-time\fP -Restore to the specified time. Use the format \fBYYYY\-MM\-DD HH:MM:SS.mmm\fP\&. +Recover to the specified time. Use the format \fBYYYY\-MM\-DD HH:MM:SS.mmm\fP\&. .TP .B \fB\-\-target\-tli\fP -Restore the specified timeline. You can use the special values \fBcurrent\fP and +Recover the specified timeline. You can use the special values \fBcurrent\fP and \fBlatest\fP in addition to a numeric timeline ID. For Postgres versions 12 and above, -the default is to restore to the latest timeline in the WAL archive. For Postgres -versions below 12, the default is to restore to the timeline that was current at the +the default is to recover to the latest timeline in the WAL archive. For Postgres +versions below 12, the default is to recover to the timeline that was current at the time the backup was taken. .TP .B \fB\-\-target\-xid\fP -Restore to the specified transaction ID. +Recover to the specified transaction ID. .UNINDENT .SH SHORTCUTS .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -264,7 +262,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-show-backup.1 b/docs/_build/man/barman-show-backup.1 index 275da5516..235ce2f98 100644 --- a/docs/_build/man/barman-show-backup.1 +++ b/docs/_build/man/barman-show-backup.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-SHOW-BACKUP" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-SHOW-BACKUP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-show-backup \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX show\-backup SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -58,9 +57,8 @@ Id of the backup in barman catalog. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -91,7 +89,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-show-servers.1 b/docs/_build/man/barman-show-servers.1 index 019d3bfa1..b33f35d9f 100644 --- a/docs/_build/man/barman-show-servers.1 +++ b/docs/_build/man/barman-show-servers.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-SHOW-SERVERS" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-SHOW-SERVERS" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-show-servers \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX show\-servers SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -54,9 +53,8 @@ Name of the server in barman node .UNINDENT .SH SHORTCUTS .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -68,7 +66,6 @@ T{ T} T{ All available servers T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-status.1 b/docs/_build/man/barman-status.1 index a6c937e26..1da8a8017 100644 --- a/docs/_build/man/barman-status.1 +++ b/docs/_build/man/barman-status.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-STATUS" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-STATUS" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-status \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX status SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -53,9 +52,8 @@ Name of the server in barman node .UNINDENT .SH SHORTCUTS .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -67,7 +65,6 @@ T{ T} T{ All available servers T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-switch-wal.1 b/docs/_build/man/barman-switch-wal.1 index 17fcb78ef..fc4cff718 100644 --- a/docs/_build/man/barman-switch-wal.1 +++ b/docs/_build/man/barman-switch-wal.1 @@ -27,22 +27,20 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-SWITCH-WAL" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-SWITCH-WAL" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-switch-wal \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX switch\-wal [ \-\-archive ] [ \-\-archive\-timeout ] [ \-\-force ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -71,7 +69,7 @@ Forces the switch by executing a CHECKPOINT before \fBpg_switch_wal()\fP\&. \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -Running a CHECKPOINT may increase I/O load on the PostgreSQL server, so use this +Running a CHECKPOINT may increase I/O load on the Postgres server, so use this option cautiously. .UNINDENT .UNINDENT diff --git a/docs/_build/man/barman-switch-xlog.1 b/docs/_build/man/barman-switch-xlog.1 index 184ebdb41..8c6ecd1a2 100644 --- a/docs/_build/man/barman-switch-xlog.1 +++ b/docs/_build/man/barman-switch-xlog.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-SWITCH-XLOG" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-SWITCH-XLOG" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-switch-xlog \- Barman Sub-Commands .SH DESCRIPTION diff --git a/docs/_build/man/barman-sync-backup.1 b/docs/_build/man/barman-sync-backup.1 index 08bc377ff..c7c1d1829 100644 --- a/docs/_build/man/barman-sync-backup.1 +++ b/docs/_build/man/barman-sync-backup.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-SYNC-BACKUP" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-SYNC-BACKUP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-sync-backup \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX sync\-backup SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -61,9 +60,8 @@ Id of the backup in barman catalog. For some commands, instead of using the timestamp backup ID, you can use the following shortcuts or aliases to identify a backup for a given server: .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -94,7 +92,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-sync-info.1 b/docs/_build/man/barman-sync-info.1 index a037a99e5..732f030b2 100644 --- a/docs/_build/man/barman-sync-info.1 +++ b/docs/_build/man/barman-sync-info.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-SYNC-INFO" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-SYNC-INFO" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-sync-info \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C -sync\-info SERVER_NAME [ LAST_WAL [ LAST_POS ] ] -.ft P -.fi +.EX +sync\-info [ \-\-primary ] SERVER_NAME [ LAST_WAL [ LAST_POS ] ] +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-sync-wals.1 b/docs/_build/man/barman-sync-wals.1 index 805af3996..5ad8c5197 100644 --- a/docs/_build/man/barman-sync-wals.1 +++ b/docs/_build/man/barman-sync-wals.1 @@ -27,18 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-SYNC-WALS" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-SYNC-WALS" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-sync-wals \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX sync\-wals SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION diff --git a/docs/_build/man/barman-verify-backup.1 b/docs/_build/man/barman-verify-backup.1 index 62fd82600..a450f79cc 100644 --- a/docs/_build/man/barman-verify-backup.1 +++ b/docs/_build/man/barman-verify-backup.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,18 +28,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-VERIFY-BACKUP" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-VERIFY-BACKUP" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-verify-backup \- Barman Sub-Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX verify\-backup SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION @@ -61,9 +60,8 @@ Id of the backup in barman catalog. For some commands, instead of using the timestamp backup ID, you can use the following shortcuts or aliases to identify a backup for a given server: .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -94,7 +92,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH AUTHOR EnterpriseDB diff --git a/docs/_build/man/barman-verify.1 b/docs/_build/man/barman-verify.1 index 0fdfec412..2c0db5e75 100644 --- a/docs/_build/man/barman-verify.1 +++ b/docs/_build/man/barman-verify.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-VERIFY" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-VERIFY" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-verify \- Barman Sub-Commands .SH DESCRIPTION diff --git a/docs/_build/man/barman-wal-archive.1 b/docs/_build/man/barman-wal-archive.1 index ba34ea147..58cb9d6a4 100644 --- a/docs/_build/man/barman-wal-archive.1 +++ b/docs/_build/man/barman-wal-archive.1 @@ -27,15 +27,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-WAL-ARCHIVE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-WAL-ARCHIVE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-wal-archive \- Barman-cli Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-wal\-archive [ { \-h, \-\-help } ] [ { \-V, \-\-version } ] @@ -44,16 +43,15 @@ barman\-wal\-archive [ { \-c, \-\-config } CONFIG ] [ { \-t \-\-test } ] BARMAN_HOST SERVER_NAME WAL_PATH -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp -This script can be utilized in the \fBarchive_command\fP of a PostgreSQL server to +This script can be utilized in the \fBarchive_command\fP of a Postgres server to transfer WAL files to a Barman host using the \fBput\-wal\fP command (introduced in Barman 2.6). It establishes an SSH connection to the Barman host, enabling seamless integration -of Barman within PostgreSQL clusters for improved business continuity. +of Barman within Postgres clusters for improved business continuity. .sp \fBExit Statuses\fP are: .INDENT 0.0 @@ -92,7 +90,7 @@ Define the port used for the SSH connection to the Barman server. Specify the configuration file on the Barman server. .TP .B \fB\-t\fP / \fB\-\-test\fP -Test the connection and configuration of the specified PostgreSQL server in Barman to +Test the connection and configuration of the specified Postgres server in Barman to ensure it is ready to receive WAL files. This option ignores the mandatory arguments \fBWAL_NAME\fP and \fBWAL_DEST\fP\&. .UNINDENT diff --git a/docs/_build/man/barman-wal-restore.1 b/docs/_build/man/barman-wal-restore.1 index a47a7844b..b88c88958 100644 --- a/docs/_build/man/barman-wal-restore.1 +++ b/docs/_build/man/barman-wal-restore.1 @@ -27,15 +27,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN-WAL-RESTORE" "1" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN-WAL-RESTORE" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman-wal-restore \- Barman-cli Commands .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-wal\-restore [ { \-h, \-\-help } ] [ { \-V, \-\-version } ] @@ -50,16 +49,15 @@ barman\-wal\-restore [ { \-c, \-\-config } CONFIG ] [ { \-t \-\-test } ] BARMAN_HOST SERVER_NAME WAL_NAME WAL_DEST -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp -This script serves as a \fBrestore_command\fP for PostgreSQL servers, enabling the +This script serves as a \fBrestore_command\fP for Postgres servers, enabling the retrieval of WAL files through Barman\(aqs \fBget\-wal\fP feature. It establishes an SSH connection to the Barman host and facilitates the integration of Barman within -PostgreSQL clusters, enhancing business continuity. +Postgres clusters, enhancing business continuity. .sp \fBExit Statuses\fP are: .INDENT 0.0 @@ -122,14 +120,27 @@ Transfer WAL files compressed with \fBgzip\fP\&. .B \fB\-j\fP / \fB\-\-bzip2\fP Transfer WAL files compressed with \fBbzip2\fP\&. .TP +.B \fB\-\-keep\-compression\fP +If specified, compressed files will be trasnfered as\-is and decompressed on arrival +on the client\-side. +.TP .B \fB\-c\fP / \fB\-\-config\fP Specify the configuration file on the Barman server. .TP .B \fB\-t\fP / \fB\-\-test\fP -Test the connection and configuration of the specified PostgreSQL server in Barman to +Test the connection and configuration of the specified Postgres server in Barman to ensure it is ready to receive WAL files. This option ignores the mandatory arguments \fBWAL_NAME\fP and \fBWAL_DEST\fP\&. .UNINDENT +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +\fB\-z\fP / \fB\-\-gzip\fP and \fB\-j\fP / \fB\-\-bzip2\fP options are deprecated and will be +removed in the future. For WAL compression, please make sure to enable it directly +on the Barman server via the \fBcompression\fP configuration option. +.UNINDENT +.UNINDENT .SH AUTHOR EnterpriseDB .SH COPYRIGHT diff --git a/docs/_build/man/barman.1 b/docs/_build/man/barman.1 index 675be8744..8ae8e747d 100644 --- a/docs/_build/man/barman.1 +++ b/docs/_build/man/barman.1 @@ -1,3 +1,4 @@ +'\" t .\" Man page generated from reStructuredText. . . @@ -27,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN" "1" "Nov 7, 2024" "3.11" "Barman" +.TH "BARMAN" "1" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman \- Barman Commands .sp @@ -42,8 +43,7 @@ behavior of the sub\-commands and can be used as follows: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman [ { \-c | \-\-config } CONFIG ] [ { \-color | \-\-colour } { never | always | auto } ] @@ -54,8 +54,7 @@ barman [ { \-q | \-\-quiet } ] [ { \-v | \-\-version } ] [ SUBCOMMAND ] -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -160,9 +159,8 @@ For some commands, you can use the following shortcuts or aliases to identify a for a given server. Specifically, the \fBall\fP shortcut can be used to identify all servers: .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -199,7 +197,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SH EXIT STATUSES .sp @@ -218,11 +215,9 @@ quickly navigate to it. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX archive\-wal SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -242,8 +237,7 @@ Name of the server in barman node. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX backup [ \-\-bwlimit KBPS ] [ \-\-incremental BACKUP_ID ] @@ -263,8 +257,7 @@ backup [ { \-\-wait | \-w } ] [ \-\-wait\-timeout SECONDS ] SERVER_NAME [ ... ] -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -384,9 +377,8 @@ before timing out. .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -398,18 +390,15 @@ T{ T} T{ All available servers T} -_ .TE .SS \fBbarman check\-backup\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX check\-backup SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -430,9 +419,8 @@ Id of the backup in barman catalog. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -463,18 +451,15 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman check\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX check [ \-\-nagios ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -496,9 +481,8 @@ Nagios plugin compatible output. .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -510,18 +494,15 @@ T{ T} T{ All available servers T} -_ .TE .SS \fBbarman config\-switch\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX config\-switch SERVER_NAME { \-\-reset | MODEL_NAME } -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -554,11 +535,9 @@ Reset the server\(aqs configurations. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX config\-update STRING -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -595,11 +574,9 @@ List of JSON formatted string. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX cron [ \-\-keep\-descriptors ] -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -617,11 +594,9 @@ main process. This is especially useful for Docker\-based installations. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX delete SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -640,9 +615,8 @@ Id of the backup in barman catalog. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -673,18 +647,15 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman diagnose\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX diagnose -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -698,11 +669,9 @@ configuration and status of all servers, and many more. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX generate\-manifest SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -722,9 +691,8 @@ Id of the backup in barman catalog. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -755,15 +723,13 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman get\-wal\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX get\-wal [ \-j ] [ \-o OUTPUT_DIRECTORY ] @@ -772,8 +738,7 @@ get\-wal [ { \-t | \-\-test } ] [ \-z ] SERVER_NAME WAL_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -789,9 +754,16 @@ Name of the server in barman node .B \fBWAL_NAME\fP Id of the backup in barman catalog. .TP -.B \fB\-j\fP +.B \fB\-j\fP / \fB\-\-bzip2\fP Output will be compressed using bzip2. .TP +.B \fB\-z\fP / \fB\-\-gzip\fP +Output will be compressed using gzip. +.TP +.B \fB\-\-keep\-compression\fP +Do not uncompress the file content. The output will be the original compressed +file. +.TP .B \fB\-o\fP Destination directory where barman will store the WAL file. .TP @@ -808,22 +780,26 @@ Additionally, collect partial WAL files (.partial). Test both the connection and configuration of the specified Postgres server in Barman for WAL retrieval. When this option is used, the required \fBWAL_NAME\fP argument is disregarded. -.TP -.B \fB\-z\fP -Output will be compressed using gzip. +.UNINDENT +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +\fB\-z\fP / \fB\-\-gzip\fP and \fB\-j\fP / \fB\-\-bzip2\fP options are deprecated and will be +removed in the future. For WAL compression, please make sure to enable it directly +on the Barman server via the \fBcompression\fP configuration option. +.UNINDENT .UNINDENT .SS \fBbarman keep\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX keep { \-\-release | \-\-status | \-\-target { full | standalone } } SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -867,9 +843,8 @@ backup\(aqs consistency. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -900,18 +875,15 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman list\-backups\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX list\-backups SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -929,9 +901,8 @@ Name of the server in barman node .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -943,20 +914,17 @@ T{ T} T{ All available servers T} -_ .TE .SS \fBbarman list\-files\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX list\-files [ \-\-target { data | full | standalone | wal } ] SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -990,9 +958,8 @@ specified base backup is the most recent one available). .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1023,18 +990,15 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman list\-servers\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX list\-servers [ \-\-minimal ] -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1051,11 +1015,9 @@ Machine readable output. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX lock\-directory\-cleanup -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1066,11 +1028,9 @@ Automatically removes unused lock files from the \fBbarman_lock_directory\fP\&. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX put\-wal [ { \-t | \-\-test } ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1097,11 +1057,9 @@ server in Barman for WAL retrieval. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX rebuild\-xlogdb SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1119,9 +1077,8 @@ Name of the server in barman node. .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1133,23 +1090,20 @@ T{ T} T{ All available servers T} -_ .TE .SS \fBbarman receive\-wal\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX receive\-wal [ \-\-create\-slot ] [ \-\-drop\-slot ] [ \-\-reset ] [ \-\-stop ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1183,8 +1137,7 @@ Stop the process for the server. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX restore [ \-\-aws\-region AWS_REGION } ] [ \-\-azure\-resource\-group AZURE_RESOURCE_GRP ] @@ -1214,8 +1167,7 @@ restore [ \-\-target\-tli TLI ] [ \-\-target\-xid XID ] SERVER_NAME BACKUP_ID DESTINATION_DIR -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1380,9 +1332,8 @@ Recover to the specified transaction ID. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1413,22 +1364,19 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman replication\-status\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX replication\-status [ \-\-minimal ] [ \-\-source { backup\-host | wal\-host } ] [ \-\-target { hot\-standby | wal\-streamer | all } ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1471,9 +1419,8 @@ The possible values are: .sp Use shortcuts instead of \fBSERVER_NAME\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1485,18 +1432,15 @@ T{ T} T{ All available servers T} -_ .TE .SS \fBbarman show\-backup\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX show\-backup SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1516,9 +1460,8 @@ Id of the backup in barman catalog. .sp Use shortcuts instead of \fBBACKUP_ID\fP\&. .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1549,18 +1492,15 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman show\-servers\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX show\-servers SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1576,9 +1516,8 @@ Name of the server in barman node .UNINDENT .SS Shortcuts .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1590,18 +1529,15 @@ T{ T} T{ All available servers T} -_ .TE .SS \fBbarman status\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX status SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1616,9 +1552,8 @@ Name of the server in barman node .UNINDENT .SS Shortcuts .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1630,22 +1565,19 @@ T{ T} T{ All available servers T} -_ .TE .SS \fBbarman switch\-wal\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX switch\-wal [ \-\-archive ] [ \-\-archive\-timeout ] [ \-\-force ] SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1688,11 +1620,9 @@ Alias for the \fBswitch\-wal\fP command. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX sync\-backup SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1715,9 +1645,8 @@ Id of the backup in barman catalog. For some commands, instead of using the timestamp backup ID, you can use the following shortcuts or aliases to identify a backup for a given server: .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1748,18 +1677,15 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman sync\-info\fP .SS Synopsis .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C -sync\-info SERVER_NAME [ LAST_WAL [ LAST_POS ] ] -.ft P -.fi +.EX +sync\-info [ \-\-primary ] SERVER_NAME [ LAST_WAL [ LAST_POS ] ] +.EE .UNINDENT .UNINDENT .SS Description @@ -1788,11 +1714,9 @@ Hint for quickly positioning in the \fBxlog.db\fP file (for incremental synchron .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX sync\-wals SERVER_NAME -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1811,11 +1735,9 @@ Name of the server in barman node .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX verify\-backup SERVER_NAME BACKUP_ID -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1838,9 +1760,8 @@ Id of the backup in barman catalog. For some commands, instead of using the timestamp backup ID, you can use the following shortcuts or aliases to identify a backup for a given server: .TS -center; -|l|l|. -_ +box center; +l|l. T{ \fBShortcut\fP T} T{ @@ -1871,7 +1792,6 @@ T{ T} T{ Most recent backup that failed, in chronological order. T} -_ .TE .SS \fBbarman verify\fP .SS Description @@ -1887,8 +1807,7 @@ both utilities. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-wal\-archive [ { \-h, \-\-help } ] [ { \-V, \-\-version } ] @@ -1897,8 +1816,7 @@ barman\-wal\-archive [ { \-c, \-\-config } CONFIG ] [ { \-t \-\-test } ] BARMAN_HOST SERVER_NAME WAL_PATH -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -1954,8 +1872,7 @@ ensure it is ready to receive WAL files. This option ignores the mandatory argum .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX barman\-wal\-restore [ { \-h, \-\-help } ] [ { \-V, \-\-version } ] @@ -1970,8 +1887,7 @@ barman\-wal\-restore [ { \-c, \-\-config } CONFIG ] [ { \-t \-\-test } ] BARMAN_HOST SERVER_NAME WAL_NAME WAL_DEST -.ft P -.fi +.EE .UNINDENT .UNINDENT .SS Description @@ -2042,6 +1958,10 @@ Transfer WAL files compressed with \fBgzip\fP\&. .B \fB\-j\fP / \fB\-\-bzip2\fP Transfer WAL files compressed with \fBbzip2\fP\&. .TP +.B \fB\-\-keep\-compression\fP +If specified, compressed files will be trasnfered as\-is and decompressed on arrival +on the client\-side. +.TP .B \fB\-c\fP / \fB\-\-config\fP Specify the configuration file on the Barman server. .TP @@ -2050,6 +1970,15 @@ Test the connection and configuration of the specified Postgres server in Barman ensure it is ready to receive WAL files. This option ignores the mandatory arguments \fBWAL_NAME\fP and \fBWAL_DEST\fP\&. .UNINDENT +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +\fB\-z\fP / \fB\-\-gzip\fP and \fB\-j\fP / \fB\-\-bzip2\fP options are deprecated and will be +removed in the future. For WAL compression, please make sure to enable it directly +on the Barman server via the \fBcompression\fP configuration option. +.UNINDENT +.UNINDENT .SH AUTHOR EnterpriseDB .SH COPYRIGHT diff --git a/docs/_build/man/barman.5 b/docs/_build/man/barman.5 index 9ce1f2ebf..5e9ebde59 100644 --- a/docs/_build/man/barman.5 +++ b/docs/_build/man/barman.5 @@ -27,11 +27,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BARMAN" "5" "Oct 10, 2024" "3.11" "Barman" +.TH "BARMAN" "5" "Nov 21, 2024" "3.12" "Barman" .SH NAME barman \- Barman Configurations .sp -Barman follows a \fIconvention over configuration\fP approach, which simplifies configuration +Barman follows a convention over configuration approach, which simplifies configuration by allowing some options to be defined globally and overridden at the server level. This means you can set a default behavior for your servers and then customize specific servers as needed. This design reduces the need for excessive configuration while maintaining @@ -40,22 +40,22 @@ flexibility. .sp Proper configuration is critical for its effective operation. Barman uses different types of configuration files to manage global settings, server\-specific settings, and -model\-specific settings that comprises three scopes: +model\-specific settings that is made up of three scopes: .sp -1. \fBGlobal Configuration\fP: It comprises of one file with a set of configurations for the +1. \fBGlobal Configuration\fP: It comprises one file with a set of configurations for the barman system, such as the main directory, system user, log file, and other general options. Default location is \fB/etc/barman.conf\fP and it can be overridden on a per\-user level by \fB~/.barman.conf\fP or by specifying a \fB\&.conf\fP file using the \fB\-c\fP / \fB\-\-config\fP with the \fI\%barman command\fP directly in the CLI. .sp -2. \fBServer Configuration\fP: It comprises of one or multiple files with a set of -configurations for a PostgreSQL server that you want to keep track and interact for +2. \fBServer Configuration\fP: It comprises one or more files with a set of +configurations for a Postgres server that you want to keep track and interact for backup, recovery and/or replication. Default location is \fB/etc/barman.d\fP and must use the \fB\&.conf\fP suffix. You may have one or multiple files for servers. You can override the default location by setting the \fBconfiguration_files_directory\fP option in the global configuration file and placing the files in that particular location. .sp -3. \fBModel Configuration\fP: It comprises of one or multiple files with a set of +3. \fBModel Configuration\fP: It comprises one or more files with a set of configurations overrides that can be applied to Barman servers within the same cluster as the model. These overrides can be implemented using the barman \fBconfig\-switch\fP command. Default location is \fB/etc/barman.d\fP and must use the \fB\&.conf\fP suffix. The same @@ -112,7 +112,7 @@ Some enums allow \fBoff\fP, but not \fBfalse\fP\&. Options in the configuration files can have specific or shared scopes. The following configuration options are used not only for configuring how Barman will execute backups and recoveries, but also for configuring various aspects of how Barman interacts with the -configured PostgreSQL servers to be able to apply your Backup and Recovery, and +configured Postgres servers to be able to apply your Backup and Recovery, and High\-Availability strategies. .SS General .sp @@ -124,7 +124,7 @@ When this option is set to \fBtrue\fP (default), the server operates fully. If s \fBfalse\fP, the server is restricted to diagnostic use only, meaning that operational commands such as backup execution or WAL archiving are temporarily disabled. When incorporating a new server into Barman, we recommend initially setting -\fBactive=false\fP\&. Verify that barman check shows no issues before activating the +\fBactive = false\fP\&. Verify that barman check shows no issues before activating the server. This approach helps prevent excessive error logging in Barman during the initial setup. .sp @@ -255,25 +255,26 @@ Scope: Global. \fBconfiguration_files_directory\fP .sp Designates the directory where server/model configuration files will be read by Barman. -Defaults to \fB/etc/barman.d\fP\&. +Defaults to \fB/etc/barman.d/\fP\&. .sp Scope: Global. .sp \fBconninfo\fP .sp -Specifies the connection string used by Barman to connect to the PostgreSQL server. +Specifies the connection string used by Barman to connect to the Postgres server. This is a libpq connection string. Commonly used keys include: \fBhost\fP, \fBhostaddr\fP, -\fBport\fP, \fBdbname\fP, \fBuser\fP and \fBpassword\fP\&. See the \fI\%PostgreSQL documentation\fP +\fBport\fP, \fBdbname\fP, \fBuser\fP and \fBpassword\fP\&. See the +\X'tty: link https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING'\fI\%PostgreSQL documentation\fP\X'tty: link' for details. .sp Scope: Server / Model. .sp \fBcreate_slot\fP .sp -Determines whether Barman should automatically create a replication slot, if it\(aqs not -already present, for streaming of WAL files. When set to \fBauto\fP and \fBslot_name\fP -is defined, Barman will attempt to create the slot automatically. When set to -\fBmanual\fP (default), the replication slot must be created manually. +Determines whether Barman should automatically create a replication slot if it\(aqs not +already present for streaming WAL files. When set to \fBauto\fP and \fBslot_name\fP is +defined, Barman will attempt to create the slot automatically. When set to \fBmanual\fP +(default), the replication slot must be created manually. .sp Scope: Global / Server / Model. .sp @@ -287,7 +288,8 @@ Scope: Server / Model. .sp The directory where WAL files that were errored while being archived by Barman are stored. This includes duplicate WAL files (e.g., an archived WAL file that has already -been streamed) and unexpected files found in the WAL archive directory. +been streamed but have different hash) and unexpected files found in the WAL archive +directory. .sp The purpose of placing the files in this directory is so someone can later review why they failed to be archived and take appropriate actions (dispose of, store somewhere else, @@ -365,7 +367,7 @@ Scope: Global / Server / Model. \fBparallel_jobs\fP .sp Controls the number of parallel workers used to copy files during backup or recovery. -Default is \fB1\fP\&. +It must be a positive integer. Default is \fB1\fP\&. .sp \fBNOTE:\fP .INDENT 0.0 @@ -411,10 +413,10 @@ Scope: Global / Server / Model. .sp \fBpath_prefix\fP .sp -Lists one or more absolute paths, separated by colons, where Barman looks for -executable files. These paths are checked before the PATH environment variable. This -option can be set for each server and needs to point to the \fBbin\fP directory for the -appropriate \fBPG_MAJOR_VERSION\fP\&. +Lists one or more absolute paths, separated by colons, where Barman looks for executable +files. These paths are checked before the \fBPATH\fP environment variable. This option can +be set for each server and needs to point to the \fBbin\fP directory for the appropriate +\fBPG_MAJOR_VERSION\fP\&. .sp Scope: Global / Server / Model. .sp @@ -427,14 +429,14 @@ Scope: Server / Model. .sp \fBprimary_conninfo\fP .sp -Connection string for Barman to connect to the primary PostgreSQL server during a +Connection string for Barman to connect to the primary Postgres server during a standby backup. .sp Scope: Server / Model. .sp \fBprimary_ssh_command\fP .sp -SSH command for connecting to the primary server if Barman is passive. +SSH command for connecting to the primary Barman server if Barman is passive. .sp Scope: Global / Server / Model. .sp @@ -447,7 +449,7 @@ Scope: Global / Server / Model. .sp \fBssh_command\fP .sp -SSH command used by Barman to connect to the PostreSQL server. +SSH command used by Barman to connect to the Postgres server for rsync backups. .sp Scope: Server / Model. .sp @@ -514,7 +516,7 @@ This is a boolean option that allows for the automatic creation of backup manife files. The manifest file, which is a JSON document, lists all files included in the backup. It is generated upon completion of the backup and saved in the backup directory. The format of the manifest file adheres to the specifications outlined in the -\fI\%PostgreSQL documentation\fP +\X'tty: link https://www.postgresql.org/docs/current/backup-manifest-format.html'\fI\%PostgreSQL documentation\fP\X'tty: link' and is compatible with the \fBpg_verifybackup\fP tool. Default is \fBfalse\fP\&. .sp \fBNOTE:\fP @@ -530,7 +532,7 @@ Scope: Global / Server / Model. .sp Specifies the compression method for the backup process. It can be set to \fBgzip\fP, \fBlz4\fP, \fBzstd\fP, or \fBnone\fP\&. Ensure that the CLI tool for the chosen compression -method is available on both the Barman and PostgreSQL servers. +method is available on both the Barman and Postgres servers. .sp \fBNOTE:\fP .INDENT 0.0 @@ -621,7 +623,7 @@ Defines the method Barman uses to perform backups. Options include: \fBpostgres\fP: Uses the \fBpg_basebackup\fP command for backups. .IP \(bu 2 \fBlocal\-rsync\fP: Assumes Barman runs on the same server and as the same user as -the PostgreSQL database, performing an rsync file system copy. +the Postgres database, performing an rsync file system copy. .IP \(bu 2 \fBsnapshot\fP: Utilizes the API of the cloud provider specified in the \fBsnapshot_provider\fP option to create disk snapshots as defined in @@ -641,7 +643,7 @@ list that can include: Postgres versions 9.6 and later, and supports backups from standby servers. .IP \(bu 2 \fBexclusive_backup\fP: Uses the deprecated exclusive backup method. Only for Postgres -versions older than 15. +versions older than 15. This option will be removed in the future. .IP \(bu 2 \fBexternal_configuration\fP: Suppresses warnings about external configuration files during backup execution. @@ -1013,8 +1015,8 @@ These configuration options are related to how Barman will manage the Write\-Ahe .sp \fBcompression\fP .sp -Specifies the standard compression algorithm for WAL files. Options include: \fBgzip\fP, -\fBbzip2\fP, \fBpigz\fP, \fBpygzip\fP, \fBpybzip2\fP and \fBcustom\fP\&. +Specifies the standard compression algorithm for WAL files. Options include: \fBlz4\fP, +\fBxz\fP, \fBzstd\fP, \fBgzip\fP, \fBpybzip2\fP, \fBpigz\fP, \fBbzip2\fP, \fBpybzip2\fP and \fBcustom\fP\&. .sp \fBNOTE:\fP .INDENT 0.0 @@ -1077,7 +1079,7 @@ Magic Number: \fBFD 37 7A 58 5A 00\fP Hex String: \fBfd377a585a00\fP .UNINDENT .sp -Reference: \fI\%xz\-file\-format\fP +Reference: \X'tty: link https://tukaani.org/xz/xz-file-format-1.0.4.txt'\fI\%xz\-file\-format\fP\X'tty: link' .UNINDENT .UNINDENT .sp @@ -1140,30 +1142,35 @@ Scope: Server. .sp \fBwal_conninfo\fP .sp -This optional connection string is used by Barman for monitoring the status of the -replication slot used for receiving WALs. When specified, it takes precedence over -\fBwal_streaming_conninfo\fP for these checks. If \fBwal_conninfo\fP is set, but -\fBwal_streaming_conninfo\fP is not, \fBwal_conninfo\fP will be ignored. Both connection -strings must access a Postgres instance within the same cluster as defined by -\fBstreaming_conninfo\fP and \fBconninfo\fP\&. Additionally, \fBwal_streaming_conninfo\fP must -support streaming replication connections, and either it or \fBwal_conninfo\fP (if used) -must have the necessary permissions to read settings and check replication slot -status, such as the \fBpg_monitor\fP role, both \fBpg_read_all_settings\fP and -\fBpg_read_all_stats\fP roles, or \fBsuperuser\fP privileges. +The \fBwal_conninfo\fP connection string is used by Barman for monitoring the status of +the replication slot receiving WALs. If specified, it takes precedence over +\fBwal_streaming_conninfo\fP for these checks. If \fBwal_conninfo\fP is not set but +\fBwal_streaming_conninfo\fP is, \fBwal_conninfo\fP will fall back to +\fBwal_streaming_conninfo\fP\&. If neither \fBwal_conninfo\fP nor \fBwal_streaming_conninfo\fP +is set, \fBwal_conninfo\fP will fall back to \fBconninfo\fP\&. Both connection strings must +access a Postgres instance within the same cluster as defined by \fBstreaming_conninfo\fP +and \fBconninfo\fP\&. If both \fBwal_conninfo\fP and \fBwal_streaming_conninfo\fP are set, only +\fBwal_conninfo\fP needs the appropriate permissions to read settings and check the +replication slot status. However, if only \fBwal_streaming_conninfo\fP is set, it must +have the necessary permissions to perform these tasks. The required permissions include +roles such as \fBpg_monitor\fP, both \fBpg_read_all_settings\fP and \fBpg_read_all_stats\fP, +or superuser privileges. .sp Scope: Server / Model. .sp \fBwal_streaming_conninfo\fP .sp -This connection string is used by Barman to connect to the PostgreSQL server for -receiving WAL segments via streaming replication and for checking the replication slot -status. If not specified, Barman defaults to using \fBstreaming_conninfo\fP for these -tasks. \fBwal_streaming_conninfo\fP must connect to a Postgres instance within the -same cluster as defined by \fBstreaming_conninfo\fP and \fBconninfo\fP, and it must support -streaming replication. It, or the optional \fBwal_conninfo\fP, must also have the -required permissions to read settings and check the replication slot status, such as -the \fBpg_monitor\fP role, both \fBpg_read_all_settings\fP and \fBpg_read_all_stats\fP -roles, or \fBsuperuser\fP privileges. +This connection string is used by Barman to connect to the Postgres server for receiving +WAL segments via streaming replication and checking the replication slot status, if +\fBwal_conninfo\fP is not set. If not specified, Barman defaults to using +\fBstreaming_conninfo\fP for these tasks. \fBwal_streaming_conninfo\fP must connect to a +Postgres instance within the same cluster as defined by \fBstreaming_conninfo\fP, and it +must support streaming replication. If both \fBwal_streaming_conninfo\fP and +\fBwal_conninfo\fP are set, only \fBwal_conninfo\fP needs the required permissions to read +settings and check the replication slot status. If only \fBwal_streaming_conninfo\fP is +specified, it must have these permissions. The necessary permissions include roles such +as \fBpg_monitor\fP, both \fBpg_read_all_settings\fP and \fBpg_read_all_stats\fP, or superuser +privileges. .sp Scope: Server / Model. .sp @@ -1248,11 +1255,9 @@ policies. .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX retention_policy = {REDUNDANCY value | RECOVERY WINDOW OF value {DAYS | WEEKS | MONTHS}} -.ft P -.fi +.EE .UNINDENT .UNINDENT .INDENT 0.0