[pbs-devel] [PATCH proxmox-backup] docs: client: mention missing catalog for split archives

Christian Ebner c.ebner at proxmox.com
Mon Jul 15 16:42:44 CEST 2024


Adds a note informing the users that the catalog is not encoded for
change detection modes set to `data` or `metadata`, and mention to
mount the snapshot archive as alternative for inspecting the content.

Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
 docs/backup-client.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index e56e0625b..ca054a762 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -339,6 +339,13 @@ mode:
 
     # proxmox-backup-client backup.pxar:./linux --change-detection-mode=metadata
 
+.. Note:: Backup snapshots create with ``change-detection-mode`` set to ``data``
+  or ``metadata`` do not encode a dedicated catalog, as the metadata archive
+  already contains the same information in a quickly accessible manner.
+  Therefore, the ``proxmox-backup-client catalog`` commands are not available
+  for these snapshots, ``proxmox-backup-client mount`` can be used instead to
+  mount and inspect these snapshots.
+
 .. _client_encryption:
 
 Encryption
-- 
2.39.2





More information about the pbs-devel mailing list