borg/docs/usage/rename.rst.inc

.. _borg_rename:

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

    usage: borg rename [-h] [-v] [--debug] [--lock-wait N] [--show-version]
                       [--show-rc] [--no-files-cache] [--umask M]
                       [--remote-path PATH]
                       ARCHIVE NEWNAME
    
    Rename an existing archive
    
    positional arguments:
      ARCHIVE               archive to rename
      NEWNAME               the new archive name to use
    
    optional arguments:
      -h, --help            show this help message and exit
      -v, --verbose, --info
                            enable informative (verbose) output, work on log level
                            INFO
      --debug               enable debug output, work on log level DEBUG
      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
      --show-version        show/log the borg version
      --show-rc             show/log the return code (rc)
      --no-files-cache      do not load/update the file metadata cache used to
                            detect unchanged files
      --umask M             set umask to M (local and remote, default: 0077)
      --remote-path PATH    set remote path to executable (default: "borg")
    
Description
~~~~~~~~~~~

This command renames an archive in the repository.
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`
			`-----------`
			`::`

add changes from running build_api and build_usage 2016-03-17 02:30:31 +00:00			`usage: borg rename [-h] [-v] [--debug] [--lock-wait N] [--show-version]`
			`[--show-rc] [--no-files-cache] [--umask M]`
			`[--remote-path PATH]`
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			`ARCHIVE NEWNAME`

			`Rename an existing archive`

			`positional arguments:`
ran build_usage 2015-12-08 09:21:20 +00:00			`ARCHIVE archive to rename`
			`NEWNAME the new archive name to use`
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
			`optional arguments:`
ran build_usage 2015-12-08 09:21:20 +00:00			`-h, --help show this help message and exit`
			`-v, --verbose, --info`
			`enable informative (verbose) output, work on log level`
			`INFO`
			`--debug enable debug output, work on log level DEBUG`
			`--lock-wait N wait for the lock, but max. N seconds (default: 1).`
add changes from running build_api and build_usage 2016-03-17 02:30:31 +00:00			`--show-version show/log the borg version`
ran build_usage 2015-12-08 09:21:20 +00:00			`--show-rc show/log the return code (rc)`
			`--no-files-cache do not load/update the file metadata cache used to`
			`detect unchanged files`
			`--umask M set umask to M (local and remote, default: 0077)`
			`--remote-path PATH set remote path to executable (default: "borg")`
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.`