delete.rst.inc 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_delete:
  3. borg delete
  4. -----------
  5. .. code-block:: none
  6. borg [common options] delete [options] TARGET
  7. positional arguments
  8. TARGET
  9. archive or repository to delete
  10. optional arguments
  11. ``-s``, ``--stats``
  12. | print statistics for the deleted archive
  13. ``-c``, ``--cache-only``
  14. | delete only the local cache for the given repository
  15. ``--force``
  16. | force deletion of corrupted archives, use --force --force in case --force does not work.
  17. ``--save-space``
  18. | work slower, but using less space
  19. :ref:`common_options`
  20. |
  21. filters
  22. ``-P``, ``--prefix``
  23. | only consider archive names starting with this prefix.
  24. ``-a``, ``--glob-archives``
  25. | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
  26. ``--sort-by``
  27. | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
  28. ``--first N``
  29. | consider first N archives after other filters were applied
  30. ``--last N``
  31. | consider last N archives after other filters were applied
  32. Description
  33. ~~~~~~~~~~~
  34. This command deletes an archive from the repository or the complete repository.
  35. Disk space is reclaimed accordingly. If you delete the complete repository, the
  36. local cache for it (if any) is also deleted.