borg/docs/usage/break-lock.rst.inc

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

.. _borg_break-lock:

borg break-lock
---------------
.. code-block:: none

    borg [common options] break-lock [options] [REPOSITORY]

.. only:: html

    .. class:: borg-options-table

    +-------------------------------------------------------+----------------+-----------------------------------------+
    | **positional arguments**                                                                                         |
    +-------------------------------------------------------+----------------+-----------------------------------------+
    |                                                       | ``REPOSITORY`` | repository for which to break the locks |
    +-------------------------------------------------------+----------------+-----------------------------------------+
    | .. 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
        repository for which to break the locks


    :ref:`common_options`
        |

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

This command breaks the repository and cache locks.
Please use carefully and only while no borg process (on any machine) is
trying to access the Cache or the 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!`

ran build_usage 2015-12-08 09:21:20 +00:00			`.. _borg_break-lock:`

			`borg break-lock`
			`---------------`
docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-06 22:44:53 +00:00			`.. code-block:: none`
ran build_usage 2015-12-08 09:21:20 +00:00
python setup.py build_usage 2017-07-23 15:12:01 +00:00			`borg [common options] break-lock [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`` \| repository for which to break the locks \|
			`+-------------------------------------------------------+----------------+-----------------------------------------+`
			`\| .. class:: borg-common-opt-ref \|`
			`\| \|`
			\| :ref:`common_options` \|
			`+-------------------------------------------------------+----------------+-----------------------------------------+`
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			`.. 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>`

			`.. only:: latex`

			`REPOSITORY`
			`repository for which to break the locks`


			: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 2015-12-08 09:21:20 +00:00			`Description`
			`~~~~~~~~~~~`

			`This command breaks the repository and cache locks.`
			`Please use carefully and only while no borg process (on any machine) is`
ran setup.py build_usage 2017-03-26 23:45:45 +00:00			`trying to access the Cache or the Repository.`