borg/docs/usage/delete.rst.inc

.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!

.. _borg_delete:

borg delete
-----------
.. code-block:: none

    borg [common options] delete [options] TARGET

TARGET
    archive or repository to delete


optional arguments
    -s, --stats     print statistics for the deleted archive
    -c, --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


.. class:: borg-common-opt-ref

:ref:`common_options`


filters
    -P, --prefix            only consider archive names starting with this prefix.
    -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
    --sort-by               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


Description
~~~~~~~~~~~

This command deletes an archive from the repository or the complete repository.
Disk space is reclaimed accordingly. If you delete the complete repository, the
local cache for it (if any) is also deleted.
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
docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-06 22:44:53 +00:00			`borg [common options] delete [options] TARGET`
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 09:49:26 +00:00			`TARGET`
			`archive or repository 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
			`optional arguments`
ran build_usage 2017-06-20 09:49:26 +00:00			`-s, --stats print statistics for the deleted archive`
			`-c, --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`

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
docs: less space waste following "Common options" 2017-06-20 09:53:36 +00:00			`.. class:: borg-common-opt-ref`

docs: split usage 2017-06-06 22:06:36 +00:00			:ref:`common_options`
docs: less space waste following "Common options" 2017-06-20 09:53:36 +00:00
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 2016-10-01 16:23:36 +00:00			`filters`
ran build_usage 2017-06-20 09:49:26 +00:00			`-P, --prefix only consider archive names starting with this prefix.`
			-a, --glob-archives only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
			`--sort-by 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 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.`
			`Disk space is reclaimed accordingly. If you delete the complete repository, the`
ran setup.py build_usage 2017-03-26 23:45:45 +00:00			`local cache for it (if any) is also deleted.`