2016-07-05 23:33:53 +00:00
|
|
|
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
|
|
2016-04-27 23:28:43 +00:00
|
|
|
.. _borg_with-lock:
|
|
|
|
|
|
|
|
|
|
borg with-lock
|
|
|
|
|
--------------
|
2017-06-06 22:44:53 +00:00
|
|
|
.. code-block:: none
|
2016-04-27 23:28:43 +00:00
|
|
|
|
2017-07-23 15:12:01 +00:00
|
|
|
borg [common options] with-lock [options] REPOSITORY COMMAND [ARGS...]
|
2016-04-27 23:28:43 +00:00
|
|
|
|
2017-06-20 13:22:24 +00:00
|
|
|
.. only:: html
|
2017-06-20 09:49:26 +00:00
|
|
|
|
2017-06-20 13:22:24 +00:00
|
|
|
.. class:: borg-options-table
|
2016-04-27 23:28:43 +00:00
|
|
|
|
2017-06-20 13:22:24 +00:00
|
|
|
+-------------------------------------------------------+----------------+--------------------+
|
|
|
|
|
| **positional arguments** |
|
|
|
|
|
+-------------------------------------------------------+----------------+--------------------+
|
|
|
|
|
| | ``REPOSITORY`` | repository to lock |
|
|
|
|
|
+-------------------------------------------------------+----------------+--------------------+
|
|
|
|
|
| | ``COMMAND`` | command to run |
|
|
|
|
|
+-------------------------------------------------------+----------------+--------------------+
|
|
|
|
|
| | ``ARGS`` | command arguments |
|
|
|
|
|
+-------------------------------------------------------+----------------+--------------------+
|
|
|
|
|
| .. class:: borg-common-opt-ref |
|
|
|
|
|
| |
|
|
|
|
|
| :ref:`common_options` |
|
|
|
|
|
+-------------------------------------------------------+----------------+--------------------+
|
2017-06-20 09:53:36 +00:00
|
|
|
|
2017-06-20 13:22:24 +00:00
|
|
|
.. raw:: html
|
2017-06-20 09:53:36 +00:00
|
|
|
|
2017-06-20 13:22:24 +00:00
|
|
|
<script type='text/javascript'>
|
2017-06-20 13:48:30 +00:00
|
|
|
$(document).ready(function () {
|
2017-06-20 13:22:24 +00:00
|
|
|
$('.borg-options-table colgroup').remove();
|
|
|
|
|
})
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
.. only:: latex
|
|
|
|
|
|
|
|
|
|
REPOSITORY
|
|
|
|
|
repository to lock
|
|
|
|
|
COMMAND
|
|
|
|
|
command to run
|
|
|
|
|
ARGS
|
|
|
|
|
command arguments
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
:ref:`common_options`
|
|
|
|
|
|
|
2016-04-27 23:28:43 +00:00
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
This command runs a user-specified command while the repository lock is held.
|
|
|
|
|
|
|
|
|
|
It will first try to acquire the lock (make sure that no other operation is
|
|
|
|
|
running in the repo), then execute the given command as a subprocess and wait
|
|
|
|
|
for its termination, release the lock and return the user command's return
|
|
|
|
|
code as borg's return code.
|
|
|
|
|
|
2019-02-24 19:39:42 +00:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
If you copy a repository with the lock held, the lock will be present in
|
|
|
|
|
the copy. Thus, before using borg on the copy from a different host,
|
|
|
|
|
you need to use "borg break-lock" on the copied repository, because
|
|
|
|
|
Borg is cautious and does not automatically remove stale locks made by a different host.
|
