From: Dylan Whyte <d.whyte@proxmox.com>
Date: Mon, 24 Aug 2020 10:14:50 +0000 (+0200)
Subject: Add section "Garbage Collection"
X-Git-Tag: v0.8.13~15
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=fd3f690104fb4a1c049a0ee1f704ea8f68880f38;p=proxmox-backup.git

Add section "Garbage Collection"

Add the section "Garbage Collection" to section "Backup Server
Management". This briefly explains the "garbage-collection"
subcommand of "proxmox-backup-manager"

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---

diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index b8048974..e6357a3e 100644
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -595,6 +595,14 @@ provide it with a :term:`schedule` to run regularly. The
   └────────────┴───────┴────────┴──────────────┴───────────┴─────────┘
   # proxmox-backup-manager sync-job remove pbs2-local
 
+Garbage Collection
+~~~~~~~~~~~~~~~~~~
+You can monitor and run :ref:`garbage collection <garbage-collection>` on the
+Proxmox Backup Server using the ``garbage-collection`` subcommand of
+``proxmox-backup-manager``. You can use the ``start`` subcommand to manually start garbage
+collection on an entire data store and the ``status`` subcommand to see
+attributes relating to the :ref:`garbage collection <garbage-collection>`.
+
 
 Backup Client usage
 -------------------