1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-25 09:19:31 +00:00
borg/docs/usage/delete.rst.inc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

101 lines
10 KiB
PHP
Raw Normal View History

2016-07-05 21:30:08 +00:00
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_delete:
borg delete
-----------
.. code-block:: none
2022-06-23 23:19:19 +00:00
borg [common options] delete [options]
2017-06-20 13:22:24 +00:00
.. only:: html
2017-06-20 09:49:26 +00:00
2017-06-20 13:22:24 +00:00
.. class:: borg-options-table
2022-08-03 20:19:12 +00:00
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| **optional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``-n``, ``--dry-run`` | do not change repository |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``--list`` | output verbose list of archives |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``--consider-checkpoints`` | consider checkpoint archives for deletion (default: not considered). |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``-s``, ``--stats`` | print statistics for the deleted archive |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``--cache-only`` | delete only the local cache for the given repository |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``--force`` | force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work. |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``--save-space`` | work slower, but using less space |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``-c SECONDS``, ``--checkpoint-interval SECONDS`` | write checkpoint every SECONDS seconds (Default: 1800) |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| **Archive filters** Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
2022-10-02 13:51:17 +00:00
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". |
2022-08-03 20:19:12 +00:00
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``--first N`` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``--last N`` | consider last N archives after other filters were applied |
+-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
2017-06-20 09:49:26 +00:00
2017-06-20 13:22:24 +00:00
.. raw:: html
2017-06-20 13:22:24 +00:00
<script type='text/javascript'>
$(document).ready(function () {
2017-06-20 13:22:24 +00:00
$('.borg-options-table colgroup').remove();
})
</script>
2017-06-20 13:22:24 +00:00
.. only:: latex
2017-06-20 13:22:24 +00:00
optional arguments
2018-07-12 20:00:19 +00:00
-n, --dry-run do not change repository
2021-02-06 00:32:02 +00:00
--list output verbose list of archives
2022-06-23 23:19:19 +00:00
--consider-checkpoints consider checkpoint archives for deletion (default: not considered).
2017-06-20 13:22:24 +00:00
-s, --stats print statistics for the deleted archive
2017-07-23 15:12:01 +00:00
--cache-only delete only the local cache for the given repository
2017-06-20 13:22:24 +00:00
--force force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work.
--save-space work slower, but using less space
2022-08-03 20:19:12 +00:00
-c SECONDS, --checkpoint-interval SECONDS write checkpoint every SECONDS seconds (Default: 1800)
2017-06-20 13:22:24 +00:00
:ref:`common_options`
|
2017-07-23 15:12:01 +00:00
Archive filters
2022-10-02 13:51:17 +00:00
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
2017-06-20 09:49:26 +00:00
2016-10-01 16:23:36 +00:00
Description
~~~~~~~~~~~
2022-06-23 23:19:19 +00:00
This command deletes archives from the repository.
2018-07-12 20:00:19 +00:00
Important: When deleting archives, repository disk space is **not** freed until
you run ``borg compact``.
2021-02-06 00:32:02 +00:00
When in doubt, use ``--dry-run --list`` to see what would be deleted.
When using ``--stats``, you will get some statistics about how much data was
deleted - the "Deleted data" deduplicated size there is most interesting as
that is how much your repository will shrink.
2018-07-12 20:00:19 +00:00
Please note that the "All archives" stats refer to the state after deletion.
2022-10-02 13:51:17 +00:00
You can delete multiple archives by specifying a matching pattern,
using the ``--match-archives PATTERN`` option (for more info on these patterns,
2022-07-03 23:21:50 +00:00
see :ref:`borg_patterns`).
2018-07-12 20:00:19 +00:00
2022-06-23 23:19:19 +00:00
Always first use ``--dry-run --list`` to see what would be deleted.