Man documentation

Signed-off-by: Giulio Calacoci <giulio.calacoci@enterprisedb.com>
EnterpriseDB · Jul 14, 2023 · c54d474 · c54d474
1 parent adc972a
commit c54d474
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/doc/barman.1.d/50-backup.md b/doc/barman.1.d/50-backup.md
@@ -74,3 +74,16 @@ backup *SERVER_NAME*
     --wait-timeout
     :   the time, in seconds, spent waiting for the required WAL
         files to be archived before timing out
+
+    --manifest
+    :   forces the creation of a backup manifest file at the end of a backup. 
+        Overrides value of the parameter `autogenerate_manifest`, 
+        from the configuration file. 
+        Works with rsync backup method and strategies only
+
+    --no-manifest
+    :   disables the automatic creation of a backup manifest file 
+        at the end of a backup. 
+        Overrides value of the parameter `autogenerate_manifest`, 
+        from the configuration file. 
+        Works with rsync backup method and strategies only
diff --git a/doc/barman.5.d/50-autogenerate_manifest.md b/doc/barman.5.d/50-autogenerate_manifest.md
@@ -0,0 +1,7 @@
+autogenerate_manifest
+:   This option enables the auto-generation of backup manifest files
+    for rsync based backups and strategies.
+    The manifest file is a JSON file containing the list of files contained in the backup.
+    It is generated at the end of the backup process and stored in the backup directory.
+    The manifest file generated follows the format described in the postgesql documentation, and is compatible with the `pg_verifybackup` tool.
+    The option is ignored if the backup method is not rsync.