From 6e5a0c03fabb9dc668106531a4a1b9167f9ffae8 Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Wed, 4 Dec 2019 13:46:57 +0100
Subject: [PATCH] docs/administration-guide.rst: add prune docs

---
 docs/administration-guide.rst | 43 +++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index bf75c129..5e82e7a5 100644
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -99,6 +99,13 @@ Backup Time
 The time when the backup was made.
 
 
+Backup Group
+~~~~~~~~~~~~
+
+We call the tuple ``<type>/<ID>`` a backup group. Such group
+may contains one or more backup snapshots.
+
+
 Backup Snapshot
 ~~~~~~~~~~~~~~~
 
@@ -395,6 +402,42 @@ To remove the ticket, simply issue a logout:
   # proxmox-backup-client logout
 
 
+Pruning and Removing Backups
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can manually delete a backup snapshot using the ``forget``
+command:
+
+.. code-block:: console
+
+  # proxmox-backup-client forget <snapshot>
+
+
+.. caution:: This command removes all the archives in this backup
+   snapshot so that they are inaccessible and unrecoverable.
+
+
+Such manual removal is sometimes necessary, but usually the prune
+command is used to systematically delete older backups.
+
+.. code-block:: console
+
+  # proxmox-backup-client prune <group> --keep-daily 7 --keep-weekly 4 --keep-monthly 3
+
+
+.. note:: Neither the prune command nor the remove command free space
+   in the chunk-store. The chunk-store still contains the data blocks
+   unless you are performing :ref:`garbage-collection`.
+
+
+.. _garbage-collection:
+
+Garbage Collection
+~~~~~~~~~~~~~~~~~~
+
+.. todo:: write garbage-collection section
+
+
 .. _pve-integration:
 
 `Proxmox VE`_ integration