rename.rst.inc 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_rename:
  3. borg rename
  4. -----------
  5. .. code-block:: none
  6. borg [common options] rename [options] ARCHIVE NEWNAME
  7. .. only:: html
  8. .. class:: borg-options-table
  9. +-------------------------------------------------------+-------------+-----------------------------+
  10. | **positional arguments** |
  11. +-------------------------------------------------------+-------------+-----------------------------+
  12. | | ``ARCHIVE`` | archive to rename |
  13. +-------------------------------------------------------+-------------+-----------------------------+
  14. | | ``NEWNAME`` | the new archive name to use |
  15. +-------------------------------------------------------+-------------+-----------------------------+
  16. | **optional arguments** |
  17. +-------------------------------------------------------+-------------+-----------------------------+
  18. | .. class:: borg-common-opt-ref |
  19. | |
  20. | :ref:`common_options` |
  21. +-------------------------------------------------------+-------------+-----------------------------+
  22. .. raw:: html
  23. <script type='text/javascript'>
  24. $(window).load(function () {
  25. $('.borg-options-table colgroup').remove();
  26. })
  27. </script>
  28. .. only:: latex
  29. ARCHIVE
  30. archive to rename
  31. NEWNAME
  32. the new archive name to use
  33. :ref:`common_options`
  34. |
  35. Description
  36. ~~~~~~~~~~~
  37. This command renames an archive in the repository.
  38. This results in a different archive ID.