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

43 lines
1.3 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
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
positional arguments
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
Merge branch '1.0-maint'
2016-07-05 23:33:53 +00:00
``--force``
ran setup.py build_usage
2017-03-26 23:45:45 +00:00
| force deletion of corrupted archives, use --force --force in case --force does not work.
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
``--save-space``
| work slower, but using less space
docs: split usage
2017-06-06 22:06:36 +00:00
:ref:`common_options`
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
``-P``, ``--prefix``
| only consider archive names starting with this prefix
``--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
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.
Reference in a new issue Copy permalink