borg/docs/usage/rename.rst.inc

.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!

.. _borg_rename:

borg rename
-----------
.. code-block:: none

    borg [common options] rename [options] OLDNAME NEWNAME

.. only:: html

    .. class:: borg-options-table

    +-------------------------------------------------------+-------------+------------------------------+
    | **positional arguments**                                                                           |
    +-------------------------------------------------------+-------------+------------------------------+
    |                                                       | ``OLDNAME`` | specify the archive name     |
    +-------------------------------------------------------+-------------+------------------------------+
    |                                                       | ``NEWNAME`` | specify the new archive name |
    +-------------------------------------------------------+-------------+------------------------------+
    | .. class:: borg-common-opt-ref                                                                     |
    |                                                                                                    |
    | :ref:`common_options`                                                                              |
    +-------------------------------------------------------+-------------+------------------------------+

    .. raw:: html

        <script type='text/javascript'>
        $(document).ready(function () {
            $('.borg-options-table colgroup').remove();
        })
        </script>

.. only:: latex

    OLDNAME
        specify the archive name
    NEWNAME
        specify the new archive name


    :ref:`common_options`
        |

Description
~~~~~~~~~~~

This command renames an archive in the repository.

This results in a different archive ID.
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_rename:`

			`borg rename`
			`-----------`
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
build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			`borg [common options] rename [options] OLDNAME NEWNAME`
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 2017-06-20 13:22:24 +00:00			`.. only:: html`

			`.. class:: borg-options-table`

build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			`+-------------------------------------------------------+-------------+------------------------------+`
			`\| positional arguments \|`
			`+-------------------------------------------------------+-------------+------------------------------+`
			\| \| ``OLDNAME`` \| specify the archive name \|
			`+-------------------------------------------------------+-------------+------------------------------+`
			\| \| ``NEWNAME`` \| specify the new archive name \|
			`+-------------------------------------------------------+-------------+------------------------------+`
			`\| .. class:: borg-common-opt-ref \|`
			`\| \|`
			\| :ref:`common_options` \|
			`+-------------------------------------------------------+-------------+------------------------------+`
ran build_usage 2017-06-20 13:22:24 +00:00
			`.. raw:: html`

			`<script type='text/javascript'>`
docs: use DOM ready event, not document loaded event 2017-06-20 13:48:30 +00:00			`$(document).ready(function () {`
ran build_usage 2017-06-20 13:22:24 +00:00			`$('.borg-options-table colgroup').remove();`
			`})`
			`</script>`

			`.. only:: latex`

build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			`OLDNAME`
			`specify the archive name`
ran build_usage 2017-06-20 13:22:24 +00:00			`NEWNAME`
build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			`specify the new archive name`
ran build_usage 2017-06-20 13:22:24 +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
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 renames an archive in the repository.`
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 setup.py build_usage 2017-03-26 23:45:45 +00:00			`This results in a different archive ID.`