mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-03-09 13:53:09 +00:00
Code Issues Releases Wiki Activity
borg/docs/usage/delete.rst.inc

121 lines
14 KiB
PHP
Raw Normal View History

update usage files
2016-07-05 23:30:08 +02:00
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 10:42:16 -05:00
.. _borg_delete:
borg delete
-----------
docs: usage: avoid bash highlight, [options] instead of <options>
2017-06-07 00:44:53 +02:00
.. code-block:: none
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 10:42:16 -05:00
build_usage
2019-09-07 00:27:17 +02:00
borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-10 01:28:18 +02:00
ran build_usage
2017-06-20 15:22:24 +02:00
.. only:: html
ran build_usage
2017-06-20 11:49:26 +02:00
ran build_usage
2017-06-20 15:22:24 +02:00
.. class:: borg-options-table
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-10 01:28:18 +02:00
build_usage
2023-12-02 01:01:46 +01:00
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to delete |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``ARCHIVE`` | archives to delete |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
build_usage ; build_man
2024-03-30 20:00:34 +01:00
| **optional arguments** |
build_usage
2023-12-02 01:01:46 +01:00
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``-n``, ``--dry-run`` | do not change repository |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``--list`` | output verbose list of archives |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``-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. |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``--keep-security-info`` | keep the local security info when deleting a repository |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``--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. |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``-P PREFIX``, ``--prefix PREFIX`` | only consider archive names starting with this prefix. (deprecated) |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``-a GLOB``, ``--glob-archives GLOB`` | only consider archive names matching the glob. sh: rules apply (without actually using the sh: prefix), see "borg help patterns". |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, 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 |
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
ran build_usage
2017-06-20 11:49:26 +02:00
ran build_usage
2017-06-20 15:22:24 +02:00
.. raw:: html
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-10 01:28:18 +02:00
ran build_usage
2017-06-20 15:22:24 +02:00
<script type='text/javascript'>
docs: use DOM ready event, not document loaded event
2017-06-20 15:48:30 +02:00
$(document).ready(function () {
ran build_usage
2017-06-20 15:22:24 +02:00
$('.borg-options-table colgroup').remove();
})
</script>
docs: less space waste following "Common options"
2017-06-20 11:53:36 +02:00
ran build_usage
2017-06-20 15:22:24 +02:00
.. only:: latex
docs: less space waste following "Common options"
2017-06-20 11:53:36 +02:00
build_usage
2019-09-07 00:27:17 +02:00
REPOSITORY_OR_ARCHIVE
repository or archive to delete
build_usage (master) also: add new borgfs.rst.inc
2017-11-25 14:35:52 +01:00
ARCHIVE
archives to delete
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-10 01:28:18 +02:00
ran build_usage
2017-06-20 15:22:24 +02:00
build_usage ; build_man
2024-03-30 20:00:34 +01:00
optional arguments
update man pages / usage docs
2018-07-12 22:00:19 +02:00
-n, --dry-run do not change repository
build_usage
2021-02-06 01:32:02 +01:00
--list output verbose list of archives
ran build_usage
2017-06-20 15:22:24 +02:00
-s, --stats print statistics for the deleted archive
python setup.py build_usage
2017-07-23 17:12:01 +02:00
--cache-only delete only the local cache for the given repository
ran build_usage
2017-06-20 15:22:24 +02:00
--force force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work.
build_usage
2020-04-12 19:51:49 +02:00
--keep-security-info keep the local security info when deleting a repository
ran build_usage
2017-06-20 15:22:24 +02:00
--save-space work slower, but using less space
build_usage ; build_man
2022-08-20 15:12:20 +02:00
-c SECONDS, --checkpoint-interval SECONDS write checkpoint every SECONDS seconds (Default: 1800)
ran build_usage
2017-06-20 15:22:24 +02:00
:ref:`common_options`
|
python setup.py build_usage
2017-07-23 17:12:01 +02:00
Archive filters
build_usage
2022-12-24 15:34:56 +01:00
-P PREFIX, --prefix PREFIX only consider archive names starting with this prefix. (deprecated)
build_usage
2023-12-02 01:01:46 +01:00
-a GLOB, --glob-archives GLOB only consider archive names matching the glob. sh: rules apply (without actually using the sh: prefix), see "borg help patterns".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp
python setup.py build_usage
2017-07-23 17:12:01 +02:00
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
ran build_usage
2017-06-20 11:49:26 +02:00
ran build_usage
2016-10-01 18:23:36 +02:00
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 10:42:16 -05:00
Description
~~~~~~~~~~~
This command deletes an archive from the repository or the complete repository.
update man pages / usage docs
2018-07-12 22:00:19 +02:00
Important: When deleting archives, repository disk space is **not** freed until
you run ``borg compact``.
build_usage
2020-04-12 19:51:49 +02:00
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.
build_usage (master) also: add new borgfs.rst.inc
2017-11-25 14:35:52 +01:00
build_usage
2021-02-06 01:32:02 +01:00
When in doubt, use ``--dry-run --list`` to see what would be deleted.
build_usage (master) also: add new borgfs.rst.inc
2017-11-25 14:35:52 +01:00
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.
update man pages / usage docs
2018-07-12 22:00:19 +02:00
Please note that the "All archives" stats refer to the state after deletion.
build_usage
2022-12-24 15:34:56 +01:00
You can delete multiple archives by specifying a shell pattern to match
multiple archives using the ``--glob-archives GLOB`` option (for more info on
these patterns, see :ref:`borg_patterns`).
update man pages / usage docs
2018-07-12 22:00:19 +02:00
To avoid accidentally deleting archives, especially when using glob patterns,
it might be helpful to use the ``--dry-run`` to test out the command without
actually making any changes to the repository.
Reference in a new issue Copy permalink