borg/docs/usage/rename.rst.inc

.. _borg_rename:

borg rename
-----------
::

    borg rename <options> ARCHIVE NEWNAME

positional arguments
    ARCHIVE
        archive to rename
    NEWNAME
        the new archive name to use

`Common options`_
    |

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

This command renames an archive in the repository.

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

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			`borg rename <options> ARCHIVE NEWNAME`

			`positional arguments`
			`ARCHIVE`
			`archive to rename`
			`NEWNAME`
			`the new archive name to use`

			`Common options`_
			`\|`

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