borgbackup/docs/usage/repo-delete.rst.inc
2025-12-23 18:00:09 +01:00

66 lines
No EOL
4.5 KiB
PHP

.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_repo-delete:
borg repo-delete
----------------
.. code-block:: none
borg [common options] repo-delete [options]
.. only:: html
.. class:: borg-options-table
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------------+
| **options** |
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------------+
| | ``-n``, ``--dry-run`` | do not change the repository |
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------------+
| | ``--list`` | output a verbose list of archives |
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------------+
| | ``--force`` | force deletion of corrupted archives; use ``--force --force`` if a single ``--force`` does not work. |
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------------+
| | ``--cache-only`` | delete only the local cache for the given repository |
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------------+
| | ``--keep-security-info`` | keep the local security info when deleting a repository |
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------------+
.. raw:: html
<script type='text/javascript'>
$(document).ready(function () {
$('.borg-options-table colgroup').remove();
})
</script>
.. only:: latex
options
-n, --dry-run do not change the repository
--list output a verbose list of archives
--force force deletion of corrupted archives; use ``--force --force`` if a single ``--force`` does not work.
--cache-only delete only the local cache for the given repository
--keep-security-info keep the local security info when deleting a repository
:ref:`common_options`
|
Description
~~~~~~~~~~~
This command deletes a complete repository.
When you delete a complete repository, the security info and local cache for it
(if any) are also deleted. Alternatively, you can delete just the local cache
with the ``--cache-only`` option, or keep the security info with the
``--keep-security-info`` option.
Always first use ``--dry-run --list`` to see what would be deleted.