Update documentation

doc/barman-cloud-backup-delete.1

@@ -1,22 +1,22 @@
-.\" Automatically generated by Pandoc 2.17.0.1
+.\" Automatically generated by Pandoc 2.2.1
 .\"
-.TH "BARMAN-CLOUD-BACKUP-DELETE" "1" "January 21, 2022" "Barman User manuals" "Version 2.18"
+.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "January 21, 2022" "Barman User manuals" "Version 2.18"
 .hy
 .SH NAME
 .PP
-barman-cloud-backup-delete - Delete backups stored in the Cloud
+barman\-cloud\-backup\-delete \- Delete backups stored in the Cloud
 .SH SYNOPSIS
 .PP
-barman-cloud-backup-delete [\f[I]OPTIONS\f[R]] \f[I]SOURCE_URL\f[R]
-\f[I]SERVER_NAME\f[R]
+barman\-cloud\-backup\-delete [\f[I]OPTIONS\f[]] \f[I]SOURCE_URL\f[]
+\f[I]SERVER_NAME\f[]
 .SH DESCRIPTION
 .PP
 This script can be used to delete backups previously made with the
-\f[C]barman-cloud-backup\f[R] command.
+\f[C]barman\-cloud\-backup\f[] command.
 Currently AWS S3 and Azure Blob Storage are supported.
 .PP
 The target backups can be specified either using the backup ID (as
-returned by barman-cloud-backup-list) or by retention policy.
+returned by barman\-cloud\-backup\-list) or by retention policy.
 Retention policies are the same as those for Barman server and work as
 described in the Barman manual: all backups not required to meet the
 specified policy will be deleted.
@@ -25,10 +25,10 @@ When a backup is succesfully deleted any unused WALs associated with
 that backup are removed.
 WALs are only considered unused if:
 .IP "1." 3
-There are no older backups than the deleted backup \f[I]or\f[R] all
-older backups are archival backups.
+There are no older backups than the deleted backup \f[I]or\f[] all older
+backups are archival backups.
 .IP "2." 3
-The WALs pre-date the begin_wal value of the oldest remaining backup.
+The WALs pre\-date the begin_wal value of the oldest remaining backup.
 .IP "3." 3
 The WALs are not required by any archival backups present in cloud
 storage.
@@ -44,58 +44,86 @@ This script and Barman are administration tools for disaster recovery of
 PostgreSQL servers written in Python and maintained by EnterpriseDB.
 .SH POSITIONAL ARGUMENTS
 .TP
-SOURCE_URL
+.B SOURCE_URL
 URL of the cloud source, such as a bucket in AWS S3.
-For example: \f[C]s3://BUCKET_NAME/path/to/folder\f[R] (where
-\f[C]BUCKET_NAME\f[R] is the bucket you have created in AWS).
+For example: \f[C]s3://BUCKET_NAME/path/to/folder\f[] (where
+\f[C]BUCKET_NAME\f[] is the bucket you have created in AWS).
+.RS
+.RE
 .TP
-SERVER_NAME
+.B SERVER_NAME
 the name of the server as configured in Barman.
+.RS
+.RE
 .SH OPTIONS
 .TP
--h, \[en]help
+.B \-h, \[en]help
 show a help message and exit
+.RS
+.RE
 .TP
--V, \[en]version
-show program\[cq]s version number and exit
+.B \-V, \[en]version
+show program's version number and exit
+.RS
+.RE
 .TP
--v, \[en]verbose
-increase output verbosity (e.g., -vv is more than -v)
+.B \-v, \[en]verbose
+increase output verbosity (e.g., \-vv is more than \-v)
+.RS
+.RE
 .TP
--q, \[en]quiet
-decrease output verbosity (e.g., -qq is less than -q)
+.B \-q, \[en]quiet
+decrease output verbosity (e.g., \-qq is less than \-q)
+.RS
+.RE
 .TP
--t, \[en]test
+.B \-t, \[en]test
 test connectivity to the cloud destination and exit
+.RS
+.RE
 .TP
--b \f[I]BACKUP_ID\f[R], \[en]backup-id \f[I]BACKUP_ID\f[R]
+.B \-b \f[I]BACKUP_ID\f[], \[en]backup\-id \f[I]BACKUP_ID\f[]
 a valid Backup ID for a backup in cloud storage which is to be deleted
+.RS
+.RE
 .TP
--r \f[I]RETENTION_POLICY\f[R], \[en]retention-policy \f[I]RETENTION_POLICY\f[R]
-used instead of \[en]backup-id, a retention policy for selecting the
-backups to be deleted, e.g.\ \[lq]REDUNDANCY 3\[rq] or \[lq]RECOVERY
-WINDOW OF 2 WEEKS\[rq]
+.B \-r \f[I]RETENTION_POLICY\f[], \[en]retention\-policy \f[I]RETENTION_POLICY\f[]
+used instead of \[en]backup\-id, a retention policy for selecting the
+backups to be deleted, e.g.
+\[lq]REDUNDANCY 3\[rq] or \[lq]RECOVERY WINDOW OF 2 WEEKS\[rq]
+.RS
+.RE
 .TP
-\[en]dry-run
+.B \[en]dry\-run
 run without actually deleting any objects while printing information
 about the objects which would be deleted to stdout
+.RS
+.RE
 .TP
-\[en]cloud-provider {aws-s3,azure-blob-storage}
+.B \[en]cloud\-provider {aws\-s3,azure\-blob\-storage}
 the cloud provider to which the backup should be uploaded
+.RS
+.RE
 .TP
--P, \[en]profile
+.B \-P, \[en]profile
 profile name (e.g.\ INI section in AWS credentials file)
+.RS
+.RE
 .TP
-\[en]endpoint-url
+.B \[en]endpoint\-url
 override the default S3 URL construction mechanism by specifying an
 endpoint.
+.RS
+.RE
 .TP
-\[en]credential {azure-cli,managed-identity}
+.B \[en]credential {azure\-cli,managed\-identity}
 optionally specify the type of credential to use when authenticating
 with Azure Blob Storage.
 If omitted then the credential will be obtained from the environment.
 If no credentials can be found in the environment then the default Azure
 authentication flow will be used.
+.RS
+.RE
 .SH REFERENCES
 .PP
 For Boto:
@@ -104,42 +132,52 @@ https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
 .PP
 For AWS:
 .IP \[bu] 2
-http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html
+http://docs.aws.amazon.com/cli/latest/userguide/cli\-chap\-getting\-set\-up.html
 .IP \[bu] 2
-http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html.
+http://docs.aws.amazon.com/cli/latest/userguide/cli\-chap\-getting\-started.html.
 .PP
 For Azure Blob Storage:
 .IP \[bu] 2
-https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters
+https://docs.microsoft.com/en\-us/azure/storage/blobs/authorize\-data\-operations\-cli#set\-environment\-variables\-for\-authorization\-parameters
 .IP \[bu] 2
-https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python
+https://docs.microsoft.com/en\-us/python/api/azure\-storage\-blob/?view=azure\-python
 .SH DEPENDENCIES
 .PP
-If using \f[C]--cloud-provider=aws-s3\f[R]:
+If using \f[C]\-\-cloud\-provider=aws\-s3\f[]:
 .IP \[bu] 2
 boto3
 .PP
-If using \f[C]--cloud-provider=azure-blob-storage\f[R]:
+If using \f[C]\-\-cloud\-provider=azure\-blob\-storage\f[]:
 .IP \[bu] 2
-azure-storage-blob
+azure\-storage\-blob
 .IP \[bu] 2
-azure-identity (optional, if you wish to use DefaultAzureCredential)
+azure\-identity (optional, if you wish to use DefaultAzureCredential)
 .SH EXIT STATUS
 .TP
-0
+.B 0
 Success
+.RS
+.RE
 .TP
-1
+.B 1
 The delete operation was not successful
+.RS
+.RE
 .TP
-2
+.B 2
 The connection to the cloud provider failed
+.RS
+.RE
 .TP
-3
+.B 3
 There was an error in the command input
+.RS
+.RE
 .TP
-Other non-zero codes
+.B Other non\-zero codes
 Failure
+.RS
+.RE
 .SH BUGS
 .PP
 Barman has been extensively tested, and is currently being used in
@@ -159,6 +197,6 @@ Professional support: <http://www.enterprisedb.com/>
 Barman is the property of EnterpriseDB UK Limited and its code is
 distributed under GNU General Public License v3.
 .PP
-\[co] Copyright EnterpriseDB UK Limited 2011-2022
+© Copyright EnterpriseDB UK Limited 2011\-2022
 .SH AUTHORS
 EnterpriseDB <http://www.enterprisedb.com>.