borg-with-lock(1)

borg-with-lock1

Run a user specified command with the repository lock held

Usage

borg [common options] with-lock [options] REPOSITORY COMMAND [ARGS ...]

Overview

This command runs a user-specified command while locking the repository. For example:

$ borg with-lock /mnt/borgrepo rsync -av /mnt/borgrepo /somewhere/else/borgrepo

It will first try to acquire the lock (make sure that no other operation is running in the repository), 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.

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.

Options

See borg-common(1) for common options of Borg commands.

arguments

REPOSITORY

repository to lock

COMMAND

command to run

ARGS

command arguments

Releases

5 releases since Debian 10 (Buster); the text changed 4 times.

  1. 10
  2. 11
  3. 12
  4. 13
  5. Arch

Author

The Borg Collective

From borg 1.4.5-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.