borg/docs/usage/change-passphrase.rst.inc

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

.. _borg_change-passphrase:

borg change-passphrase
----------------------
.. code-block:: none

    borg [common options] change-passphrase [options] [REPOSITORY]

.. only:: html

    .. class:: borg-options-table

    +-------------------------------------------------------+----------------+--+
    | **positional arguments**                                                  |
    +-------------------------------------------------------+----------------+--+
    |                                                       | ``REPOSITORY`` |  |
    +-------------------------------------------------------+----------------+--+
    | .. 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

    REPOSITORY


    :ref:`common_options`
        |

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

The key files used for repository encryption are optionally passphrase
protected. This command can be used to change this passphrase.

Please note that this command only changes the passphrase, but not any
secret protected by it (like e.g. encryption/MAC keys or chunker seed).
Thus, changing the passphrase after passphrase and borg key got compromised
does not protect future (nor past) backups to the same repository.
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_change-passphrase:`

			`borg change-passphrase`
			`----------------------`
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
python setup.py build_usage 2017-07-23 15:12:01 +00:00			`borg [common options] change-passphrase [options] [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 build_usage 2017-06-20 13:22:24 +00:00			`.. only:: html`
ran build_usage 2017-06-20 09:49:26 +00:00
ran build_usage 2017-06-20 13:22:24 +00:00			`.. class:: borg-options-table`
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			`+-------------------------------------------------------+----------------+--+`
			`\| positional arguments \|`
			`+-------------------------------------------------------+----------------+--+`
			\| \| ``REPOSITORY`` \| \|
			`+-------------------------------------------------------+----------------+--+`
			`\| .. class:: borg-common-opt-ref \|`
			`\| \|`
			\| :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
ran build_usage 2017-06-20 13:22:24 +00:00			`.. raw:: html`
docs: less space waste following "Common options" 2017-06-20 09:53:36 +00:00
ran build_usage 2017-06-20 13:22:24 +00:00			`<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>`
docs: less space waste following "Common options" 2017-06-20 09:53:36 +00:00
ran build_usage 2017-06-20 13:22:24 +00:00			`.. only:: latex`

			`REPOSITORY`



			: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`
			`~~~~~~~~~~~`

			`The key files used for repository encryption are optionally passphrase`
build_usage 2017-10-01 00:24:54 +00:00			`protected. This command can be used to change this passphrase.`

			`Please note that this command only changes the passphrase, but not any`
			`secret protected by it (like e.g. encryption/MAC keys or chunker seed).`
			`Thus, changing the passphrase after passphrase and borg key got compromised`
			`does not protect future (nor past) backups to the same repository.`