repo-delete.rst.inc 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_repo-delete:
  3. borg repo-delete
  4. ----------------
  5. .. code-block:: none
  6. borg [common options] repo-delete [options]
  7. .. only:: html
  8. .. class:: borg-options-table
  9. +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
  10. | **options** |
  11. +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
  12. | | ``-n``, ``--dry-run`` | do not change repository |
  13. +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
  14. | | ``--list`` | output verbose list of archives |
  15. +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
  16. | | ``--force`` | force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work. |
  17. +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
  18. | | ``--cache-only`` | delete only the local cache for the given repository |
  19. +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
  20. | | ``--keep-security-info`` | keep the local security info when deleting a repository |
  21. +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
  22. | .. class:: borg-common-opt-ref |
  23. | |
  24. | :ref:`common_options` |
  25. +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
  26. .. raw:: html
  27. <script type='text/javascript'>
  28. $(document).ready(function () {
  29. $('.borg-options-table colgroup').remove();
  30. })
  31. </script>
  32. .. only:: latex
  33. options
  34. -n, --dry-run do not change repository
  35. --list output verbose list of archives
  36. --force force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work.
  37. --cache-only delete only the local cache for the given repository
  38. --keep-security-info keep the local security info when deleting a repository
  39. :ref:`common_options`
  40. |
  41. Description
  42. ~~~~~~~~~~~
  43. This command deletes the complete repository.
  44. When you delete a complete repository, the security info and local cache for it
  45. (if any) are also deleted. Alternatively, you can delete just the local cache
  46. with the ``--cache-only`` option, or keep the security info with the
  47. ``--keep-security-info`` option.
  48. Always first use ``--dry-run --list`` to see what would be deleted.