[pbs-devel] [PATCH pbs-docs 2/2] Add section "Garbage Collection"

Dylan Whyte d.whyte at proxmox.com
Mon Aug 24 12:14:50 CEST 2020


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 at proxmox.com>
---
 docs/administration-guide.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index cd7577bd..78298e51 100644
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -605,6 +605,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
 -------------------
-- 
2.20.1






More information about the pbs-devel mailing list