mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-28 10:49:16 +00:00
Code Issues Releases Wiki Activity
borg/docs/usage/delete.rst.inc

120 lines
14 KiB
PHP
Raw Normal View History

update usage files
2016-07-05 21:30:08 +00: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 15:42:16 +00:00
.. _borg_delete:
borg delete
-----------
docs: usage: avoid bash highlight, [options] instead of <options>
2017-06-06 22:44:53 +00: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 15:42:16 +00:00
build_usage
2019-09-06 22:27:17 +00: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-09 23:28:18 +00:00
ran build_usage
2017-06-20 13:22:24 +00:00
.. only:: html
ran build_usage
2017-06-20 09:49:26 +00:00
ran build_usage
2017-06-20 13:22:24 +00: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-09 23:28:18 +00:00
python setup.py build_usage
2017-07-23 15:12:01 +00:00
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
build_usage
2019-09-06 22:27:17 +00:00
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to delete |
python setup.py build_usage
2017-07-23 15:12:01 +00:00
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
build_usage (master) also: add new borgfs.rst.inc
2017-11-25 13:35:52 +00:00
| | ``ARCHIVE`` | archives to delete |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
python setup.py build_usage
2017-07-23 15:12:01 +00:00
| **optional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
update man pages / usage docs
2018-07-12 20:00:19 +00:00
| | ``-n``, ``--dry-run`` | do not change repository |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
build_usage
2021-02-06 00:32:02 +00:00
| | ``--list`` | output verbose list of archives |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
python setup.py build_usage
2017-07-23 15:12:01 +00:00
| | ``-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. |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
build_usage
2020-04-12 17:51:49 +00:00
| | ``--keep-security-info`` | keep the local security info when deleting a repository |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
python setup.py build_usage
2017-07-23 15:12:01 +00:00
| | ``--save-space`` | work slower, but using less space |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| .. 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. |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``-a GLOB``, ``--glob-archives GLOB`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--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 |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
ran build_usage
2017-06-20 09:49:26 +00:00
ran build_usage
2017-06-20 13:22:24 +00: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-09 23:28:18 +00:00
ran build_usage
2017-06-20 13:22:24 +00:00
<script type='text/javascript'>
docs: use DOM ready event, not document loaded event
2017-06-20 13:48:30 +00:00
$(document).ready(function () {
ran build_usage
2017-06-20 13:22:24 +00:00
$('.borg-options-table colgroup').remove();
})
</script>
docs: less space waste following "Common options"
2017-06-20 09:53:36 +00:00
ran build_usage
2017-06-20 13:22:24 +00:00
.. only:: latex
docs: less space waste following "Common options"
2017-06-20 09:53:36 +00:00
build_usage
2019-09-06 22:27:17 +00:00
REPOSITORY_OR_ARCHIVE
repository or archive to delete
build_usage (master) also: add new borgfs.rst.inc
2017-11-25 13:35:52 +00: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-09 23:28:18 +00:00
ran build_usage
2017-06-20 13:22:24 +00:00
optional arguments
update man pages / usage docs
2018-07-12 20:00:19 +00:00
-n, --dry-run do not change repository
build_usage
2021-02-06 00:32:02 +00:00
--list output verbose list of archives
ran build_usage
2017-06-20 13:22:24 +00:00
-s, --stats print statistics for the deleted archive
python setup.py build_usage
2017-07-23 15:12:01 +00:00
--cache-only delete only the local cache for the given repository
ran build_usage
2017-06-20 13:22:24 +00:00
--force force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work.
build_usage
2020-04-12 17:51:49 +00:00
--keep-security-info keep the local security info when deleting a repository
ran build_usage
2017-06-20 13:22:24 +00:00
--save-space work slower, but using less space
:ref:`common_options`
|
python setup.py build_usage
2017-07-23 15:12:01 +00:00
Archive filters
-P PREFIX, --prefix PREFIX only consider archive names starting with this prefix.
-a GLOB, --glob-archives GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
--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
ran build_usage
2017-06-20 09:49:26 +00:00
ran build_usage
2016-10-01 16:23:36 +00: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 15:42:16 +00:00
Description
~~~~~~~~~~~
This command deletes an archive from the repository or the complete repository.
update man pages / usage docs
2018-07-12 20:00:19 +00:00
Important: When deleting archives, repository disk space is **not** freed until
you run ``borg compact``.
build_usage
2020-04-12 17:51:49 +00: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 13:35:52 +00:00
build_usage
2021-02-06 00:32:02 +00: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 13:35:52 +00: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 20:00:19 +00:00
Please note that the "All archives" stats refer to the state after deletion.
You can delete multiple archives by specifying their common prefix, if they
have one, using the ``--prefix PREFIX`` option. You can also specify a shell
pattern to match multiple archives using the ``--glob-archives GLOB`` option
build_usage
2022-02-19 17:47:47 +00:00
(for more info on these patterns, see :ref:`borg_patterns`). Note that these
update man pages / usage docs
2018-07-12 20:00:19 +00:00
two options are mutually exclusive.
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