borg/docs/usage/delete.rst.inc

.. _borg_delete:

borg delete
-----------
::

    borg delete <options> TARGET

positional arguments
    TARGET
        archive or repository to delete

optional arguments
    ``-p``, ``--progress``
        | show progress display while deleting a single archive
    ``-s``, ``--stats``
        | print statistics for the deleted archive
    ``-c``, ``--cache-only``
        | delete only the local cache for the given repository
    ``--save-space``
        | work slower, but using less space

`Common options`_
    |

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.
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`
			`-----------`
			`::`

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			`borg delete <options> TARGET`

			`positional arguments`
			`TARGET`
			`archive or repository to delete`

			`optional arguments`
			``-p``, ``--progress``
			`\| show progress display while deleting a single archive`
			``-s``, ``--stats``
			`\| print statistics for the deleted archive`
			``-c``, ``--cache-only``
			`\| delete only the local cache for the given repository`
			``--save-space``
			`\| work slower, but using less space`

			`Common options`_
			`\|`

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`
			`local cache for it (if any) is also deleted.`