delete.rst.inc 1.9 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. ::
  6. usage: borg delete [-h] [--critical] [--error] [--warning] [--info] [--debug]
  7. [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
  8. [--remote-path PATH] [-p] [-s] [-c] [--force]
  9. [--save-space]
  10. [TARGET]
  11. Delete an existing repository or archive
  12. positional arguments:
  13. TARGET archive or repository to delete
  14. optional arguments:
  15. -h, --help show this help message and exit
  16. --critical work on log level CRITICAL
  17. --error work on log level ERROR
  18. --warning work on log level WARNING (default)
  19. --info, -v, --verbose
  20. work on log level INFO
  21. --debug work on log level DEBUG
  22. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  23. --show-rc show/log the return code (rc)
  24. --no-files-cache do not load/update the file metadata cache used to
  25. detect unchanged files
  26. --umask M set umask to M (local and remote, default: 0077)
  27. --remote-path PATH set remote path to executable (default: "borg")
  28. -p, --progress show progress display while deleting a single archive
  29. -s, --stats print statistics for the deleted archive
  30. -c, --cache-only delete only the local cache for the given repository
  31. --force force deletion of corrupted archives
  32. --save-space work slower, but using less space
  33. Description
  34. ~~~~~~~~~~~
  35. This command deletes an archive from the repository or the complete repository.
  36. Disk space is reclaimed accordingly. If you delete the complete repository, the
  37. local cache for it (if any) is also deleted.